viam.proto.stream

@generated by Viam. Do not edit manually!

Classes

`StreamServiceBase`	Helper class that provides a standard way to create an ABC using
`StreamServiceStub`
`UnimplementedStreamServiceBase`	Helper class that provides a standard way to create an ABC using
`AddStreamRequest`	A AddStreamRequest requests the given stream be added to the connection.
`AddStreamResponse`	AddStreamResponse is returned after a successful AddStreamRequest.
`GetStreamOptionsRequest`	GetStreamOptionsRequest requests the options for a particular stream.
`GetStreamOptionsResponse`	GetStreamOptionsResponse details the options for a particular stream.
`ListStreamsRequest`	ListStreamsRequest requests all streams registered.
`ListStreamsResponse`	A ListStreamsResponse details streams registered.
`RemoveStreamRequest`	A RemoveStreamRequest requests the given stream be removed from the connection.
`RemoveStreamResponse`	RemoveStreamResponse is returned after a successful RemoveStreamRequest.
`Resolution`	Resolution details the width and height of a stream.
`SetStreamOptionsRequest`	SetStreamOptionsRequest sets the options for a particular stream.
`SetStreamOptionsResponse`	SetStreamOptionsResponse is returned after a successful SetStreamOptionsRequest.

Package Contents

class viam.proto.stream.StreamServiceBase[source]

Bases: abc.ABC

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

abstract ListStreams(stream: grpclib.server.Stream[stream.v1.stream_pb2.ListStreamsRequest, stream.v1.stream_pb2.ListStreamsResponse]) → None[source]

Async:

abstract AddStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.AddStreamRequest, stream.v1.stream_pb2.AddStreamResponse]) → None[source]

Async:

abstract GetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.GetStreamOptionsRequest, stream.v1.stream_pb2.GetStreamOptionsResponse]) → None[source]

Async:

abstract SetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.SetStreamOptionsRequest, stream.v1.stream_pb2.SetStreamOptionsResponse]) → None[source]

Async:

abstract RemoveStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.RemoveStreamRequest, stream.v1.stream_pb2.RemoveStreamResponse]) → None[source]

Async:

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

class viam.proto.stream.StreamServiceStub(channel: grpclib.client.Channel)[source]

ListStreams

AddStream

GetStreamOptions

SetStreamOptions

RemoveStream

class viam.proto.stream.UnimplementedStreamServiceBase[source]

Bases: StreamServiceBase

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

async ListStreams(stream: grpclib.server.Stream[stream.v1.stream_pb2.ListStreamsRequest, stream.v1.stream_pb2.ListStreamsResponse]) → None[source]

async AddStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.AddStreamRequest, stream.v1.stream_pb2.AddStreamResponse]) → None[source]

async GetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.GetStreamOptionsRequest, stream.v1.stream_pb2.GetStreamOptionsResponse]) → None[source]

async SetStreamOptions(stream: grpclib.server.Stream[stream.v1.stream_pb2.SetStreamOptionsRequest, stream.v1.stream_pb2.SetStreamOptionsResponse]) → None[source]

async RemoveStream(stream: grpclib.server.Stream[stream.v1.stream_pb2.RemoveStreamRequest, stream.v1.stream_pb2.RemoveStreamResponse]) → None[source]

class viam.proto.stream.AddStreamRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

A AddStreamRequest requests the given stream be added to the connection.

name: str

class viam.proto.stream.AddStreamResponse

Bases: google.protobuf.message.Message

AddStreamResponse is returned after a successful AddStreamRequest.

class viam.proto.stream.GetStreamOptionsRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

GetStreamOptionsRequest requests the options for a particular stream.

name: str

class viam.proto.stream.GetStreamOptionsResponse(*, resolutions: collections.abc.Iterable[global___Resolution] | None = ...)

Bases: google.protobuf.message.Message

GetStreamOptionsResponse details the options for a particular stream.

property resolutions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Resolution]

class viam.proto.stream.ListStreamsRequest

Bases: google.protobuf.message.Message

ListStreamsRequest requests all streams registered.

class viam.proto.stream.ListStreamsResponse(*, names: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

A ListStreamsResponse details streams registered.

property names: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

class viam.proto.stream.RemoveStreamRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

A RemoveStreamRequest requests the given stream be removed from the connection.

name: str

class viam.proto.stream.RemoveStreamResponse

Bases: google.protobuf.message.Message

RemoveStreamResponse is returned after a successful RemoveStreamRequest.

class viam.proto.stream.Resolution(*, width: int = ..., height: int = ...)

Bases: google.protobuf.message.Message

Resolution details the width and height of a stream.

width: int

height: int

class viam.proto.stream.SetStreamOptionsRequest(*, name: str = ..., resolution: global___Resolution | None = ...)

Bases: google.protobuf.message.Message

SetStreamOptionsRequest sets the options for a particular stream.

name: str

property resolution: global___Resolution

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, 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.stream.SetStreamOptionsResponse

Bases: google.protobuf.message.Message

SetStreamOptionsResponse is returned after a successful SetStreamOptionsRequest.