viam.proto.stream ================= .. py:module:: viam.proto.stream .. autoapi-nested-parse:: @generated by Viam. Do not edit manually! Classes ------- .. autoapisummary:: viam.proto.stream.StreamServiceBase viam.proto.stream.StreamServiceStub viam.proto.stream.UnimplementedStreamServiceBase viam.proto.stream.AddStreamRequest viam.proto.stream.AddStreamResponse viam.proto.stream.GetStreamOptionsRequest viam.proto.stream.GetStreamOptionsResponse viam.proto.stream.ListStreamsRequest viam.proto.stream.ListStreamsResponse viam.proto.stream.RemoveStreamRequest viam.proto.stream.RemoveStreamResponse viam.proto.stream.Resolution viam.proto.stream.SetStreamOptionsRequest viam.proto.stream.SetStreamOptionsResponse Package Contents ---------------- .. py:class:: StreamServiceBase Bases: :py:obj:`abc.ABC` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: ListStreams(stream: grpclib.server.Stream[stream.v1.stream_pb2.ListStreamsRequest, stream.v1.stream_pb2.ListStreamsResponse]) -> None :abstractmethod: :async: .. py:method:: AddStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.AddStreamRequest, stream.v1.stream_pb2.AddStreamResponse]) -> None :abstractmethod: :async: .. py:method:: GetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.GetStreamOptionsRequest, stream.v1.stream_pb2.GetStreamOptionsResponse]) -> None :abstractmethod: :async: .. py:method:: SetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.SetStreamOptionsRequest, stream.v1.stream_pb2.SetStreamOptionsResponse]) -> None :abstractmethod: :async: .. py:method:: RemoveStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.RemoveStreamRequest, stream.v1.stream_pb2.RemoveStreamResponse]) -> None :abstractmethod: :async: .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler] .. py:class:: StreamServiceStub(channel: grpclib.client.Channel) .. py:attribute:: ListStreams .. py:attribute:: AddStream .. py:attribute:: GetStreamOptions .. py:attribute:: SetStreamOptions .. py:attribute:: RemoveStream .. py:class:: UnimplementedStreamServiceBase Bases: :py:obj:`StreamServiceBase` Helper class that provides a standard way to create an ABC using inheritance. .. py:method:: ListStreams(stream: grpclib.server.Stream[stream.v1.stream_pb2.ListStreamsRequest, stream.v1.stream_pb2.ListStreamsResponse]) -> None :async: .. py:method:: AddStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.AddStreamRequest, stream.v1.stream_pb2.AddStreamResponse]) -> None :async: .. py:method:: GetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.GetStreamOptionsRequest, stream.v1.stream_pb2.GetStreamOptionsResponse]) -> None :async: .. py:method:: SetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.SetStreamOptionsRequest, stream.v1.stream_pb2.SetStreamOptionsResponse]) -> None :async: .. py:method:: RemoveStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.RemoveStreamRequest, stream.v1.stream_pb2.RemoveStreamResponse]) -> None :async: .. py:class:: AddStreamRequest(*, name: str = ...) Bases: :py:obj:`google.protobuf.message.Message` A AddStreamRequest requests the given stream be added to the connection. .. py:attribute:: name :type: str .. py:class:: AddStreamResponse Bases: :py:obj:`google.protobuf.message.Message` AddStreamResponse is returned after a successful AddStreamRequest. .. py:class:: GetStreamOptionsRequest(*, name: str = ...) Bases: :py:obj:`google.protobuf.message.Message` GetStreamOptionsRequest requests the options for a particular stream. .. py:attribute:: name :type: str .. py:class:: GetStreamOptionsResponse(*, resolutions: collections.abc.Iterable[global___Resolution] | None = ...) Bases: :py:obj:`google.protobuf.message.Message` GetStreamOptionsResponse details the options for a particular stream. .. py:property:: resolutions :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Resolution] .. py:class:: ListStreamsRequest Bases: :py:obj:`google.protobuf.message.Message` ListStreamsRequest requests all streams registered. .. py:class:: ListStreamsResponse(*, names: collections.abc.Iterable[str] | None = ...) Bases: :py:obj:`google.protobuf.message.Message` A ListStreamsResponse details streams registered. .. py:property:: names :type: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:class:: RemoveStreamRequest(*, name: str = ...) Bases: :py:obj:`google.protobuf.message.Message` A RemoveStreamRequest requests the given stream be removed from the connection. .. py:attribute:: name :type: str .. py:class:: RemoveStreamResponse Bases: :py:obj:`google.protobuf.message.Message` RemoveStreamResponse is returned after a successful RemoveStreamRequest. .. py:class:: Resolution(*, width: int = ..., height: int = ...) Bases: :py:obj:`google.protobuf.message.Message` Resolution details the width and height of a stream. .. py:attribute:: width :type: int .. py:attribute:: height :type: int .. py:class:: SetStreamOptionsRequest(*, name: str = ..., resolution: global___Resolution | None = ...) Bases: :py:obj:`google.protobuf.message.Message` SetStreamOptionsRequest sets the options for a particular stream. .. py:attribute:: name :type: str .. py:property:: resolution :type: global___Resolution .. py:method:: HasField(field_name: Literal['resolution', b'resolution']) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:class:: SetStreamOptionsResponse Bases: :py:obj:`google.protobuf.message.Message` SetStreamOptionsResponse is returned after a successful SetStreamOptionsRequest.