Volume

@Generated(value = ["GoogleHomePlatformCodegen"])
interface Volume : VolumeTrait.Attributes, MatterTrait, VolumeCommands


API for the Volume trait. This trait provides a volume extension to the LevelControl trait and is only for use with the Automation API.

Summary

Nested types

Descriptor enum for this trait's attributes.

Descriptor enum for this trait's commands.

Public functions

Boolean
Boolean

Public properties

open TraitFactory<Volume>

Inherited functions

From com.google.home.TraitStateInvalidation
suspend Unit
From com.google.home.google.VolumeCommands
suspend Unit
moveToVolume(volumePercent: UByte)

Move the volume of the device to the specified volume.

BatchableCommand<Unit>
moveToVolumeBatchable(volumePercent: UByte)

The batchable version of moveToVolume command.

suspend Unit

Mutes the device.

BatchableCommand<Unit>

The batchable version of mute command.

suspend Unit

Unmutes the device and sets the volume to the last non-zero volume.

BatchableCommand<Unit>

The batchable version of unmute command.

suspend Unit

Incremental step volume.

BatchableCommand<Unit>
volumeStepBatchable(
    stepMode: VolumeTrait.VolumeStepModeEnum,
    step: UByte
)

The batchable version of volumeStep command.

Inherited properties

From com.google.home.Trait
From com.google.home.google.VolumeTrait.Attributes
List<UInt>

A list of client-generated commands which are supported by this cluster server instance.

List<UInt>

A list of the attribute IDs of the attributes supported by the cluster instance.

UShort

The revision of the server cluster specification supported by the cluster instance.

UByte?

The current volume percentage setting in the range of 0 to 100.

UInt

Whether the server supports zero or more optional cluster features.

List<UInt>

A list of server-generated commands (server to client) which are supported by this cluster server instance.

Boolean?

Whether or not the speaker is muted.

Public functions

supports

fun supports(attribute: Volume.Attribute): Boolean

supports

fun supports(command: Volume.Command): Boolean

Public properties

factory

open val factoryTraitFactory<Volume>