IltmmDVDControl::put_SubpictureOn
#include "ltmm.h"
C Syntax |
HRESULT IltmmDVDControl__put_SubpictureOn(pDVD, State) |
C++ Syntax |
HRESULT put_SubpictureOn(State) |
IltmmDVDControl *pDVD; |
/* pointer to an interface */ |
VARIANT_BOOL State; |
/* state */ |
Sets the subpicture display status.
Parameter |
Description |
|
pDVD |
Pointer to an IltmmDVDControl interface. |
|
State |
A Boolean value that specifies whether the subpicture display is enabled. Possible values are: |
|
|
Setting |
Description |
|
VARIANT_TRUE |
Enable subpicture display. |
|
VARIANT_FALSE |
Disable subpicture display. |
Returns
S_OK |
The function ran successfully. |
<> S_OK |
An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation. |
Comments
This function does not support command synchronization.
The title The name for a group of related video files (called "Chapters") on your DVD. For example, for a DVD called "My Summer Vacation," you might have the titles "Water Skiing," "New Friends," and "Hiking." For each of those titles, you might have one or more different video files. currently being played determines which subpicture streams are enabled and disabled. The title must enable a subpicture stream for it to be displayed. The programmer can retrieve the subpicture stream status by calling IltmmDVDControl::IsSubpictureStreamEnabled.
Call IltmmDVDControl::get_SubpictureOn to retrieve the current subpicture display status.
For more detailed information, refer to the Microsoft documentation for IDvdControl2::SetSubpictureState at http://msdn.microsoft.com/archive/default.asp?url=/library/en-us/directshow/htm/idvdcontrol2setsubpicturestate.asp.
Required DLLs and Libraries
LTMM For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application. |
See Also
Example
For a C example, refer to IltmmDVDControl::GetButtonAtPosition Example for C.
For a C++ example, refer to IltmmDVDControl::GetButtonAtPosition Example for C++.