ISyncMediaPlayerInitOptions | Colibrio Reader Framework API

Used when creating a new SyncMediaPlayer using ReadingSystemEngine.createSyncMediaPlayer(). These options cannot be changed after the SyncMediaPlayer has been created.

Hierarchy

ISyncMediaPlayerInitOptions

Index

Properties

Optional addDefaultMediaObjectRenderers

addDefaultMediaObjectRenderers?: boolean

If the SyncMediaPlayer should add the default MediaObjectRenderers from the SyncMediaTimeline. You can manually add MediaObjectRenderer instances using SyncMediaPlayer.addMediaObjectRenderer().

default: true

Optional name

name?: string

The unique name of this sync media player. You can fetch a media player by name from the ReadingSystemEngine object.

nativeignore

Optional preloadAheadMs

preloadAheadMs?: number

The minimum amount of milliseconds the MediaObjectRenderers used with this media player will preload ahead of its current position.

int
default: 20000

Optional preloadBehindMs

preloadBehindMs?: number

The minimum amount of milliseconds the MediaObjectRenderers used with this media player will preload behind of its current position.

int
default: 5000