viam.gen.service.video.v1.video_pb2

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

Attributes

DESCRIPTOR

global___GetVideoRequest

global___GetVideoResponse

Classes

GetVideoRequest

Abstract base class for protocol messages.

GetVideoResponse

Abstract base class for protocol messages.

Module Contents

viam.gen.service.video.v1.video_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class viam.gen.service.video.v1.video_pb2.GetVideoRequest(*, name: str = ..., start_timestamp: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_timestamp: google.protobuf.timestamp_pb2.Timestamp | None = ..., video_codec: str = ..., video_container: str = ..., request_id: str = ..., extra: google.protobuf.struct_pb2.Struct | 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.

name: str

Name of the video source

video_codec: str

Codec for the video retrieval (e.g., “h264”, “h265”)

video_container: str

Container format for the video retrieval (e.g., “mp4”, “fmp4”)

request_id: str

To match a request to its responses

property start_timestamp: google.protobuf.timestamp_pb2.Timestamp

Start time for the video retrieval

property end_timestamp: google.protobuf.timestamp_pb2.Timestamp

End time for the video retrieval

property extra: google.protobuf.struct_pb2.Struct

Additional arguments to the method

HasField(field_name: Literal['end_timestamp', b'end_timestamp', 'extra', b'extra', 'start_timestamp', b'start_timestamp']) 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.service.video.v1.video_pb2.global___GetVideoRequest
class viam.gen.service.video.v1.video_pb2.GetVideoResponse(*, video_data: bytes = ..., video_container: str = ..., request_id: str = ...)

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.

video_data: bytes

Video data chunk

video_container: str

Container format (e.g., “mp4”, “fmp4”)

request_id: str

Request ID to match this response to its request

viam.gen.service.video.v1.video_pb2.global___GetVideoResponse