IltmmDVDControl::IsSubpictureStreamEnabled
#include "ltmm.h"
C Syntax |
HRESULT IltmmDVDControl_IsSubpictureStreamEnabled(pDVD, Stream, pEnabled) |
C++ Syntax |
HRESULT IsSubpictureStreamEnabled(Stream, pEnabled) |
IltmmDVDControl *pDVD; |
/* pointer to an interface */ |
Long Stream; |
/* stream */ |
VARIANT_BOOL *pEnabled; |
/* pointer to a variable */ |
Determines if the specified subpicture stream is enabled in the current 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..
Parameter |
Description |
|
pDVD |
Pointer to an IltmmDVDControl interface. |
|
Stream |
The subpicture stream to check. |
|
pEnabled |
Pointer to a variable that receives a value that represents the status of the specified subpicture stream. Possible values are: |
|
|
Setting |
Description |
|
TRUE |
Stream is enabled |
|
FALSE |
Stream is disabled |
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
To determine the number of available subpicture streams, call IltmmDVDControl::get_SubpictureStreamsAvailable.
Call IltmmDVDControl::get_CurrentSubpictureStream to retrieve the current subpicture stream.
To set the current subpicture stream, call IltmmDVDControl::put_CurrentSubpictureStream.
The title currently being played determines which subpicture streams are enabled and disabled.
While setting a disabled subpicture stream as the current subpicture stream will not return an error, the program will not display subpicture data until it plays a title that enables the stream.
For more detailed information, refer to the Microsoft documentation for IDvdInfo2::IsSubpictureStreamEnabled at http://msdn.microsoft.com/archive/default.asp?url=/library/en-us/directshow/htm/idvdinfo2issubpicturestreamenabled.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++.