viam.gen.service.video.v1.video_pb2
===================================

.. py:module:: viam.gen.service.video.v1.video_pb2

.. autoapi-nested-parse::

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



Attributes
----------

.. autoapisummary::

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


Classes
-------

.. autoapisummary::

   viam.gen.service.video.v1.video_pb2.GetVideoRequest
   viam.gen.service.video.v1.video_pb2.GetVideoResponse


Module Contents
---------------

.. py:data:: DESCRIPTOR
   :type:  google.protobuf.descriptor.FileDescriptor

.. py:class:: 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: :py:obj:`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.


   .. py:attribute:: name
      :type:  str

      Name of the video source


   .. py:attribute:: video_codec
      :type:  str

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


   .. py:attribute:: video_container
      :type:  str

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


   .. py:attribute:: request_id
      :type:  str

      To match a request to its responses


   .. py:property:: start_timestamp
      :type: google.protobuf.timestamp_pb2.Timestamp

      Start time for the video retrieval


   .. py:property:: end_timestamp
      :type: google.protobuf.timestamp_pb2.Timestamp

      End time for the video retrieval


   .. py:property:: extra
      :type: google.protobuf.struct_pb2.Struct

      Additional arguments to the method


   .. py: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, :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:data:: global___GetVideoRequest

.. py:class:: GetVideoResponse(*, video_data: bytes = ..., video_container: str = ..., request_id: str = ...)

   Bases: :py:obj:`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.


   .. py:attribute:: video_data
      :type:  bytes

      Video data chunk


   .. py:attribute:: video_container
      :type:  str

      Container format (e.g., "mp4", "fmp4")


   .. py:attribute:: request_id
      :type:  str

      Request ID to match this response to its request


.. py:data:: global___GetVideoResponse