cdp/dev.kdriver.cdp.domain/Media

Media

class Media(cdp: CDP) : Domain

This domain allows detailed inspection of media elements

Constructors

Media

constructor(cdp: CDP)

Types

PlayerError

@Serializable

data class PlayerError(val errorType: String, val code: Int, val stack: List<Media.PlayerErrorSourceLocation>, val cause: List<Media.PlayerError>, val data: Map<String, JsonElement>)

Corresponds to kMediaError

PlayerErrorSourceLocation

@Serializable

data class PlayerErrorSourceLocation(val file: String, val line: Int)

Represents logged source line numbers reported in an error. NOTE: file and line are from chromium c++ implementation code, not js.

PlayerErrorsRaisedParameter

@Serializable

data class PlayerErrorsRaisedParameter(val playerId: String, val errors: List<Media.PlayerError>)

Send a list of any errors that need to be delivered.

PlayerEvent

@Serializable

data class PlayerEvent(val timestamp: Double, val value: String)

Corresponds to kMediaEventTriggered

PlayerEventsAddedParameter

@Serializable

data class PlayerEventsAddedParameter(val playerId: String, val events: List<Media.PlayerEvent>)

Send events as a list, allowing them to be batched on the browser for less congestion. If batched, events must ALWAYS be in chronological order.

PlayerMessage

@Serializable

data class PlayerMessage(val level: String, val message: String)

Have one type per entry in MediaLogRecord::Type Corresponds to kMessage

PlayerMessagesLoggedParameter

@Serializable

data class PlayerMessagesLoggedParameter(val playerId: String, val messages: List<Media.PlayerMessage>)

Send a list of any messages that need to be delivered.

PlayerPropertiesChangedParameter

@Serializable

data class PlayerPropertiesChangedParameter(val playerId: String, val properties: List<Media.PlayerProperty>)

This can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.

PlayerProperty

@Serializable

data class PlayerProperty(val name: String, val value: String)

Corresponds to kMediaPropertyChange

PlayersCreatedParameter

@Serializable

data class PlayersCreatedParameter(val players: List<String>)

Called whenever a player is created, or when a new agent joins and receives a list of active players. If an agent is restored, it will receive the full list of player ids and all events again.

Properties

playerErrorsRaised

val playerErrorsRaised: Flow<Media.PlayerErrorsRaisedParameter>

Send a list of any errors that need to be delivered.

playerEventsAdded

val playerEventsAdded: Flow<Media.PlayerEventsAddedParameter>

Send events as a list, allowing them to be batched on the browser for less congestion. If batched, events must ALWAYS be in chronological order.

playerMessagesLogged

val playerMessagesLogged: Flow<Media.PlayerMessagesLoggedParameter>

Send a list of any messages that need to be delivered.

playerPropertiesChanged

val playerPropertiesChanged: Flow<Media.PlayerPropertiesChangedParameter>

This can be called multiple times, and can be used to set / override / remove player properties. A null propValue indicates removal.

playersCreated

val playersCreated: Flow<Media.PlayersCreatedParameter>

Called whenever a player is created, or when a new agent joins and receives a list of active players. If an agent is restored, it will receive the full list of player ids and all events again.

Functions

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables the Media domain.

enable

suspend fun enable(mode: CommandMode = CommandMode.DEFAULT)

Enables the Media domain