IltmmDVDControl::get_SubpictureOn

#include "ltmm.h"

C Syntax

HRESULT IltmmDVDControl_get_SubpictureOn(pDVD, State)

C++ Syntax

HRESULT get_SubpictureOn(State)

 

IltmmDVDControl *pDVD;

/* pointer to an interface */

VARIANT_BOOL *State;

/* state */

Retrieves the subpicture display status.

Parameter

Description

pDVD

Pointer to an IltmmDVDControl interface.

State

Pointer to a variable that receives the subpicture display status. Possible values are:

 

Setting

Description

 

VARIANT_TRUE

Subpicture display is enabled.

 

VARIANT_FALSE

Subpicture display 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

Call IltmmDVDControl::put_SubpictureOn to set the subpicture display status.

For more detailed information, refer to the Microsoft documentation for IDvdInfo2::GetCurrentSubpicture.

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::IsSubpictureStreamEnabled, IltmmDVDControl::SelectDefaultSubpictureLanguage, 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++.