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.ChangeLiveViewQualityCommand.Response
changeLiveViewQuality(
    mediaSessionId: String,
    qualityHint: WebRtcLiveViewTrait.QualityHint
)

Change the quality of a WebRTC live stream.
BatchableCommand<WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response>
changeLiveViewQualityBatchable(
    mediaSessionId: String,
    qualityHint: WebRtcLiveViewTrait.QualityHint
)

The batchable version of changeLiveViewQuality command.
suspend WebRtcLiveViewTrait.ExtendLiveViewCommand.Response

Extend a WebRTC live stream.
BatchableCommand<WebRtcLiveViewTrait.ExtendLiveViewCommand.Response>

The batchable version of extendLiveView command.
suspend WebRtcLiveViewTrait.StartLiveViewCommand.Response

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

changeLiveViewQuality

suspend fun changeLiveViewQuality(
    mediaSessionId: String,
    qualityHint: WebRtcLiveViewTrait.QualityHint
): WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response

Change the quality of a WebRTC live stream. If the requested quality is not supported, the closest available matching quality will be used.

Parameters
mediaSessionId: String

The media session ID of the live stream to change.
qualityHint: WebRtcLiveViewTrait.QualityHint

The quality hint for the live view session.
Returns
WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response

The outcome of the ChangeLiveViewQuality command.

changeLiveViewQualityBatchable

fun changeLiveViewQualityBatchable(
    mediaSessionId: String,
    qualityHint: WebRtcLiveViewTrait.QualityHint
): BatchableCommand<WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response>

The batchable version of changeLiveViewQuality command.

Change the quality of a WebRTC live stream. If the requested quality is not supported, the closest available matching quality will be used.

Parameters
mediaSessionId: String

The media session ID of the live stream to change.
qualityHint: WebRtcLiveViewTrait.QualityHint

The quality hint for the live view session.
Returns
BatchableCommand<WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response>

BatchableCommand

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
Returns
BatchableCommand<WebRtcLiveViewTrait.ExtendLiveViewCommand.Response>

BatchableCommand

startLiveView

suspend fun startLiveView(offerSdp: String, optionalArgs: WebRtcLiveViewTrait.StartLiveViewCommand.OptionalArgs.() -> Unit = {}): 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.
optionalArgs: WebRtcLiveViewTrait.StartLiveViewCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
WebRtcLiveViewTrait.StartLiveViewCommand.Response

The outcome of the ExtendLiveView command.

startLiveViewBatchable

fun startLiveViewBatchable(offerSdp: String, optionalArgs: WebRtcLiveViewTrait.StartLiveViewCommand.OptionalArgs.() -> Unit = {}): 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.
optionalArgs: WebRtcLiveViewTrait.StartLiveViewCommand.OptionalArgs.() -> Unit = {}

Receiver for the optional arguments of this command
Returns
BatchableCommand<WebRtcLiveViewTrait.StartLiveViewCommand.Response>

BatchableCommand

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