viam.proto.rpc.webrtc.grpc

@generated by Viam. Do not edit manually!

Classes

`Metadata`	Metadata is for custom key values provided by a client or server
`PacketMessage`	A PacketMessage is used to packetize large messages (> 64KiB) to be able to safely
`Request`	A Request is a frame coming from a client. It is always
`RequestHeaders`	RequestHeaders describe the unary or streaming call to make.
`RequestMessage`	A RequestMessage contains individual gRPC messages and a potential
`Response`	A Response is a frame coming from a server. It is always
`ResponseHeaders`	ResponseHeaders contain custom metadata that are sent to the client
`ResponseMessage`	ResponseMessage contains the data of a response to a call.
`ResponseTrailers`	ResponseTrailers contain the status of a response and any custom metadata.
`Stream`	A Stream represents an instance of a gRPC stream between
`Strings`	Strings are a series of values.
`SignalingServiceBase`	Helper class that provides a standard way to create an ABC using
`SignalingServiceStub`
`UnimplementedSignalingServiceBase`	Helper class that provides a standard way to create an ABC using

Module Contents

class viam.proto.rpc.webrtc.grpc.Metadata(*, md: collections.abc.Mapping[str, Global___Strings] | None = ...)

Bases: google.protobuf.message.Message

Metadata is for custom key values provided by a client or server during a stream.

class MdEntry(*, key: str = ..., value: Global___Strings | 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.

key: str

value() → Global___Strings

HasField(field_name: _HasFieldArgType) → 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.

md() → google.protobuf.internal.containers.MessageMap[str, Global___Strings]

class viam.proto.rpc.webrtc.grpc.PacketMessage(*, data: bytes = ..., eom: bool = ...)

Bases: google.protobuf.message.Message

A PacketMessage is used to packetize large messages (> 64KiB) to be able to safely transmit over WebRTC data channels.

data: bytes

eom: bool

class viam.proto.rpc.webrtc.grpc.Request(*, stream: Global___Stream | None = ..., headers: Global___RequestHeaders | None = ..., message: Global___RequestMessage | None = ..., rst_stream: bool = ...)

Bases: google.protobuf.message.Message

A Request is a frame coming from a client. It is always associated with a stream where the client assigns the stream identifier. Servers will drop frames where the stream identifier has no association (if a non-header frames are sent).

rst_stream: bool

stream() → Global___Stream

headers() → Global___RequestHeaders

message() → Global___RequestMessage

HasField(field_name: _HasFieldArgType) → 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.

WhichOneof(oneof_group: _WhichOneofArgType_type) → _WhichOneofReturnType_type | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

class viam.proto.rpc.webrtc.grpc.RequestHeaders(*, method: str = ..., metadata: Global___Metadata | None = ..., timeout: google.protobuf.duration_pb2.Duration | None = ...)

Bases: google.protobuf.message.Message

RequestHeaders describe the unary or streaming call to make.

method: str

metadata() → Global___Metadata

timeout() → google.protobuf.duration_pb2.Duration

HasField(field_name: _HasFieldArgType) → 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.rpc.webrtc.grpc.RequestMessage(*, has_message: bool = ..., packet_message: Global___PacketMessage | None = ..., eos: bool = ...)

Bases: google.protobuf.message.Message

A RequestMessage contains individual gRPC messages and a potential end-of-stream (EOS) marker.

has_message: bool

eos: bool

packet_message() → Global___PacketMessage

HasField(field_name: _HasFieldArgType) → 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.rpc.webrtc.grpc.Response(*, stream: Global___Stream | None = ..., headers: Global___ResponseHeaders | None = ..., message: Global___ResponseMessage | None = ..., trailers: Global___ResponseTrailers | None = ...)

Bases: google.protobuf.message.Message

A Response is a frame coming from a server. It is always associated with a stream where the client assigns the stream identifier. Clients will drop frames where the stream identifier has no association.

stream() → Global___Stream

headers() → Global___ResponseHeaders

message() → Global___ResponseMessage

trailers() → Global___ResponseTrailers

HasField(field_name: _HasFieldArgType) → 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.

WhichOneof(oneof_group: _WhichOneofArgType_type) → _WhichOneofReturnType_type | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

class viam.proto.rpc.webrtc.grpc.ResponseHeaders(*, metadata: Global___Metadata | None = ...)

Bases: google.protobuf.message.Message

ResponseHeaders contain custom metadata that are sent to the client before any message or trailers (unless only trailers are sent).

metadata() → Global___Metadata

HasField(field_name: _HasFieldArgType) → 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.rpc.webrtc.grpc.ResponseMessage(*, packet_message: Global___PacketMessage | None = ...)

Bases: google.protobuf.message.Message

ResponseMessage contains the data of a response to a call.

packet_message() → Global___PacketMessage

HasField(field_name: _HasFieldArgType) → 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.rpc.webrtc.grpc.ResponseTrailers(*, status: google.rpc.status_pb2.Status | None = ..., metadata: Global___Metadata | None = ...)

Bases: google.protobuf.message.Message

ResponseTrailers contain the status of a response and any custom metadata.

status() → google.rpc.status_pb2.Status

metadata() → Global___Metadata

HasField(field_name: _HasFieldArgType) → 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.rpc.webrtc.grpc.Stream(*, id: int = ...)

Bases: google.protobuf.message.Message

A Stream represents an instance of a gRPC stream between a client and a server.

id: int

class viam.proto.rpc.webrtc.grpc.Strings(*, values: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Strings are a series of values.

values() → google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.rpc.webrtc.grpc.SignalingServiceBase[source]

Bases: abc.ABC

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

abstractmethod Call(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.CallRequest, proto.rpc.webrtc.v1.signaling_pb2.CallResponse]) → None[source]

Async:

abstractmethod CallUpdate(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.CallUpdateRequest, proto.rpc.webrtc.v1.signaling_pb2.CallUpdateResponse]) → None[source]

Async:

abstractmethod Answer(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.AnswerResponse, proto.rpc.webrtc.v1.signaling_pb2.AnswerRequest]) → None[source]

Async:

abstractmethod OptionalWebRTCConfig(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.OptionalWebRTCConfigRequest, proto.rpc.webrtc.v1.signaling_pb2.OptionalWebRTCConfigResponse]) → None[source]

Async:

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

class viam.proto.rpc.webrtc.grpc.SignalingServiceStub(channel: grpclib.client.Channel)[source]

Call

CallUpdate

Answer

OptionalWebRTCConfig

class viam.proto.rpc.webrtc.grpc.UnimplementedSignalingServiceBase[source]

Bases: SignalingServiceBase

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

async Call(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.CallRequest, proto.rpc.webrtc.v1.signaling_pb2.CallResponse]) → None[source]

async CallUpdate(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.CallUpdateRequest, proto.rpc.webrtc.v1.signaling_pb2.CallUpdateResponse]) → None[source]

async Answer(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.AnswerResponse, proto.rpc.webrtc.v1.signaling_pb2.AnswerRequest]) → None[source]

async OptionalWebRTCConfig(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.OptionalWebRTCConfigRequest, proto.rpc.webrtc.v1.signaling_pb2.OptionalWebRTCConfigResponse]) → None[source]