HeartbeatConfiguration

public protocol HeartbeatConfiguration

The Heartbeat configuration

  • Heartbeat service endpoint url

    Declaration

    Swift

    var heartbeatEndPointUrl: String { get }

  • Stream concurrency service endpoint url

    Declaration

    Swift

    var streamConcurrencyEndPointUrl: String? { get }

  • Specifies whether the current device is currently streaming multiple videos using multiple player instances

    Declaration

    Swift

    var multiStreamMode: Bool { get }

  • The time interval used to periodically update stream state for the currently playing content

    Declaration

    Swift

    var syncInterval: TimeInterval { get }

  • The maximum number of failed heartbeat check attempts (network or infrastructure issues) that are allowed to happen in line before the Live content’s playback is terminated. If we have the same number of failures without any success - stop playback. If we have less failures without success - continue playback, send new heartbeat in time. If we have negative response from server (“not allowed”) - stop Live playback ignoring this number

    Declaration

    Swift

    var maxAllowedFailures: UInt { get }

  • The number of retries allowed for network failure Default value is 2.

    Declaration

    Swift

    var maxAllowedRetries: Int { get }

  • Delay between failure and retry attempt. Default value is 1sec. Expected value in seconds.

    Declaration

    Swift

    var retryDelayInSec: Double { get }

  • Specifies whether to use the heartbeat service to record bookmarks/resume points for VOD contents.

    Declaration

    Swift

    var recordBookmark: Bool? { get }

  • Specifies whether to use the heartbeat service to stop playback when the progame/event ends for live content.

    Declaration

    Swift

    var playbackStopOnPlaybackEnd: Bool? { get }

  • Flag to enable viewer count tracking

    Declaration

    Swift

    var trackViewerCount: Bool? { get }