vikit.video.building.handlers.music_merge_handler
=================================================

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


Overview
--------

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

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




Classes
-------

.. py:class:: MusicMergeHandler(music_to_merge: str = 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.music_merge_handler.MusicMergeHandler.execute_async>`\ (video, ml_models_gateway)
        - Generate a background music based on the prompt and merge it with the video


   .. rubric:: Members

   .. py:method:: execute_async(video, ml_models_gateway=None)
      :async:


      Generate a background music based on the prompt and merge it with the video

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

      :returns: The composite video
      :rtype: CompositeVideo