pillarbox-player/ch.srgssr.pillarbox.player.monitoring.models/EventMessageData

EventMessageData

@Serializable

data class EventMessageData(val audio: String?, val bandwidth: Long, val bitrate: Long, val bufferDuration: Long, val duration: Long, val playbackDuration: Long, val position: Long, val positionTimestamp: Long?, val stall: EventMessageData.Stall, val streamType: EventMessageData.StreamType, val subtitles: String?, val url: String, val vpn: Boolean?, val frameDrops: Int) : MessageData

Represents a generic event, which contains metrics about the current media stream.

Constructors

EventMessageData

constructor(audio: String?, bandwidth: Long, bitrate: Long, bufferDuration: Long, duration: Long, playbackDuration: Long, position: Long, positionTimestamp: Long?, stall: EventMessageData.Stall, streamType: EventMessageData.StreamType, subtitles: String?, url: String, vpn: Boolean?, frameDrops: Int)

Types

@Serializable

data class Stall(val count: Int, val duration: Long)

Represents information about stalls that occur during playback.

enum StreamType : Enum<EventMessageData.StreamType>

Represents the type of a media stream.

Properties

val audio: String?

The audio track language code.

val bandwidth: Long

The device-measured network bandwidth, in bits per second.

val bitrate: Long

The bitrate of the current stream, in bits per second.

@SerialName(value = "buffered_duration")

val bufferDuration: Long

The forward duration of the buffer, in milliseconds.

val duration: Long

The duration of the media being played, in milliseconds.

@SerialName(value = "frame_drops")

val frameDrops: Int

The number of frame drops that have occurred during playback.

playbackDuration

@SerialName(value = "playback_duration")

val playbackDuration: Long

The duration of the playback, in milliseconds.

val position: Long

The current playback position of the player, in milliseconds.

positionTimestamp

@SerialName(value = "position_timestamp")

val positionTimestamp: Long?

The current player timestamp, as retrieved from the playlist.

val stall: EventMessageData.Stall

Information about stalls that have occurred during playback.

@SerialName(value = "stream_type")

val streamType: EventMessageData.StreamType

The type of stream being played.

val subtitles: String?

The subtitles language code (CC, subtitles or forced subtitles).

val url: String

The URL of the stream being played.

val vpn: Boolean?

Indicates whether a VPN is enabled, or if the status could not be determined.