IltmmConvert::SetClosedCaptioningTargetFile

#include "ltmm.h"

C Syntax	HRESULT IltmmConvert_SetClosedCaptioningTargetFile(pConvert, filename, flags)
C++ Syntax	HRESULT SetClosedCaptioningTargetFile(filename, flags)

IltmmConvert *pConvert;	/* pointer to an interface */
BSTR filename;	/* closed captioning target filename */
long flags;	/* save flags */

Sets the filename and options for saving Closed Captioning data to either SRT or TEXT format.

Parameter	Description
pConvert	Pointer to an IltmmConvert interface.
filename	A character string containing the name of the file to which to save the closed captioning information.
flags	Value that represents the desired save options. For a list of possible values, refer to ltmmClosedCaptioning_Flag Constants.

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.

Comments

Use this function to save the decoded closed captioning data coming from a LEAD MPEG2 decoder. Closed Captioning data can be embedded inside an MPEG2 Video Elementary stream.

The Convert object can decode such data and write it to a file. Files can be saved to two different formats:SubRip (SRT) and text.

SRT files contain the subtitles along with the timing information that specifies when to display each subtitle. By default IltmmConvert::SetClosedCaptioningTargetFile saves to the SRT format. To set it to use the default, set the flags to zero or ltmmClosedCaptioning_Default. Find more information about the SubRip format by searching for "SubRip" on the internet.

Closed captioning data can also be saved as text. To save the closed captioning information as a text file, set flags to ltmmClosedCaptioning_Text.

For a list of predefined values, refer to ltmmClosedCaptioning_Flag Constants.

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, IltmmCapture::get_CloseCaptioning, IltmmCapture::get_PreviewingCloseCaption, IltmmCapture::put_CloseCaptioning, IltmmCapture::ToggleCloseCaptioning, IltmmConvert::get_AllowedStreams, IltmmConvert::ToggleFullScreenMode
Topics:	Multimedia Function Groups
	Closed Captioning

Example

For a C++ example, refer to IltmmConvert::SetClosedCaptioningTargetFile Example for C++.