Skip to content
Back to top
View this page

# Audio

class telegram.Audio(file_id, file_unique_id, duration, performer=None, title=None, mime_type=None, file_size=None, file_name=None, thumbnail=None, *, api_kwargs=None)

  Bases: `telegram.TelegramObject`

  This object represents an audio file to be treated as music by the Telegram clients.

  Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their `file_unique_id` is equal.

  Use In

  - `telegram.Bot.get_file()`

  - `telegram.Bot.send_audio()`

  Available In

  - `telegram.ExternalReplyInfo.audio`

  - `telegram.InputMediaAudio.media`

  - `telegram.Message.audio`

  - `telegram.Message.effective_attachment`

  Changed in version 20.5: Removed the deprecated argument and attribute `thumb`.

  Parameters:

    - file_id (`str`) – Identifier for this file, which can be used to download or reuse the file.

    - file_unique_id (`str`) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

    - duration (`int` | `datetime.timedelta`) –

      Duration of the audio in seconds as defined by the sender.

      Changed in version v22.2: `datetime.timedelta` objects are accepted in addition to plain `int` values.

    - performer (`str`, optional) – Performer of the audio as defined by the sender or by audio tags.

    - title (`str`, optional) – Title of the audio as defined by the sender or by audio tags.

    - file_name (`str`, optional) – Original filename as defined by the sender.

    - mime_type (`str`, optional) – MIME type of the file as defined by the sender.

    - file_size (`int`, optional) – File size in bytes.

    - thumbnail (`telegram.PhotoSize`, optional) –

      Thumbnail of the album cover to which the music file belongs.

      Added in version 20.2.

  file_id

    Identifier for this file, which can be used to download or reuse the file.

    Type:

      `str`

  file_unique_id

    Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

    Type:

      `str`

  duration

    Duration of the audio in seconds as defined by the sender.

    Deprecated since version v22.2: In a future major version this attribute will be of type `datetime.timedelta`. You can opt-in early by setting PTB_TIMEDELTA=true or `PTB_TIMEDELTA=1` as an environment variable.

    Type:

      `int` | `datetime.timedelta`

  performer

    Optional. Performer of the audio as defined by the sender or by audio tags.

    Type:

      `str`

  title

    Optional. Title of the audio as defined by the sender or by audio tags.

    Type:

      `str`

  file_name

    Optional. Original filename as defined by the sender.

    Type:

      `str`

  mime_type

    Optional. MIME type of the file as defined by the sender.

    Type:

      `str`

  file_size

    Optional. File size in bytes.

    Type:

      `int`

  thumbnail

    Optional. Thumbnail of the album cover to which the music file belongs.

    Added in version 20.2.

    Type:

      `telegram.PhotoSize`

  classmethod de_json(data, bot=None)

    See `telegram.TelegramObject.de_json()`.

  async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)

    Convenience wrapper over `telegram.Bot.get_file()`

    For the documentation of the arguments, please see `telegram.Bot.get_file()`.

    Returns:

      `telegram.File`

    Raises:

      telegram.error.TelegramError –