WebRtcLiveViewCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface WebRtcLiveViewCommands

Known direct subclasses
WebRtcLiveView

API for the WebRtcLiveView trait.


Commands for the WebRtcLiveView trait.

Summary

Public functions

suspend WebRtcLiveViewTrait.ExtendLiveViewCommand.Response

Extend a WebRTC live stream.

BatchableCommand<WebRtcLiveViewTrait.ExtendLiveViewCommand.Response>

The batchable version of extendLiveView command.

suspend WebRtcLiveViewTrait.StartLiveViewCommand.Response
startLiveView(offerSdp: String)

Start a WebRTC live stream.

BatchableCommand<WebRtcLiveViewTrait.StartLiveViewCommand.Response>

The batchable version of startLiveView command.

suspend Unit

Start a WebRTC live stream.

BatchableCommand<Unit>

The batchable version of startTalkback command.

suspend Unit
stopLiveView(mediaSessionId: String)

Stop a WebRTC live stream.

BatchableCommand<Unit>
stopLiveViewBatchable(mediaSessionId: String)

The batchable version of stopLiveView command.

suspend Unit
stopTalkback(mediaSessionId: String)

Start a WebRTC live stream.

BatchableCommand<Unit>
stopTalkbackBatchable(mediaSessionId: String)

The batchable version of stopTalkback command.

Public functions

extendLiveView

suspend fun extendLiveView(mediaSessionId: String, optionalArgs: WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs.() -> Unit = {}): WebRtcLiveViewTrait.ExtendLiveViewCommand.Response

Extend a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to extend.

optionalArgs: WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

Returns
WebRtcLiveViewTrait.ExtendLiveViewCommand.Response

The outcome of the ExtendLiveView command.

extendLiveViewBatchable

fun extendLiveViewBatchable(
    mediaSessionId: String,
    optionalArgs: WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<WebRtcLiveViewTrait.ExtendLiveViewCommand.Response>

The batchable version of extendLiveView command.

Extend a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to extend.

optionalArgs: WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

startLiveView

suspend fun startLiveView(offerSdp: String): WebRtcLiveViewTrait.StartLiveViewCommand.Response

Start a WebRTC live stream.

Parameters
offerSdp: String

An SDP offer, specific to the local device that will display the WebRTC live stream.

Returns
WebRtcLiveViewTrait.StartLiveViewCommand.Response

The outcome of the ExtendLiveView command.

startLiveViewBatchable

fun startLiveViewBatchable(offerSdp: String): BatchableCommand<WebRtcLiveViewTrait.StartLiveViewCommand.Response>

The batchable version of startLiveView command.

Start a WebRTC live stream.

Parameters
offerSdp: String

An SDP offer, specific to the local device that will display the WebRTC live stream.

startTalkback

suspend fun startTalkback(mediaSessionId: String, optionalArgs: WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs.() -> Unit = {}): Unit

Start a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to start.

optionalArgs: WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

startTalkbackBatchable

fun startTalkbackBatchable(mediaSessionId: String, optionalArgs: WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>

The batchable version of startTalkback command.

Start a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to start.

optionalArgs: WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command

Returns
BatchableCommand<Unit>

BatchableCommand

stopLiveView

suspend fun stopLiveView(mediaSessionId: String): Unit

Stop a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to start.

stopLiveViewBatchable

fun stopLiveViewBatchable(mediaSessionId: String): BatchableCommand<Unit>

The batchable version of stopLiveView command.

Stop a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to start.

Returns
BatchableCommand<Unit>

BatchableCommand

stopTalkback

suspend fun stopTalkback(mediaSessionId: String): Unit

Start a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to stop.

stopTalkbackBatchable

fun stopTalkbackBatchable(mediaSessionId: String): BatchableCommand<Unit>

The batchable version of stopTalkback command.

Start a WebRTC live stream.

Parameters
mediaSessionId: String

The media session ID of the live stream to stop.

Returns
BatchableCommand<Unit>

BatchableCommand