IltmmPlay::get_CloseCaptioning

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay__get_CloseCaptioning(pPlay, pVal)

C++ Syntax

HRESULT get_CloseCaptioning(pVal)

 

IltmmPlay *pPlay;

/* pointer to an interface */

VARIANT_BOOL *pVal;

/* pointer to a variable */

Determines whether close captioning is enabled.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

pVal

Pointer to a variable to be updated with a value that determines whether the close captioning is enabled. Possible values are:

 

Value

Meaning

 

VARIANT_TRUE

Close captioning is enabled.

 

VARIANT_FALSE

Close captioning is disabled.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

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, Mobile

See Also

Elements:

IltmmPlay::put_CloseCaptioning, IltmmPlay::ToggleCloseCaptioning, IltmmConvert::GetClosedCaptioningTargetFile , IltmmConvert::SetClosedCaptioningTargetFile, IltmmCapture::get_CloseCaptioning, IltmmCapture::get_PreviewingCloseCaption, IltmmCapture::put_CloseCaptioning, IltmmCapture::ToggleCloseCaptioning, IltmmConvert::get_AllowedStreams, IltmmCapture::get_CloseCaptionAvailable

Topics:

Multimedia Function Groups

 

Closed Captioning

Example

For a C example, refer to the IltmmPlay::ToggleCloseCaptioning Example for C.

For a C++ example, refer to the IltmmPlay::ToggleCloseCaptioning Example for C++.