viam.components.audio_input.client
Module Contents
Classes
gRPC client for the AudioInput component. |
- class viam.components.audio_input.client.AudioInputClient(name: str, channel: grpclib.client.Channel)[source]
Bases:
viam.components.audio_input.audio_input.AudioInput
,viam.resource.rpc_client_base.ReconfigurableResourceRPCClientBase
gRPC client for the AudioInput component.
- async stream(*, timeout: Optional[float] = None) viam.media.MediaStream[viam.media.audio.Audio] [source]
Stream audio samples from the audio input of the underlying robot
- Returns:
The stream of audio chunks
- Return type:
- async get_properties(*, timeout: Optional[float] = None) viam.components.audio_input.audio_input.AudioInput.Properties [source]
Get the properties of the audio input of the underlying robot
- Returns:
The audio input properties
- Return type:
- async do_command(command: Mapping[str, viam.utils.ValueTypes], *, timeout: Optional[float] = None) Mapping[str, viam.utils.ValueTypes] [source]
Send/Receive arbitrary commands to the Resource
- 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]
- classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) typing_extensions.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
- classmethod get_resource_name(name: str) viam.proto.common.ResourceName
Get the ResourceName for this Resource with the given name
- Parameters:
name (str) – The name of the Resource
- 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 theOperation
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: