viam.gen.stream.v1.stream_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

`DESCRIPTOR`
`global___ListStreamsRequest`
`global___ListStreamsResponse`
`global___AddStreamRequest`
`global___AddStreamResponse`
`global___RemoveStreamRequest`
`global___RemoveStreamResponse`
`global___Resolution`
`global___GetStreamOptionsRequest`
`global___GetStreamOptionsResponse`
`global___SetStreamOptionsRequest`
`global___SetStreamOptionsResponse`

Classes

`ListStreamsRequest`	ListStreamsRequest requests all streams registered.
`ListStreamsResponse`	A ListStreamsResponse details streams registered.
`AddStreamRequest`	A AddStreamRequest requests the given stream be added to the connection.
`AddStreamResponse`	AddStreamResponse is returned after a successful AddStreamRequest.
`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.
`GetStreamOptionsRequest`	GetStreamOptionsRequest requests the options for a particular stream.
`GetStreamOptionsResponse`	GetStreamOptionsResponse details the options for a particular stream.
`SetStreamOptionsRequest`	SetStreamOptionsRequest sets the options for a particular stream.
`SetStreamOptionsResponse`	SetStreamOptionsResponse is returned after a successful SetStreamOptionsRequest.

Module Contents

viam.gen.stream.v1.stream_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.stream.v1.stream_pb2.ListStreamsRequest

Bases: google.protobuf.message.Message

ListStreamsRequest requests all streams registered.

viam.gen.stream.v1.stream_pb2.global___ListStreamsRequest

class viam.gen.stream.v1.stream_pb2.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]

viam.gen.stream.v1.stream_pb2.global___ListStreamsResponse

class viam.gen.stream.v1.stream_pb2.AddStreamRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

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

name: str

viam.gen.stream.v1.stream_pb2.global___AddStreamRequest

class viam.gen.stream.v1.stream_pb2.AddStreamResponse

Bases: google.protobuf.message.Message

AddStreamResponse is returned after a successful AddStreamRequest.

viam.gen.stream.v1.stream_pb2.global___AddStreamResponse

class viam.gen.stream.v1.stream_pb2.RemoveStreamRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

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

name: str

viam.gen.stream.v1.stream_pb2.global___RemoveStreamRequest

class viam.gen.stream.v1.stream_pb2.RemoveStreamResponse

Bases: google.protobuf.message.Message

RemoveStreamResponse is returned after a successful RemoveStreamRequest.

viam.gen.stream.v1.stream_pb2.global___RemoveStreamResponse

class viam.gen.stream.v1.stream_pb2.Resolution(*, width: int = ..., height: int = ...)

Bases: google.protobuf.message.Message

Resolution details the width and height of a stream.

width: int

height: int

viam.gen.stream.v1.stream_pb2.global___Resolution

class viam.gen.stream.v1.stream_pb2.GetStreamOptionsRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

GetStreamOptionsRequest requests the options for a particular stream.

name: str

viam.gen.stream.v1.stream_pb2.global___GetStreamOptionsRequest

class viam.gen.stream.v1.stream_pb2.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]

viam.gen.stream.v1.stream_pb2.global___GetStreamOptionsResponse

class viam.gen.stream.v1.stream_pb2.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.

viam.gen.stream.v1.stream_pb2.global___SetStreamOptionsRequest

class viam.gen.stream.v1.stream_pb2.SetStreamOptionsResponse

Bases: google.protobuf.message.Message

SetStreamOptionsResponse is returned after a successful SetStreamOptionsRequest.

viam.gen.stream.v1.stream_pb2.global___SetStreamOptionsResponse