IltmmCapture::get_CloseCaptionAvailable

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_get_CloseCaptionAvailable(pCapture, pVal)

C++ Syntax

HRESULT get_CloseCaptionAvailable(pVal)

 

IltmmCapture *pCapture;

/* pointer to an interface */

VARIANT_BOOL *pVal;

/* pointer to a variable */

Queries whether close captioning is available.

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

pVal

Pointer to a variable that determines whether close captioning is available. Possible values are:

 

Value

Meaning

 

VARIANT_TRUE

Close captioning is available.

 

VARIANT_FALSE

Close captioning is unavailable.

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::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 Advanced Capture Application for C.

For a C++ example, refer to Advanced Capture Application for C++.