TDLib
Loading...
Searching...
No Matches
audio Class Referencefinal

Inherits Object.

Description

Describes an audio file. Audio is usually in MP3 or M4A format.

Public Member Functions

 audio ()
 audio (int32 duration_, string const &title_, string const &performer_, string const &file_name_, string const &mime_type_, object_ptr< minithumbnail > &&album_cover_minithumbnail_, object_ptr< thumbnail > &&album_cover_thumbnail_, array< object_ptr< thumbnail > > &&external_album_covers_, object_ptr< file > &&audio_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

object_ptr< minithumbnail > album_cover_minithumbnail_
 The minithumbnail of the album cover; may be null.
object_ptr< thumbnail > album_cover_thumbnail_
 The thumbnail of the album cover in JPEG format; as defined by the sender. The full size thumbnail is expected to be extracted from the downloaded audio file; may be null.
object_ptr< file > audio_
 File containing the audio.
int32 duration_
 Duration of the audio, in seconds; as defined by the sender.
array< object_ptr< thumbnail > > external_album_covers_
 Album cover variants to use if the downloaded audio file contains no album cover. Provided thumbnail dimensions are approximate.
string file_name_
 Original name of the file; as defined by the sender.
string mime_type_
 The MIME type of the file; as defined by the sender.
string performer_
 Performer of the audio; as defined by the sender.
string title_
 Title of the audio; as defined by the sender.

Static Public Attributes

static const std::int32_t ID = -166398841
 Identifier uniquely determining a type of the object.

Constructor & Destructor Documentation

◆ audio() [1/2]

audio ( )

Describes an audio file. Audio is usually in MP3 or M4A format.

◆ audio() [2/2]

audio ( int32 duration_,
string const & title_,
string const & performer_,
string const & file_name_,
string const & mime_type_,
object_ptr< minithumbnail > && album_cover_minithumbnail_,
object_ptr< thumbnail > && album_cover_thumbnail_,
array< object_ptr< thumbnail > > && external_album_covers_,
object_ptr< file > && audio_ )

Describes an audio file. Audio is usually in MP3 or M4A format.

Parameters
[in]duration_Duration of the audio, in seconds; as defined by the sender.
[in]title_Title of the audio; as defined by the sender.
[in]performer_Performer of the audio; as defined by the sender.
[in]file_name_Original name of the file; as defined by the sender.
[in]mime_type_The MIME type of the file; as defined by the sender.
[in]album_cover_minithumbnail_The minithumbnail of the album cover; may be null.
[in]album_cover_thumbnail_The thumbnail of the album cover in JPEG format; as defined by the sender. The full size thumbnail is expected to be extracted from the downloaded audio file; may be null.
[in]external_album_covers_Album cover variants to use if the downloaded audio file contains no album cover. Provided thumbnail dimensions are approximate.
[in]audio_File containing the audio.

Member Function Documentation

◆ store()

void store ( TlStorerToString & s,
const char * field_name ) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements TlObject.


The documentation for this class was generated from the following file: