Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ISyncMediaPlayerInitOptions

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

    interface ISyncMediaPlayerInitOptions {
        addDefaultMediaObjectRenderers?: boolean;
        name?: string;
        preloadAheadMs?: number;
        preloadBehindMs?: number;
    }

    Properties

    addDefaultMediaObjectRenderers?: boolean

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

    true
    name?: string

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

    preloadAheadMs?: number

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

    20000
    preloadBehindMs?: number

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

    5000
    Properties