HeartbeatResponse

public protocol HeartbeatResponse : Decodable

The Interface for heartbeat server response

  • Token to be sent as headers with heartbeat update request.

    Declaration

    Swift

    var heartbeatToken: String? { get }

  • Blackout slate url.

    Declaration

    Swift

    var blackoutUrl: String? { get }

  • Blackout action. Refer BlackoutAction for possible actions.

    Declaration

    Swift

    var blackoutAction: BlackoutAction? { get }

  • Live event / program start time The value is in ISO 8601 time format.

    Declaration

    Swift

    var liveStartTime: String? { get }

  • Live event / program end time The value is in ISO 8601 time format.

    Declaration

    Swift

    var liveEndTime: String? { get }

  • Live event / program

    Declaration

    Swift

    var livePlaybackMode: String? { get }

  • Heartbeat Action. Refer HeartbeatActionfor possible actions.

    Declaration

    Swift

    var heartbeatAction: HeartbeatAction? { get }

  • Asset key for 360 is enable or not

    Declaration

    Swift

    var live360Enabled: Bool? { get }

  • Asset key for 360 Start Time

    Declaration

    Swift

    var live360StartTime: String? { get }

  • Asset key for 360 End Time

    Declaration

    Swift

    var live360EndTime: String? { get }

  • Asset key for 360 ContentID

    Declaration

    Swift

    var live360ContentId: String? { get }

  • Live playback current program identifier

    Declaration

    Swift

    var pgmId: String? { get }

  • Live playback current program start time

    Declaration

    Swift

    var pgmStartTime: String? { get }

  • Live playback current program end time

    Declaration

    Swift

    var pgmEndTime: String? { get }

  • Live playback current program is blackout

    Declaration

    Swift

    var isPgmBlackout: Bool { get }

  • API to provide an additional metadata about the current program

    Note

    eg: Ensures that the ad server serves ads based on the current program the user is watching

    Declaration

    Swift

    var custom: [String : Any]? { get }