vikit.video.raw_multimodal_based_video
======================================

.. py:module:: vikit.video.raw_multimodal_based_video


Overview
--------

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

   * - :py:obj:`RawMultiModalBasedVideo <vikit.video.raw_multimodal_based_video.RawMultiModalBasedVideo>`
     - Generates a video from raw multimodal prompt, i.e. very similar to calling a mainstream video generation platform.




Classes
-------

.. py:class:: RawMultiModalBasedVideo(title: str = None, prompt: vikit.prompt.multimodal_prompt.MultiModalPrompt = None)

   Bases: :py:obj:`vikit.video.video.Video`

   Generates a video from raw multimodal prompt, i.e. very similar to calling a mainstream video generation platform.
   This is currently a small building block available in the SDK, aimed to be used when you want more control
   over the video generation process.


   .. rubric:: Overview


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

      * - :py:obj:`get_core_handlers <vikit.video.raw_multimodal_based_video.RawMultiModalBasedVideo.get_core_handlers>`\ (build_settings)
        - Get the handler chain of the video. Order matters here.
      * - :py:obj:`run_build_core_logic_hook <vikit.video.raw_multimodal_based_video.RawMultiModalBasedVideo.run_build_core_logic_hook>`\ (build_settings, ml_models_gateway)
        - Run the core logic of the video building


   .. rubric:: Members

   .. py:method:: get_core_handlers(build_settings) -> list[vikit.common.handler.Handler]

       Get the handler chain of the video. Order matters here.
       At this stage, we should already have the enhanced prompt and title for this video

      :param build_settings: The settings for building the video
      :type build_settings: VideoBuildSettings

       Returns:
           list: The list of handlers to use for building the video


   .. py:method:: run_build_core_logic_hook(build_settings: vikit.video.video_build_settings.VideoBuildSettings, ml_models_gateway)

      Run the core logic of the video building

      :param build_settings: The settings to use for building the video
      :type build_settings: VideoBuildSettings