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.

type viam.gen.stream.v1.stream_pb2.Global___ListStreamsRequest = 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.

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

type viam.gen.stream.v1.stream_pb2.Global___ListStreamsResponse = 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

type viam.gen.stream.v1.stream_pb2.Global___AddStreamRequest = AddStreamRequest

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

Bases: google.protobuf.message.Message

AddStreamResponse is returned after a successful AddStreamRequest.

type viam.gen.stream.v1.stream_pb2.Global___AddStreamResponse = 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

type viam.gen.stream.v1.stream_pb2.Global___RemoveStreamRequest = RemoveStreamRequest

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

Bases: google.protobuf.message.Message

RemoveStreamResponse is returned after a successful RemoveStreamRequest.

type viam.gen.stream.v1.stream_pb2.Global___RemoveStreamResponse = 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

type viam.gen.stream.v1.stream_pb2.Global___Resolution = 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

type viam.gen.stream.v1.stream_pb2.Global___GetStreamOptionsRequest = 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.

resolutions() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___Resolution]

type viam.gen.stream.v1.stream_pb2.Global___GetStreamOptionsResponse = 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

resolution() → Global___Resolution

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.

type viam.gen.stream.v1.stream_pb2.Global___SetStreamOptionsRequest = SetStreamOptionsRequest

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

Bases: google.protobuf.message.Message

SetStreamOptionsResponse is returned after a successful SetStreamOptionsRequest.

type viam.gen.stream.v1.stream_pb2.Global___SetStreamOptionsResponse = SetStreamOptionsResponse