colibrio-reader-framework/com.colibrio.readingsystem.engine/SyncMediaAudioRendererOptions

SyncMediaAudioRendererOptions

data class SyncMediaAudioRendererOptions(val alignedSegmentSeekThresholdMs: Int = 500, val audioElementPoolSize: Int = 10, val enableBlobUrls: Boolean? = null, val enableMediaStreaming: Boolean = false)

Options used when instantiating new SyncMediaAudioRenderer instances.

Constructors

constructor(alignedSegmentSeekThresholdMs: Int = 500, audioElementPoolSize: Int = 10, enableBlobUrls: Boolean? = null, enableMediaStreaming: Boolean = false)

Types

Companion

object Companion

Properties

alignedSegmentSeekThresholdMs

val alignedSegmentSeekThresholdMs: Int = 500

This option controls how the SyncMediaAudioRenderer should treat gaps between two consecutive segments. If you hear many clicks, and cutoff words when playing back the audio in the publication, try increasing the value of this option.

audioElementPoolSize

val audioElementPoolSize: Int = 10

Sync Media Player manages a pool of Audio elements and listens on pointer events to setup the elements in a way that will allow continuous playback across audio files. This is done to reduce probability of the Sync Media Player getting paused during playback due to browser auto-play policy.

enableBlobUrls

val enableBlobUrls: Boolean? = null

This option controls how resource data should be loaded when the audio renderer cannot stream a resource.

enableMediaStreaming

val enableMediaStreaming: Boolean = false

If streaming of audio and video using the Media Source Extensions API (MSE) should be used. See https://developer.mozilla.org/en-US/docs/Web/API/Media_Source_Extensions_API

Functions

serialize

fun serialize(generator: JsonGenerator)