Class MediaPlayback

Inherits from this class to use logs

Hierarchy (View Summary)

Loggable
- MediaPlayback

Index

Constructors

Properties

Accessors

audioEnabled closed endTime startTime videoEnabled

Methods

appendAudio appendVideo close flush

Events

onAudioAppended onBufferOverflow onClose onProgress onVideoAppended

Constructors

constructor

new MediaPlayback(
mediaSource: MediaSource,
passthroughCMAF?: boolean,
): MediaPlayback
Parameters
- mediaSource: MediaSource
- passthroughCMAF: boolean = false
Returns MediaPlayback
Overrides Loggable.constructor
- Defined in src/media/MediaPlayback.ts:153

Properties

log

log: ILog

Start a log

Param: args

Returns

a Log object with the levels of log to call

Accessors

audioEnabled

get audioEnabled(): boolean
Returns boolean
- Defined in src/media/MediaPlayback.ts:113
set audioEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/media/MediaPlayback.ts:117

closed

get closed(): boolean
Renderer is closed

Returns boolean
- Defined in src/media/MediaPlayback.ts:74

endTime

get endTime(): number
Returns number
- Defined in src/media/MediaPlayback.ts:98

startTime

get startTime(): number
Returns number
- Defined in src/media/MediaPlayback.ts:78
set startTime(value: number): void
Parameters
- value: number
Returns void
- Defined in src/media/MediaPlayback.ts:89

videoEnabled

get videoEnabled(): boolean
Returns boolean
- Defined in src/media/MediaPlayback.ts:130
set videoEnabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/media/MediaPlayback.ts:134

Methods

appendAudio

appendAudio(metadata: Metadata, trackId: number, sample: Sample): void
Parameters
- metadata: Metadata
- trackId: number
- sample: Sample
Returns void
- Defined in src/media/MediaPlayback.ts:159

appendVideo

appendVideo(metadata: Metadata, trackId: number, sample: Sample): void
Parameters
- metadata: Metadata
- trackId: number
- sample: Sample
Returns void
- Defined in src/media/MediaPlayback.ts:168

close

close(error?: MediaPlaybackError): void
Parameters
- Optionalerror: MediaPlaybackError
Returns void
- Defined in src/media/MediaPlayback.ts:182

flush

flush(fixHole?: boolean): void
Parameters
- fixHole: boolean = false
Returns void
- Defined in src/media/MediaPlayback.ts:177

Events

onAudioAppended

onAudioAppended(data: Uint8Array): void
Event fire when audio data are appended to the renderer, basically here to debug MSE ingestion
Parameters
- data: Uint8Array
Returns void
- Defined in src/media/MediaPlayback.ts:63

onBufferOverflow

onBufferOverflow(): void
Fired when the playback buffer exceeds its capacity, a play or set a startTime to remove the beginning can resolve the situation

Returns void
- Defined in src/media/MediaPlayback.ts:49

onClose

onClose(error?: MediaPlaybackError): void
Fired on renderer close
Parameters
- Optionalerror: MediaPlaybackError
  error description on an improper closure
Returns void
- Defined in src/media/MediaPlayback.ts:36

onProgress

onProgress(): void
Fired when the renderer makes progress in time.

Returns void
- Defined in src/media/MediaPlayback.ts:57

onVideoAppended

onVideoAppended(data: Uint8Array): void
Event fire when video data are appended to the renderer, basically here to debug MSE ingestion
Parameters
- data: Uint8Array
Returns void
- Defined in src/media/MediaPlayback.ts:69