# WebRtcLiveView


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface WebRtcLiveView : WebRtcLiveViewTrait.Attributes, MatterTrait, WebRtcLiveViewCommands
```

<br />

*** ** * ** ***

API for the WebRtcLiveView trait. This trait provides the functionality to control a live view session.

> [!WARNING]
> This trait is restricted and not available for general use.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView.Attribute : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this trait's attributes. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView#supports(com.google.home.google.WebRtcLiveView.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView#supports(com.google.home.google.WebRtcLiveView.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView>` | `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveView#factory()` |

### Inherited functions

From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()` From [com.google.home.google.WebRtcLiveViewCommands](https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands) `suspend https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#changeLiveViewQuality(kotlin.String,com.google.home.google.WebRtcLiveViewTrait.QualityHint)(
mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html,
qualityHint: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.QualityHint
)`

Change the quality of a WebRTC live stream.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.ChangeLiveViewQualityCommand.Response>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#changeLiveViewQualityBatchable(kotlin.String,com.google.home.google.WebRtcLiveViewTrait.QualityHint)(
mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html,
qualityHint: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.QualityHint
)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#changeLiveViewQuality(kotlin.String,com.google.home.google.WebRtcLiveViewTrait.QualityHint)` command.
`suspend https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.ExtendLiveViewCommand.Response` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#extendLiveView(kotlin.String,kotlin.Function1)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

Extend a WebRTC live stream.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.ExtendLiveViewCommand.Response>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#extendLiveViewBatchable(kotlin.String,kotlin.Function1)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.ExtendLiveViewCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#extendLiveView(kotlin.String,kotlin.Function1)` command.
`suspend https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.StartLiveViewCommand.Response` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#startLiveView(kotlin.String,kotlin.Function1)(offerSdp: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.StartLiveViewCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

Start a WebRTC live stream.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.StartLiveViewCommand.Response>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#startLiveViewBatchable(kotlin.String,kotlin.Function1)(offerSdp: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.StartLiveViewCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#startLiveView(kotlin.String,kotlin.Function1)` command.
`suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#startTalkback(kotlin.String,kotlin.Function1)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

Start a WebRTC live stream.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#startTalkbackBatchable(kotlin.String,kotlin.Function1)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.StartTalkbackCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#startTalkback(kotlin.String,kotlin.Function1)` command.
`suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#stopLiveView(kotlin.String)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`

Stop a WebRTC live stream.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#stopLiveViewBatchable(kotlin.String)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#stopLiveView(kotlin.String)` command.
`suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#stopTalkback(kotlin.String)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`

Start a WebRTC live stream.
`https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#stopTalkbackBatchable(kotlin.String)(mediaSessionId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewCommands#stopTalkback(kotlin.String)` command.
From [com.google.home.google.WebRtcLiveViewTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes) `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi
https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#getDescriptor()()`

Returns the descriptor for the struct.
`open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi
https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)`

Returns the value of the field for the given tag ID.

### Inherited properties

From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()` From [com.google.home.google.WebRtcLiveViewTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes) `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#acceptedCommandList()`

A list of client-generated commands which are supported by this cluster server instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#attributeList()`

A list of the attribute IDs of the attributes supported by the cluster instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#clusterRevision()`

The revision of the server cluster specification supported by the cluster instance.
`https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Feature` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#featureMap()`

Whether the server supports zero or more optional cluster features.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#generatedCommandList()`

A list of server-generated commands (server to client) which are supported by this cluster server instance.
`https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.QualityHint>?` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#supportedQualityHints()`

The supported quality hints for a live view session.
`https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.TalkbackType?` `https://developers.home.google.com/reference/kotlin/com/google/home/google/WebRtcLiveViewTrait.Attributes#supportedTalkbackType()`

The current type of talkback supported by the device.

## Public functions

### supports

```
fun supports(attribute: WebRtcLiveView.Attribute): Boolean
```

### supports

```
fun supports(command: WebRtcLiveView.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<WebRtcLiveView>
```