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.

Constructors

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

Creates a HeartbeatResponse instance.

Properties

Link copied to clipboard

The BlackoutAction instance that specifies the action to be taken in case of Blackout.

Link copied to clipboard
val blackoutUrl: String? = null

The URL or the manifest of the content that will be played during Blackout.

Link copied to clipboard
val custom: Map<String, Any>? = null

The dictionary that includes attributes for ad targeting metadata.

Link copied to clipboard

One of the HeartbeatAction values.

Link copied to clipboard
val heartbeatToken: String? = null

The heartbeatToken returned by the Heartbeat microservice. This token encodes additional information which needs to be added with future heartbeat requests. Note that this might be different from the one used to initialize the HeartbeatService.

Link copied to clipboard

The unique identifier of the 360 degree content or the resource identifier.

Link copied to clipboard
val live360Enabled: Boolean? = null

The flag indicates whether the 360 degree camera is enabled for the content.

Link copied to clipboard
val live360EndTime: String? = null

The end time for 360 degree stream in ISO8601 format.

Link copied to clipboard

The start time for 360 degree stream in ISO8601 format.

Link copied to clipboard
val liveEndTime: String? = null

The end time for LIVE stream in ISO8601 format.

Link copied to clipboard

The PlaybackMode for LIVE stream.

Link copied to clipboard
val liveStartTime: String? = null

The start time for LIVE stream in ISO8601 format.

Link copied to clipboard

The flag is used to show black screen during LIVE program.

Link copied to clipboard
val programEndTime: String? = null

The currently playing LIVE program end in ISO8601 format.

Link copied to clipboard
val programId: String? = null
Link copied to clipboard

The currently playing LIVE program start in ISO8601 format.