Class SyncMediaAudioRenderer

The SyncMediaAudioRenderer can be used for playing audio in SyncMediaTimelines. More specifically, it can play audio referenced by SyncMediaObjectRefs with type SyncMediaObjectRefType.AUDIO.

Hierarchy

SyncMediaAudioRenderer

Implements

ISyncMediaObjectRenderer

Index

Constructors

constructor

Methods

Constructors

constructor

new SyncMediaAudioRenderer(options?: ISyncMediaAudioRendererOptions): SyncMediaAudioRenderer

Parameters
- Optional options: ISyncMediaAudioRendererOptions
Returns SyncMediaAudioRenderer

Methods

createRuntime

createRuntime(timeline: ISyncMediaTimeline, context: ISyncMediaObjectRendererContext, playerOptions: DeepRequired<ISyncMediaPlayerInitOptions>): ISyncMediaObjectRendererRuntime

Implementation of ISyncMediaObjectRenderer.createRuntime

Used internally by the SyncMediaPlayer. Creates a new ISyncMediaObjectRendererRuntime instance.

Parameters
- timeline: ISyncMediaTimeline
- context: ISyncMediaObjectRendererContext
- playerOptions: DeepRequired<ISyncMediaPlayerInitOptions>
Returns ISyncMediaObjectRendererRuntime

destroyRuntime

destroyRuntime(runtime: ISyncMediaObjectRendererRuntime): void

Implementation of ISyncMediaObjectRenderer.destroyRuntime

Used internally by SyncMediaPlayer. Destroys a runtime previously created with createRuntime().

Parameters
- runtime: ISyncMediaObjectRendererRuntime
Returns void

getSupportedMediaObjectRefType

getSupportedMediaObjectRefType(): string

Implementation of ISyncMediaObjectRenderer.getSupportedMediaObjectRefType

Get the list of SyncMediaObjectRefTypes that this renderer supports.

Returns string

Static getDefaultOptions

getDefaultOptions(): DeepRequired<ISyncMediaAudioRendererOptions>

Returns DeepRequired<ISyncMediaAudioRendererOptions>

Generated using TypeDoc