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

Package-level declarations

Types

@Serializable

data class ErrorMessageData(val audio: String?, val duration: Long?, val log: String, val message: String, val name: String, val position: Long?, val positionTimestamp: Long?, val subtitles: String?, val url: String) : MessageData

Represents a Player error to send to a monitoring server.

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.

Message

@Serializable

data class Message(val data: MessageData, val eventName: Message.EventName, val sessionId: String, val timestamp: Long = System.currentTimeMillis(), val version: Int = 1)

Represents a monitoring message.

MessageData

@Serializable

sealed interface MessageData

Represents the base interface for all data carried by monitoring messages.

Session

@Serializable

data class Session(val application: Session.Application, val device: Session.Device, val media: Session.Media, val operatingSystem: Session.OS = OS( name = PLATFORM_NAME, version = OPERATING_SYSTEM_VERSION, ), val player: Session.Player = Player( name = PLAYER_NAME, platform = PLATFORM_NAME, version = PLAYER_VERSION, ), val qoeTimings: Timings.QoE = Timings.QoE(), val qosTimings: Timings.QoS = Timings.QoS(), val screen: Session.Screen) : MessageData

Represents a monitoring session, which encapsulates information about the device, current media, player, and performance metrics.

Timings

object Timings

Contains data classes representing timings related to media playback.