fl-heartbeat/com.quickplay.vstb7.heartbeat.model/HeartbeatConfiguration

HeartbeatConfiguration

data class HeartbeatConfiguration(val streamConcurrencyEndPointURL: String? = null, val heartbeatEndPointURL: String, val heartbeatSyncIntervalMs: Long = DEFAULT_HEARTBEAT_SYNC_INTERVAL_MS, val heartbeatMaxAllowedFailures: Int = DEFAULT_HEARTBEAT_MAX_ALLOWED_FAILURES, val recordBookmark: Boolean = false, val showPostEventSlateTimeMs: Long = DEFAULT_POST_EVENT_SLATE_TIME_MS, val stopPlayerOnStreamTimelineEvent: Boolean = true, val multiStreamMode: Boolean = false, val trackViewersCount: Boolean? = false)

Represents configuration data for HeartbeatManager.

Constructors

constructor(streamConcurrencyEndPointURL: String? = null, heartbeatEndPointURL: String, heartbeatSyncIntervalMs: Long = DEFAULT_HEARTBEAT_SYNC_INTERVAL_MS, heartbeatMaxAllowedFailures: Int = DEFAULT_HEARTBEAT_MAX_ALLOWED_FAILURES, recordBookmark: Boolean = false, showPostEventSlateTimeMs: Long = DEFAULT_POST_EVENT_SLATE_TIME_MS, stopPlayerOnStreamTimelineEvent: Boolean = true, multiStreamMode: Boolean = false, trackViewersCount: Boolean? = false)

Properties

heartbeatEndPointURL

val heartbeatEndPointURL: String

The HeartbeatService endpoint url.

heartbeatMaxAllowedFailures

val heartbeatMaxAllowedFailures: Int

The maximum number of consecutive failed heartbeat calls (network or infrastructure issues) that are allowed to happen before the content's playback is terminated:

heartbeatSyncIntervalMs

val heartbeatSyncIntervalMs: Long

The time interval, in milliseconds, used to periodically update stream state of the currently playing content. Default value is DEFAULT_HEARTBEAT_SYNC_INTERVAL_MS.

multiStreamMode

val multiStreamMode: Boolean = false

Specifies whether the client application has initialized multiple playback sessions.

recordBookmark

val recordBookmark: Boolean = false

Specifies whether to use the heartbeat service to record bookmarks (player's resume position) for VOD content. Default value is Boolean.false

showPostEventSlateTimeMs

val showPostEventSlateTimeMs: Long

stopPlayerOnStreamTimelineEvent

val stopPlayerOnStreamTimelineEvent: Boolean = true

Specifies whether to stop the player when a corresponding StreamTimelineEvent occurs. Default value is Boolean.true.

streamConcurrencyEndPointURL

val streamConcurrencyEndPointURL: String? = null

The StreamConcurrencyService endpoint url. Note that this property is optional.

trackViewersCount

val trackViewersCount: Boolean? = false

The flag indicates whether to track the viewers count or not, for the content to play. Default value is false.