viam.components.audio_out

Submodules

Classes

`AudioCodec`	Common audio codec identifiers.
`AudioInfo`	Information about an audio stream or device.
`AudioOut`	AudioOut represents a component that can play audio.

Package Contents

class viam.components.audio_out.AudioCodec[source]

Bases: str, enum.Enum

Common audio codec identifiers.

These constants represent commonly supported audio codecs for audioin and audioout components.

Example:

from viam.components.codecs import AudioCodec
from viam.proto.common import AudioInfo

audio_info = AudioInfo(
    codec=AudioCodec.PCM16,
    sample_rate_hz=44100,
    num_channels=2
)

PCM16 = 'pcm16'

PCM32 = 'pcm32'

PCM32_FLOAT = 'pcm32_float'

MP3 = 'mp3'

AAC = 'aac'

OPUS = 'opus'

FLAC = 'flac'

class viam.components.audio_out.AudioInfo(*, codec: str = ..., sample_rate_hz: int = ..., num_channels: int = ...)

Bases: google.protobuf.message.Message

Information about an audio stream or device.

codec: str: Audio codec used for the stream or device (e.g., “pcm16”, “pcm32float”, “mp3”)

sample_rate_hz: int: Sample rate of the audio in Hz

num_channels: int: Number of audio channels in the recording or playback

class viam.components.audio_out.AudioOut(name: str, *, logger: logging.Logger | None = None)[source]

Bases: viam.components.component_base.ComponentBase

AudioOut represents a component that can play audio.

This acts as an abstract base class for any drivers representing specific audio output implementations. This cannot be used on its own. If the __init__() function is overridden, it must call the super().__init__() function.

API: Final: The API of the Resource

type Properties = GetPropertiesResponse

abstractmethod play(data: bytes, info: viam.components.audio_out.AudioInfo | None = None, *, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → None[source]

Async:

Play the given audio data.

my_audio_out = AudioOut.from_robot(robot=machine, name="my_audio_out")

# With audio info
audio_info = AudioInfo(codec=AudioCodec.PCM16, sample_rate_hz=44100, num_channels=2)
await my_audio_out.play(audio_data, audio_info)

# Without audio info (when codec encodes information within audio_data)
await my_audio_out.play(audio_data)

Parameters:

data – audio bytes to play
info – (optional) information about the audio data such as codec, sample rate, and channel count

abstractmethod play_stream(info: viam.components.audio_out.AudioInfo, chunks: AsyncIterable[bytes], *, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → None[source]

Async:

Stream audio chunks to the audio output device for playback.

The caller provides an async iterable of raw audio bytes. Each chunk must match the codec and format described by info. Implementations consume the iterable until it is exhausted, playing chunks as they arrive.

async def chunk_source():
    for chunk in pcm_chunks:
        yield chunk

audio_info = AudioInfo(codec="pcm16", sample_rate_hz=22050, num_channels=1)
await my_audio_out.play_stream(audio_info, chunk_source())

Parameters:

info – information about the audio stream such as codec, sample rate, and channel count
chunks – async iterable of audio bytes to play in order

abstractmethod get_properties(*, extra: Dict[str, Any] | None = None, timeout: float | None = None, **kwargs) → Properties[source]

Async:

Get the audio output device’s properties.

my_audio_out = AudioOut.from_robot(robot=machine, name="my_audio_out")
properties = await my_audio_out.get_properties()

Returns:: The properties of the audio output device
Return type:: Properties

classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) → Self

Get the component named name from the provided robot.

Parameters:

robot (RobotClient) – The robot
name (str) – The name of the component

Returns:

The component, if it exists on the robot

Return type:

Self

abstractmethod do_command(command: Mapping[str, ValueTypes], *, timeout: float | None = None, **kwargs) → Mapping[str, ValueTypes]

Async:

Send/Receive arbitrary commands to the Resource

command = {"cmd": "test", "data1": 500}
result = await component.do_command(command)

Parameters:: command (Mapping[str, ValueTypes]) – The command to execute
Raises:: NotImplementedError – Raised if the Resource does not support arbitrary commands
Returns:: Result of the executed command
Return type:: Mapping[str, ValueTypes]

async get_geometries(*, extra: Dict[str, Any] | None = None, timeout: float | None = None) → Sequence[viam.proto.common.Geometry]

Get all geometries associated with the component, in their current configuration, in the frame of the component.

geometries = await component.get_geometries()

if geometries:
    # Get the center of the first geometry
    print(f"Pose of the first geometry's centerpoint: {geometries[0].center}")

Returns:: The geometries associated with the Component.
Return type:: List[Geometry]

classmethod get_resource_name(name: str) → viam.proto.common.ResourceName

Get the ResourceName for this Resource with the given name

# Can be used with any resource, using an arm as an example
my_arm_name = Arm.get_resource_name("my_arm")

Parameters:: name (str) – The name of the Resource
Returns:: The ResourceName of this Resource
Return type:: ResourceName

get_operation(kwargs: Mapping[str, Any]) → viam.operations.Operation

Get the Operation associated with the currently running function.

When writing custom resources, you should get the Operation by calling this function and check to see if it’s cancelled. If the Operation is cancelled, then you can perform any necessary (terminating long running tasks, cleaning up connections, etc. ).

Parameters:: kwargs (Mapping[str, Any]) – The kwargs object containing the operation
Returns:: The operation associated with this function
Return type:: viam.operations.Operation

async close()

Safely shut down the resource and prevent further use.

Close must be idempotent. Later configuration may allow a resource to be “open” again. If a resource does not want or need a close function, it is assumed that the resource does not need to return errors when future non-Close methods are called.

await component.close()