vikit.video.building.handlers.videogen_handler
==============================================

.. py:module:: vikit.video.building.handlers.videogen_handler


Overview
--------

.. list-table:: Classes
   :header-rows: 0
   :widths: auto
   :class: summarytable

   * - :py:obj:`VideoGenHandler <vikit.video.building.handlers.videogen_handler.VideoGenHandler>`
     - Helper class that provides a standard way to create an ABC using




Classes
-------

.. py:class:: VideoGenHandler(video_gen_build_settings: vikit.video.video.VideoBuildSettings = None)

   Bases: :py:obj:`vikit.common.handler.Handler`

   Helper class that provides a standard way to create an ABC using
   inheritance.


   .. rubric:: Overview


   .. list-table:: Methods
      :header-rows: 0
      :widths: auto
      :class: summarytable

      * - :py:obj:`execute_async <vikit.video.building.handlers.videogen_handler.VideoGenHandler.execute_async>`\ (video, ml_models_gateway)
        - Process the video generation binaries: the video binary is generated from Gen AI, hosted behind an API


   .. rubric:: Members

   .. py:method:: execute_async(video, ml_models_gateway: vikit.gateways.ML_models_gateway.MLModelsGateway)
      :async:


      Process the video generation binaries: the video binary is generated from Gen AI, hosted behind an API
      which could be distant as well as local. The video binary is then stored in a web storage or locally.

      Important: The video generation is a long process, so it is executed asynchronously. Depending on the platform
      providing it, the video generation could take a few seconds to a few minutes, and the video binary might not be
      available immediately even though a URL is returned. This is not an issue on this handler but it might
      be for subsequent handlers as they will need to reprocess the video.

      :param video: The video to process
      :type video: Video

      :returns: The video with the media URL set to the generated video