ytmusicapi.models package
*************************


Subpackages
===========

* ytmusicapi.models.content package

  * Submodules

  * ytmusicapi.models.content.TextRun module

    * "HyperLink"

      * "HyperLink.text"

      * "HyperLink.url"

    * "PlainText"

      * "PlainText.text"

  * ytmusicapi.models.content.enums module

    * "LikeStatus"

      * "LikeStatus.DISLIKE"

      * "LikeStatus.INDIFFERENT"

      * "LikeStatus.LIKE"

    * "PlaylistSortOrder"

      * "PlaylistSortOrder.MANUAL"

      * "PlaylistSortOrder.NEWEST_FIRST"

      * "PlaylistSortOrder.NEWEST_LAST"

      * "PlaylistSortOrder.TOP_VOTED"

    * "PlaylistVoteEditOptions"

      * "PlaylistVoteEditOptions.COLLABORATORS_ONLY"

      * "PlaylistVoteEditOptions.EVERYONE_CAN_VOTE"

      * "PlaylistVoteEditOptions.OFF"

      * "PlaylistVoteEditOptions.get_argument_for_request()"

    * "PrivacyStatus"

      * "PrivacyStatus.PRIVATE"

      * "PrivacyStatus.PUBLIC"

      * "PrivacyStatus.UNLISTED"

    * "VideoType"

      * "VideoType.ATV"

      * "VideoType.OFFICIAL_SOURCE_MUSIC"

      * "VideoType.OMV"

      * "VideoType.UGC"

    * "VoteStatus"

      * "VoteStatus.DOWNVOTED"

      * "VoteStatus.UNSPECIFIED"

      * "VoteStatus.UPVOTED"

  * Module contents


Submodules
==========


ytmusicapi.models.lyrics module
===============================

class ytmusicapi.models.lyrics.LyricLine(text: str, start_time: int, end_time: int, id: int) -> None

   Bases: "object"

   Represents a line of lyrics with timestamps (in milliseconds).

   Parameters:
      * **(****str****)** (*text*) -- The Songtext.

      * **(****int****)** (*id*) -- Begin of the lyric in
        milliseconds.

      * **(****int****)** -- End of the lyric in milliseconds.

      * **(****int****)** -- A Metadata-Id that probably uniquely
        identifies each lyric line.

   end_time: int

   classmethod from_raw(raw_lyric: dict[str, Any]) -> LyricLine

      Converts lyrics in the format from the api to a more reasonable
      format

      Parameters:
         **raw_lyric** ("dict"["str", "Any"]) -- The raw lyric-data
         returned by the mobile api.

      Return LyricLine:
         A *LyricLine*

      Return type:
         "LyricLine"

   id: int

   start_time: int

   text: str

class ytmusicapi.models.lyrics.Lyrics

   Bases: "TypedDict"

   hasTimestamps: Literal[False]

   lyrics: str

   source: str | None

class ytmusicapi.models.lyrics.TimedLyrics

   Bases: "TypedDict"

   hasTimestamps: Literal[True]

   lyrics: list[LyricLine]

   source: str | None


Module contents
===============

class ytmusicapi.models.LyricLine(text: str, start_time: int, end_time: int, id: int) -> None

   Bases: "object"

   Represents a line of lyrics with timestamps (in milliseconds).

   Parameters:
      * **(****str****)** (*text*) -- The Songtext.

      * **(****int****)** (*id*) -- Begin of the lyric in
        milliseconds.

      * **(****int****)** -- End of the lyric in milliseconds.

      * **(****int****)** -- A Metadata-Id that probably uniquely
        identifies each lyric line.

   end_time: int

   classmethod from_raw(raw_lyric: dict[str, Any]) -> LyricLine

      Converts lyrics in the format from the api to a more reasonable
      format

      Parameters:
         **raw_lyric** ("dict"["str", "Any"]) -- The raw lyric-data
         returned by the mobile api.

      Return LyricLine:
         A *LyricLine*

      Return type:
         "LyricLine"

   id: int

   start_time: int

   text: str

class ytmusicapi.models.Lyrics

   Bases: "TypedDict"

   hasTimestamps: Literal[False]

   lyrics: str

   source: str | None

class ytmusicapi.models.TimedLyrics

   Bases: "TypedDict"

   hasTimestamps: Literal[True]

   lyrics: list[LyricLine]

   source: str | None
