viam.proto.component.audioout

@generated by Viam. Do not edit manually!

Classes

`AudioOutServiceBase`	Helper class that provides a standard way to create an ABC using
`AudioOutServiceStub`
`UnimplementedAudioOutServiceBase`	Helper class that provides a standard way to create an ABC using
`PlayRequest`	Abstract base class for protocol messages.
`PlayResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.component.audioout.AudioOutServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract Play(stream: grpclib.server.Stream[component.audioout.v1.audioout_pb2.PlayRequest, component.audioout.v1.audioout_pb2.PlayResponse]) → None[source]

Async:

abstract GetProperties(stream: grpclib.server.Stream[common.v1.common_pb2.GetPropertiesRequest, common.v1.common_pb2.GetPropertiesResponse]) → None[source]

Async:

abstract DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

Async:

abstract GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.component.audioout.AudioOutServiceStub(channel: grpclib.client.Channel)[source]

Play

GetProperties

DoCommand

GetGeometries

class viam.proto.component.audioout.UnimplementedAudioOutServiceBase[source]

Bases: AudioOutServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async Play(stream: grpclib.server.Stream[component.audioout.v1.audioout_pb2.PlayRequest, component.audioout.v1.audioout_pb2.PlayResponse]) → None[source]

async GetProperties(stream: grpclib.server.Stream[common.v1.common_pb2.GetPropertiesRequest, common.v1.common_pb2.GetPropertiesResponse]) → None[source]

async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

async GetGeometries(stream: grpclib.server.Stream[common.v1.common_pb2.GetGeometriesRequest, common.v1.common_pb2.GetGeometriesResponse]) → None[source]

class viam.proto.component.audioout.PlayRequest(*, name: str = ..., audio_data: bytes = ..., audio_info: viam.gen.common.v1.common_pb2.AudioInfo | None = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

audio_data: bytes

property audio_info: viam.gen.common.v1.common_pb2.AudioInfo: Info describing the audio_data

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['audio_info', b'audio_info', 'extra', b'extra']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.component.audioout.PlayResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.