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

Package-level declarations

Types

enum HeartbeatAction : Enum<HeartbeatAction>

Represents all possible Heartbeat actions:

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.

HeartbeatRequest

@JsonClass(generateAdapter = true)

data class HeartbeatRequest(@Json(name = "deviceId") val deviceId: String, @Json(name = "itemId") val itemId: String, @Json(name = "offset") val offsetMs: Long? = null, @Json(name = "cty") val catalogType: String? = null, @Json(name = "prid") val primaryContentId: String? = null)

Data containing information for the request being made to Heartbeat microservice.

HeartbeatResponse

@JsonClass(generateAdapter = true)

data class HeartbeatResponse(@Json(name = "heartbeatToken") val heartbeatToken: String? = null, @Json(name = "blackoutUrl") val blackoutUrl: String? = null, @Json(name = "blackoutAction") val blackoutAction: BlackoutAction? = null, @Json(name = "liveStartTime") val liveStartTime: String? = null, @Json(name = "liveEndTime") val liveEndTime: String? = null, @Json(name = "pgmId") val programId: String? = null, @Json(name = "pgmStartTime") val programStartTime: String? = null, @Json(name = "pgmEndTime") val programEndTime: String? = null, @Json(name = "pgmBlackout") val programBlackout: Boolean? = null, @Json(name = "livePlaybackMode") val livePlaybackMode: PlaybackMode? = null, @Json(name = "heartbeatAction") val heartbeatAction: HeartbeatAction? = null, @Json(name = "live360Enabled") val live360Enabled: Boolean? = null, @Json(name = "live360StartTime") val live360StartTime: String? = null, @Json(name = "live360EndTime") val live360EndTime: String? = null, @Json(name = "live360ContentId") val live360ContentId: String? = null, @Json(name = "custom") val custom: Map<String, Any>? = null)

Data containing the Heartbeat microservice response.

OverflowMode

enum OverflowMode : Enum<OverflowMode>

Represents all possible play states of overflow event.

PlaybackMode

enum PlaybackMode : Enum<PlaybackMode>

Represents all possible LIVE Playback modes:

Properties

DEFAULT_HEARTBEAT_MAX_ALLOWED_FAILURES

const val DEFAULT_HEARTBEAT_MAX_ALLOWED_FAILURES: Int = 2

DEFAULT_HEARTBEAT_SYNC_INTERVAL_MS

const val DEFAULT_HEARTBEAT_SYNC_INTERVAL_MS: Long = 60000

DEFAULT_POST_EVENT_SLATE_TIME_MS

const val DEFAULT_POST_EVENT_SLATE_TIME_MS: Long = 900000