chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.cast/CastDomain

CastDomain

class CastDomain(source)

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

Functions

suspend fun disable(): DisableResponse

Stops observing for sinks and issues.

inline suspend fun enable(optionalArgs: EnableRequest.Builder.() -> Unit = {}): EnableResponse

suspend fun enable(input: EnableRequest): EnableResponse

Starts observing for sinks that can be used for tab mirroring, and if set, sinks compatible with |presentationUrl| as well. When sinks are found, a |sinksUpdated| event is fired. Also starts observing for issue messages. When an issue is added or removed, an |issueUpdated| event is fired.

fun events(): Flow<CastEvent>

Subscribes to all events related to this domain.

fun ~~issueUpdated~~(): Flow<CastEvent.IssueUpdated>

issueUpdatedEvents

fun issueUpdatedEvents(): Flow<CastEvent.IssueUpdated>

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

suspend fun setSinkToUse(sinkName: String): SetSinkToUseResponse

suspend fun setSinkToUse(input: SetSinkToUseRequest): SetSinkToUseResponse

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.

fun ~~sinksUpdated~~(): Flow<CastEvent.SinksUpdated>

sinksUpdatedEvents

fun sinksUpdatedEvents(): Flow<CastEvent.SinksUpdated>

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

startDesktopMirroring

suspend fun startDesktopMirroring(sinkName: String): StartDesktopMirroringResponse

suspend fun startDesktopMirroring(input: StartDesktopMirroringRequest): StartDesktopMirroringResponse

Starts mirroring the desktop to the sink.

startTabMirroring

suspend fun startTabMirroring(sinkName: String): StartTabMirroringResponse

suspend fun startTabMirroring(input: StartTabMirroringRequest): StartTabMirroringResponse

Starts mirroring the tab to the sink.

suspend fun stopCasting(sinkName: String): StopCastingResponse

suspend fun stopCasting(input: StopCastingRequest): StopCastingResponse

Stops the active Cast session on the sink.