viam.proto.rpc.webrtc.grpc

@generated by Viam. Do not edit manually!

Module Contents

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

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.

property value: global___Strings
key: str
HasField(field_name: Literal[value, b'value']) 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.

property 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).

property stream: global___Stream
property headers: global___RequestHeaders
property message: global___RequestMessage
rst_stream: bool
HasField(field_name: Literal[headers, b'headers', message, b'message', rst_stream, b'rst_stream', stream, b'stream', type, b'type']) 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: Literal[type, b'type']) Literal[headers, message, rst_stream] | 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.

property metadata: global___Metadata
property timeout: google.protobuf.duration_pb2.Duration
method: str
HasField(field_name: Literal[metadata, b'metadata', timeout, b'timeout']) 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.

property packet_message: global___PacketMessage
has_message: bool
eos: bool
HasField(field_name: Literal[packet_message, b'packet_message']) 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.

property stream: global___Stream
property headers: global___ResponseHeaders
property message: global___ResponseMessage
property trailers: global___ResponseTrailers
HasField(field_name: Literal[headers, b'headers', message, b'message', stream, b'stream', trailers, b'trailers', type, b'type']) 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: Literal[type, b'type']) Literal[headers, message, trailers] | 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).

property metadata: global___Metadata
HasField(field_name: Literal[metadata, b'metadata']) 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.

property packet_message: global___PacketMessage
HasField(field_name: Literal[packet_message, b'packet_message']) 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.

property status: google.rpc.status_pb2.Status
property metadata: global___Metadata
HasField(field_name: Literal[metadata, b'metadata', status, b'status']) 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.

property 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.

abstract async Call(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.CallRequest, proto.rpc.webrtc.v1.signaling_pb2.CallResponse]) None[source]
abstract async CallUpdate(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.CallUpdateRequest, proto.rpc.webrtc.v1.signaling_pb2.CallUpdateResponse]) None[source]
abstract async Answer(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.AnswerResponse, proto.rpc.webrtc.v1.signaling_pb2.AnswerRequest]) None[source]
abstract async OptionalWebRTCConfig(stream: grpclib.server.Stream[proto.rpc.webrtc.v1.signaling_pb2.OptionalWebRTCConfigRequest, proto.rpc.webrtc.v1.signaling_pb2.OptionalWebRTCConfigResponse]) None[source]
__mapping__() Dict[str, grpclib.const.Handler][source]
class viam.proto.rpc.webrtc.grpc.SignalingServiceStub(channel: grpclib.client.Channel)[source]