ILMMuxSubtitle Interface

The ILMMuxSubtitle interface is exposed by multiplexers, and is used to add subtitle streams to the multiplexer's output.

For an overview of how to use the ILMMuxSubtitle interface, refer to Displaying Subtitles.

Properties

Type Name Description
ILMSubtitleTrackList Tracks A read-only property that contains the list of all tracks.
ILMSubtitleTrackList TextTracks A read-only property that contains a list of all text tracks.

Methods

HRESULT LeaveEdit(VARIANT_BOOL discard);

Description

Exits the edit mode.

Parameters

discard

A VARIANT_BOOL value that indicates whether to discard all changes made during edit mode. A value of VARIANT_TRUE discards all changes made while in edit mode. A value of VARIANT_FALSE will keep the changes.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
VFW_E_WRONG_STATE The graph is not stopped.

HRESULT EnterEdit();

Description

Enters edit mode. Call this function before making changes to the tracks.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
VFW_E_WRONG_STATE The graph is not stopped.

HRESULT RemoveTrack(LONG trackid);

Description

Removes the specified track.

Parameters

trackid

A long value that contains the track identifier.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
E_INVALIDARG The track is not in the Tracks list.

HRESULT AddTextTrackFromFile(BSTR path, BSTR label, BSTR language, LONG *trackid);

Description

Adds a text track from a file. Currently, only the SubRip (*.srt) format is supported.

Parameters

path

A string value containing the path to the subtitle file.

label

A string value containing the track label.

language

A string value containing the RFC 5646 language code for the track.

trackid

A pointer to a long variable that receives the new track identifier.

Returns

Return Description
S_OK Successful.
< 0 An error occurred.
VFW_E_INVALID_FILE_FORMAT The file format is not valid.
Help Version 22.0.2022.4.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Filters C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2022 LEAD Technologies, Inc. All Rights Reserved.