HeartbeatManager

Manager that manages playback session's heartbeat lifecycle that covers checking stream concurrency and blackout boundary conditions For example stream would be aborted for the following cases:

  • heartbeat update fails on the server
  • heartbeat update fails for consecutive attempts as per [HeartbeatConfiguration.heartbeatMaxAllowedFailures]
  • content is blacked out

Properties

Link copied to clipboard

HeartbeatService instance to set, if custom one, and get if previously set and if not then the default one is returned.

Link copied to clipboard
abstract val heartbeatToken: String

The token that encodes additional information of the content. This token is part of the payload provided by content authorization service response.

Link copied to clipboard
abstract var multiStreamMode: Boolean

Allows to override the HeartbeatConfiguration.multiStreamMode value.

Link copied to clipboard
abstract val player: ComposablePlayer

ComposablePlayer instance that provides PlaybackState information and used to abort the playback in case of errors.

Link copied to clipboard

StreamConcurrencyService instance to set, if custom one, and get if previously set and if not then the default one is returned.

Functions

Link copied to clipboard
abstract fun updateHeartbeatToken(heartbeatToken: String)

Updates the heartbeatToken and this will be used in the future heartbeat update calls.