player-core/com.bitmovin.player.api.live/LiveConfig

LiveConfig

data class LiveConfig(var lowLatencyConfig: LowLatencyConfig? = null, var synchronization: List<SynchronizationConfigEntry> = emptyList(), var liveEdgeOffset: Double = -1.0, var minTimeShiftBufferDepth: Double = DEFAULT_MIN_TIME_SHIFT_BUFFER_DEPTH) : Parcelable

Configures the behaviour when playing live content.

Constructors

LiveConfig

constructor(lowLatencyConfig: LowLatencyConfig? = null, synchronization: List<SynchronizationConfigEntry> = emptyList(), liveEdgeOffset: Double = -1.0, minTimeShiftBufferDepth: Double = DEFAULT_MIN_TIME_SHIFT_BUFFER_DEPTH)

Types

Companion

object Companion

Properties

liveEdgeOffset

var ~~liveEdgeOffset~~: Double

The duration in seconds by which the default start position should precede the current real time, or window edge, if the offset to current real time is not known. A suggested presentation delay in a manifest will be overridden. In case LowLatencyConfig or SourceLiveConfig.targetLatency is set, the liveEdgeOffset will be ignored. A value < 0 doesn't override the manifest value.

lowLatencyConfig

var ~~lowLatencyConfig~~: LowLatencyConfig?

The LowLatencyConfig or null.

minTimeShiftBufferDepth

var ~~minTimeShiftBufferDepth~~: Double

The minimum buffer depth of a stream needed to enable time shifting. If the available buffer depth is shorter, time shifting is disabled and Player.maxTimeShift returns 0.

synchronization

var synchronization: List<SynchronizationConfigEntry>

A list of SynchronizationConfigEntrys defining the endpoints for time synchronization.

Functions

addSynchronizationEntry

fun addSynchronizationEntry(source: String, method: LiveSynchronizationMethod): SynchronizationConfigEntry

Adds a SynchronizationConfigEntry. Each Entry has a source which specifies the server that should be used for time synchronization as well as a LiveSynchronizationMethod used to synchronize time with the source.