Cast

class Cast(cdp: CDP) : Domain

A domain for interacting with Cast, Presentation API, and Remote Playback API functionalities.

Constructors

Cast

constructor(cdp: CDP)

Types

EnableParameter

@Serializable

data class EnableParameter(val presentationUrl: String? = null)

IssueUpdatedParameter

@Serializable

data class IssueUpdatedParameter(val issueMessage: String)

This is fired whenever the outstanding issue/error message changes. |issueMessage| is empty if there is no issue.

SetSinkToUseParameter

@Serializable

data class SetSinkToUseParameter(val sinkName: String)

Sink

@Serializable

data class Sink(val name: String, val id: String, val session: String? = null)

SinksUpdatedParameter

@Serializable

data class SinksUpdatedParameter(val sinks: List<Cast.Sink>)

This is fired whenever the list of available sinks changes. A sink is a device or a software surface that you can cast to.

StartDesktopMirroringParameter

@Serializable

data class StartDesktopMirroringParameter(val sinkName: String)

StartTabMirroringParameter

@Serializable

data class StartTabMirroringParameter(val sinkName: String)

StopCastingParameter

@Serializable

data class StopCastingParameter(val sinkName: String)

Properties

issueUpdated

val issueUpdated: Flow<Cast.IssueUpdatedParameter>

This is fired whenever the outstanding issue/error message changes. |issueMessage| is empty if there is no issue.

sinksUpdated

val sinksUpdated: Flow<Cast.SinksUpdatedParameter>

This is fired whenever the list of available sinks changes. A sink is a device or a software surface that you can cast to.

Functions

disable

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

Stops observing for sinks and issues.

enable

suspend fun enable(presentationUrl: String? = null)

suspend fun enable(args: Cast.EnableParameter, mode: CommandMode = CommandMode.DEFAULT)

setSinkToUse

suspend fun setSinkToUse(sinkName: String)

suspend fun setSinkToUse(args: Cast.SetSinkToUseParameter, mode: CommandMode = CommandMode.DEFAULT)

Sets a sink to be used when the web page requests the browser to choose a sink via Presentation API, Remote Playback API, or Cast SDK.

startDesktopMirroring

suspend fun startDesktopMirroring(sinkName: String)

suspend fun startDesktopMirroring(args: Cast.StartDesktopMirroringParameter, mode: CommandMode = CommandMode.DEFAULT)

Starts mirroring the desktop to the sink.

startTabMirroring

suspend fun startTabMirroring(sinkName: String)

suspend fun startTabMirroring(args: Cast.StartTabMirroringParameter, mode: CommandMode = CommandMode.DEFAULT)

Starts mirroring the tab to the sink.

stopCasting

suspend fun stopCasting(sinkName: String)

suspend fun stopCasting(args: Cast.StopCastingParameter, mode: CommandMode = CommandMode.DEFAULT)

Stops the active Cast session on the sink.