IltmmPlay::put_CloseCaptioning

#include "ltmm.h"

C Syntax

HRESULT IltmmPlay_put_CloseCaptioning(pPlay, newVal)

C++ Syntax

HRESULT put_CloseCaptioning(newVal)

 

IltmmPlay *pPlay;

/* pointer to an interface */

VARIANT_BOOL newVal;

/* flag */

Enables or disables close captioning.

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

newVal

Flag that determines whether to enable close captioning. Possible values are:

 

Value

Meaning

 

VARIANT_TRUE

Enable close captioning.

 

VARIANT_FALSE

Disable close captioning.

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

See Also

Elements:

IltmmPlay::get_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++.