ILMDmxSubtitleCallback Interface

User-supplied interface that receives notifications. The ILMDmxSubtitleCallback interface is assigned to the ILMDmxSubtitle.Callback property.

For an overview of implementing this interface, refer to Displaying Subtitles.

Data Types

LMSubtitle_Cue_Event

typedef enum  
{ 
   LMSubtitle_Cue_Event_Active, 
   LMSubtitle_Cue_Event_Inactive, 
   LMSubtitle_Cue_Event_Clear, 
 
} LMSubtitle_Cue_Event;

Lists the possible cue events.

Name	Description
LMSubtitle_Cue_Event_Active	Indicates that the specified cue should be displayed.
LMSubtitle_Cue_Event_Inactive	Indicates that the specified cue should be hidden.
LMSubtitle_Cue_Event_Clear	Indicates that all cues should be hidden. The currenttime and cue callback parameters are not valid during this event.

Interface Methods

HRESULT Cue(LMSubtitle_Cue_Event cueevent, DOUBLE currenttime, ILMSubtitleCue *cue);

Parameters

cueevent	An LMSubtitle_Cue_Event enumeration value that indicates which type of event has occurred.
currenttime	A double value that contains the time, in seconds, when the event occurred.
cue	An ILMSubtitleCue interface pointer that represents the cue.

Description

Called when a cue event occurs in a text track.

Care must be taken when accessing the parameters of this method. If cueevent is LMSubtitle_Cue_Event_Clear, then currenttime is 0 and cue is null.