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.

Interface 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.

Interface Methods

HRESULT LeaveEdit(VARIANT_BOOL discard);

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. A value of VARIANT_FALSE will keep the changes.

Description

Exits the edit mode. Set discard to VARIANT_TRUE to undo all changes made while in edit mode.

Returns

S_OK if successful, < 0 if an error occurred.

Common Error Codes

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

S_OK if successful, < 0 if an error occurred.

Common Error Codes

VFW_E_WRONG_STATE

The graph is not stopped.

HRESULT RemoveTrack(LONG trackid);

Parameters

trackid A long value that contains the track identifier.

Description

Removes the specified track.

Returns

S_OK if successful; < 0 if an error occurred.

Common Error Codes

E_INVALIDARG

The track is not in the Tracks list.

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

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.

Description

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

Returns

S_OK if successful; < 0 if an error occurred.

Common Error Codes

VFW_E_INVALID_FILE_FORMAT

The file format is not valid.

Help Version 20.0.2019.8.26
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Filters C API Help