vikit.postprocessing.logo.model
===============================

.. py:module:: vikit.postprocessing.logo.model


Overview
--------

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

   * - :py:obj:`LogoConfig <vikit.postprocessing.logo.model.LogoConfig>`
     - The data model for the logo




Classes
-------

.. py:class:: LogoConfig(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`

   The data model for the logo


   .. rubric:: Overview

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

      * - :py:obj:`height_size_px <vikit.postprocessing.logo.model.LogoConfig.height_size_px>`
        - \-
      * - :py:obj:`input_video_path <vikit.postprocessing.logo.model.LogoConfig.input_video_path>`
        - \-
      * - :py:obj:`logo <vikit.postprocessing.logo.model.LogoConfig.logo>`
        - \-
      * - :py:obj:`logo_height_percentage <vikit.postprocessing.logo.model.LogoConfig.logo_height_percentage>`
        - \-
      * - :py:obj:`margin_pix <vikit.postprocessing.logo.model.LogoConfig.margin_pix>`
        - \-
      * - :py:obj:`opacity <vikit.postprocessing.logo.model.LogoConfig.opacity>`
        - \-
      * - :py:obj:`output_video_name <vikit.postprocessing.logo.model.LogoConfig.output_video_name>`
        - \-
      * - :py:obj:`position <vikit.postprocessing.logo.model.LogoConfig.position>`
        - \-


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

      * - :py:obj:`validate_logo_path <vikit.postprocessing.logo.model.LogoConfig.validate_logo_path>`\ (v)
        - :summarylabel:`class` \-
      * - :py:obj:`validate_video_path <vikit.postprocessing.logo.model.LogoConfig.validate_video_path>`\ (v, info)
        - :summarylabel:`class` \-


   .. rubric:: Members

   .. py:attribute:: height_size_px
      :type:  Optional[float]

   .. py:attribute:: input_video_path
      :type:  str

   .. py:attribute:: logo
      :type:  str

   .. py:attribute:: logo_height_percentage
      :type:  Optional[int]

   .. py:attribute:: margin_pix
      :type:  Optional[int]

   .. py:attribute:: opacity
      :type:  Optional[float]

   .. py:attribute:: output_video_name
      :type:  str

   .. py:attribute:: position
      :type:  Optional[Literal['top_left', 'top_right', 'bottom_left', 'bottom_right']]

   .. py:method:: validate_logo_path(v)
      :classmethod:


   .. py:method:: validate_video_path(v, info)
      :classmethod: