MSVidWebDVD.SubpictureOn Property
Note This topic applies to Windows XP Service Pack 1 or later.
The SubpictureOn property sets and retrieves current subpicture state (either on or off).
VidWebDVD.SubpictureOn As Boolean
Parameters
This property takes no parameters.
Return Value
Returns a Boolean value indicating whether the subpicture is displayed.
Error Codes
If the property fails, Err.Number may be set to one of the following values.
| Value | Description |
|---|---|
| E_UNEXPECTED | Unspecified error; possibly the graph has not been built. |
| VFW_E_DVD_INVALIDDOMAIN | You attempted to take the value in a domain that does not support this property. |
Valid Domains
The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.
| Annex J Command Name | Valid Domains |
|---|---|
| Sub-picture_stream_Change | DVD_DOMAIN_VideoManagerMenu
DVD_DOMAIN_VideoTitleSetMenu DVD_DOMAIN_Title DVD_DOMAIN_Stop |
Remarks
This property does not affect display of closed captions. Closed captions are embedded within the video stream. DVD subpictures are transported on a separate stream.
This property is read/write with a default value of False.
If the subpicture stream has been changed with CurrentSubpictureStream, this value will automatically toggle to True.
Examples
' Setting the property.
VidWebDVD.SubpictureOn = True
' Returning the property.
bSubOn = VidWebDVD.SubpictureOn
Requirements
Type Library |
MS Video Control 1.0 Type Library and Microsoft Tuner 1.0 Type Library |
DLL |
Quartz.dll |
See Also
Subpicture Streams: Controlling Subtitles
Send comments about this topic to Microsoft
Build date: 7/6/2010