vikit.video.prompt_based_video
==============================

.. py:module:: vikit.video.prompt_based_video


Overview
--------

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

   * - :py:obj:`PromptBasedVideo <vikit.video.prompt_based_video.PromptBasedVideo>`
     - PromptBasedVideo is a simple way to generate a video based out of a text prompt




Classes
-------

.. py:class:: PromptBasedVideo(prompt: vikit.prompt.prompt.Prompt = None)

   Bases: :py:obj:`vikit.video.composite_video.CompositeVideo`

   PromptBasedVideo is a simple way to generate a video based out of a text prompt

   It creates a master composite video which embeds as many composite video as there are subtitles
   in the given prompt.

   We do some form of inheritance by composition to prevent circular dependencies and benefit from more modularity


   .. rubric:: Overview


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

      * - :py:obj:`compose <vikit.video.prompt_based_video.PromptBasedVideo.compose>`\ (build_settings, ml_models_gateway)
        - Compose the inner composite video
      * - :py:obj:`get_title <vikit.video.prompt_based_video.PromptBasedVideo.get_title>`\ ()
        - Get the title of the video, we recompute it every time
      * - :py:obj:`prepare_build <vikit.video.prompt_based_video.PromptBasedVideo.prepare_build>`\ (ml_models_gateway, build_settings)
        - Generate the actual inner video


   .. rubric:: Members

   .. py:method:: compose(build_settings: vikit.video.video.VideoBuildSettings, ml_models_gateway)
      :async:


      Compose the inner composite video

      Params:
          - build_settings: allow some customization

      :returns: The inner composite video


   .. py:method:: get_title()

      Get the title of the video, we recompute it every time
      as the title of the video can change if we add or remove videos


   .. py:method:: prepare_build(ml_models_gateway: vikit.gateways.ML_models_gateway.MLModelsGateway, build_settings=VideoBuildSettings())
      :async:


      Generate the actual inner video

      Params:
          - build_settings: allow some customization

      :returns: The current instance