payload
=======

.. py:module:: payload


Attributes
----------

.. autoapisummary::

   payload.plugin_name
   payload.out_size


Classes
-------

.. autoapisummary::

   payload.MyPlugin


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

.. py:data:: plugin_name
   :value: 'python_plugin'


.. py:data:: out_size
   :value: 0


.. py:class:: MyPlugin



   A Python based gstreamer plugin template. Enables the user to:
   - Accept incoming buffers from dynamic pads
   - Define any custom plugin runtime logic
   User has to only override the run() function


   .. py:method:: run(input_buffers: List[python_plugin_template.SimaaiPythonBuffer], output_buffer: bytes) -> None

      Define your plugin logic HERE
      Inputs:
      input_buffers List[SimaaiPythonBuffer]: List of input buffers
      Object of class SimaaiPythonBuffer has three fields:
      1. metadata MetaStruct Refer to the structure above
      2. data bytes - raw bytes of the incoming buffer
      3. size int - size of incoming buffer in bytes