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)[source]¶

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

Available In

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) – Duration of the audio in seconds as defined by the sender.
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[source]¶

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

Type:: str

file_unique_id[source]¶

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[source]¶

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

Type:: int

performer[source]¶

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

Type:: str

title[source]¶

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

Type:: str

file_name[source]¶

Optional. Original filename as defined by the sender.

Type:: str

mime_type[source]¶

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

Type:: str

file_size[source]¶

Optional. File size in bytes.

Type:: int

thumbnail[source]¶

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

Added in version 20.2.

Type:: telegram.PhotoSize

__dir__()[source]¶: Default dir() implementation.

__format__(format_spec, /)[source]¶

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(value, /)[source]¶: Return self>=value.

__getattribute__(name, /)[source]¶: Return getattr(self, name).

__gt__(value, /)[source]¶: Return self>value.

classmethod __init_subclass__()[source]¶

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__(value, /)[source]¶: Return self<=value.

__lt__(value, /)[source]¶: Return self<value.

__ne__(value, /)[source]¶: Return self!=value.

classmethod __new__(*args, **kwargs)[source]¶

__reduce__()[source]¶: Helper for pickle.

__reduce_ex__(protocol, /)[source]¶: Helper for pickle.

__sizeof__()[source]¶: Size of object in memory, in bytes.

__str__()[source]¶: Return str(self).

classmethod __subclasshook__(object, /)[source]¶

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

classmethod de_json(data, bot=None)[source]¶: See telegram.TelegramObject.de_json().

async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶

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 –