Interface MillicastMetadataCue

Represents a metadata cue of a Millicast source.

Remarks

In order to receive Millicast metadata, you must set metadata to true in MillicastSource.connectOptions.

See

https://docs.dolby.io/streaming-apis/docs/frame-metadata

interface MillicastMetadataCue {
    content: undefined;
    endTime: number;
    id: string;
    mid: string;
    startTime: number;
    timecode: undefined | Date;
    track: TextTrack;
    uid: number;
    unregistered: undefined | object | Uint8Array;
    uuid: undefined | string;
    addEventListener<TType extends keyof TextTrackCueEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<TextTrackCueEventMap[TType]>,
    ): void;
    removeEventListener<TType extends keyof TextTrackCueEventMap>(
        type: TType | readonly TType[],
        listener: EventListener<TextTrackCueEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

TextTrackCue
- MillicastMetadataCue

Index

Properties

content endTime id mid startTime timecode track uid unregistered uuid

Methods

addEventListener removeEventListener

Properties

`Readonly`content

content: undefined

Unused.

Remarks

- Use timecode and/or unregistered to retrieve the contents of the Millicast metadata.

endTime

endTime: number

The playback position at which the cue becomes inactive, in seconds.

id

id: string

The identifier of the cue.

`Readonly`mid

mid: string

The media identifier of the track that contains the metadata.

startTime

startTime: number

The playback position at which the cue becomes active, in seconds.

`Readonly`timecode

timecode: undefined | Date

Timecode of when the metadata was generated.

track

track: TextTrack

The text track of the cue.

`Readonly`uid

uid: number

A unique identifier of the text track cue.

Remarks

- This identifier is unique across text track cues of a THEOplayer instance and can be used to distinguish between cues.
- This identifier is a randomly generated number.

`Readonly`unregistered

unregistered: undefined | object | Uint8Array

Unregistered data.

Remarks

- If the metadata content is valid JSON, then this is the parsed JSON object. Otherwise, it's the raw data as a Uint8Array.

`Readonly`uuid

uuid: undefined | string

The UUID of the metadata.

Methods

addEventListener

addEventListener<TType extends keyof TextTrackCueEventMap>(
type: TType | readonly TType[],
listener: EventListener<TextTrackCueEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends keyof TextTrackCueEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<TextTrackCueEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from TextTrackCue.addEventListener

removeEventListener

removeEventListener<TType extends keyof TextTrackCueEventMap>(
type: TType | readonly TType[],
listener: EventListener<TextTrackCueEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends keyof TextTrackCueEventMap
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<TextTrackCueEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from TextTrackCue.removeEventListener

Interface MillicastMetadataCue

Remarks

See

Hierarchy (View Summary)

Index

Properties

Methods

Properties

`Readonly`content

Remarks

endTime

id

`Readonly`mid

startTime

`Readonly`timecode

track

`Readonly`uid

Remarks

`Readonly`unregistered

Remarks

`Readonly`uuid

Methods

addEventListener

Type Parameters

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Settings

On This Page

Interface MillicastMetadataCue

Remarks

See

Hierarchy (View Summary)

Index

Properties

Methods

Properties

Readonlycontent

Remarks

endTime

id

Readonlymid

startTime

Readonlytimecode

track

Readonlyuid

Remarks

Readonlyunregistered

Remarks

Readonlyuuid

Methods

addEventListener

Type Parameters

Parameters

Returns void

removeEventListener

Type Parameters

Parameters

Returns void

Settings

On This Page

`Readonly`content

`Readonly`mid

`Readonly`timecode

`Readonly`uid

`Readonly`unregistered

`Readonly`uuid