IltmmDVDControl::IsSubpictureStreamEnabled

#include "ltmm.h"

C Syntax

HRESULT IltmmDVDControl_IsSubpictureStreamEnabled(pDVD, stream, pVal)

C++ Syntax

HRESULT IsSubpictureStreamEnabled(stream, pVal)

IltmmDVDControl *pDVD;

pointer to an interface

long stream;

stream

VARIANT_BOOL *pVal;

pointer to a variable

Determines if the specified subpicture stream is enabled in the current title .

Parameter Description
pDVD Pointer to an IltmmDVDControl interface.
stream The subpicture stream to check.
pVal 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.

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.

Platforms

Win32, x64

See Also

Elements:

IltmmDVDControl interface, IltmmDVDControl::get_CurrentSubpictureStream, IltmmDVDControl::put_CurrentSubpictureStream, IltmmDVDControl::get_SubpictureStreamsAvailable, IltmmDVDControl::get_DefaultSubpictureLanguage, IltmmDVDControl::get_DefaultSubpictureLanguageExt, IltmmDVDControl::GetSubpictureLanguage, IltmmDVDControl::SelectDefaultSubpictureLanguage, IltmmDVDControl::get_SubpictureOn, IltmmDVDControl::put_SubpictureOn

Topics:

Multimedia Function Group

Example

For a C example, refer to IltmmDVDControl::GetButtonAtPosition Example for C.

For a C++ example, refer to IltmmDVDControl::GetButtonAtPosition Example for C++.

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help