heartbeat
abstract suspend fun heartbeat(heartbeatToken: String, offsetMs: Long? = null): Result<HeartbeatResponse?, Error>
Pings the Heartbeat Microservice.
Return
Result.Success with SingleDataResponse containing the response status in ResponseHeader and a valid SingleDataResponse.data instance in case of blackout. If the SingleDataResponse.data instance is null we are in regular heartbeat token refresh flow. In case of an error the Result.Failure with Error object is returned.
Parameters
heartbeatToken
The token that encodes additional information which must be added with each heartbeat request. This token is part of the payload provided by content authorization service response.
offsetMs
The optional parameter that specifies the the player's playhead position, in milliseconds.