# AudioOutputCommands

# AudioOutputCommands


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface AudioOutputCommands
```

<br />

Known direct subclasses [AudioOutput](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AudioOutput)

|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AudioOutput` | API for the AudioOutput trait. |

*** ** * ** ***

Commands for the AudioOutput trait.

## Summary

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AudioOutputCommands#renameOutput(kotlin.UByte,kotlin.String)(index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, name: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Rename the specified output. |
| `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/matter/standard/AudioOutputCommands#renameOutputBatchable(kotlin.UByte,kotlin.String)(index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, name: 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/matter/standard/AudioOutputCommands#renameOutput(kotlin.UByte,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/matter/standard/AudioOutputCommands#selectOutput(kotlin.UByte)(index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` Change the output on the device to the specified output. |
| `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/matter/standard/AudioOutputCommands#selectOutputBatchable(kotlin.UByte)(index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AudioOutputCommands#selectOutput(kotlin.UByte)` command. |

## Public functions

### renameOutput

```
suspend fun renameOutput(index: UByte, name: String): Unit
```

Rename the specified output.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The index of the output to rename. |
| `name: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | The new name of the specified output. |

### renameOutputBatchable

```
fun renameOutputBatchable(index: UByte, name: String): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AudioOutputCommands#renameOutput(kotlin.UByte,kotlin.String)` command.

Rename the specified output.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The index of the output to rename. |
| `name: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | The new name of the specified output. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### selectOutput

```
suspend fun selectOutput(index: UByte): Unit
```

Change the output on the device to the specified output.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The index of the output to select. |

### selectOutputBatchable

```
fun selectOutputBatchable(index: UByte): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/AudioOutputCommands#selectOutput(kotlin.UByte)` command.

Change the output on the device to the specified output.

| Parameters |
|---|---|
| `index: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The index of the output to select. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |