tgbot-cpp
Loading...
Searching...
No Matches
TgBot::InputMediaAudio Class Reference

Represents an audio file to be treated as music to be sent. More...

#include <InputMediaAudio.h>

Inheritance diagram for TgBot::InputMediaAudio:
TgBot::InputMedia

Public Types

typedef std::shared_ptr< InputMediaAudioPtr
 
- Public Types inherited from TgBot::InputMedia
typedef std::shared_ptr< InputMediaPtr
 

Public Member Functions

 InputMediaAudio ()
 
- Public Member Functions inherited from TgBot::InputMedia
 InputMedia ()
 
virtual ~InputMedia ()
 

Public Attributes

std::string thumbnail
 Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. https://core.telegram.org/bots/api#sending-files.
 
std::int32_t duration
 Optional. Duration of the audio in seconds.
 
std::string performer
 Optional. Performer of the audio.
 
std::string title
 Optional. Title of the audio.
 
- Public Attributes inherited from TgBot::InputMedia
std::string type
 Type of the result.
 
std::string media
 File to send.
 
std::string caption
 Optional. Caption of the media to be sent, 0-1024 characters after entities parsing.
 
std::string parseMode
 Optional. Mode for parsing entities in the media caption.
 
std::vector< MessageEntity::PtrcaptionEntities
 Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.
 

Static Public Attributes

static const std::string TYPE
 

Detailed Description

Represents an audio file to be treated as music to be sent.

Definition at line 16 of file InputMediaAudio.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<InputMediaAudio> TgBot::InputMediaAudio::Ptr

Definition at line 21 of file InputMediaAudio.h.

Constructor & Destructor Documentation

◆ InputMediaAudio()

TgBot::InputMediaAudio::InputMediaAudio ( )
inline

Definition at line 23 of file InputMediaAudio.h.

Member Data Documentation

◆ duration

std::int32_t TgBot::InputMediaAudio::duration

Optional. Duration of the audio in seconds.

Definition at line 40 of file InputMediaAudio.h.

◆ performer

std::string TgBot::InputMediaAudio::performer

Optional. Performer of the audio.

Definition at line 45 of file InputMediaAudio.h.

◆ thumbnail

std::string TgBot::InputMediaAudio::thumbnail

Optional. Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. https://core.telegram.org/bots/api#sending-files.

Definition at line 35 of file InputMediaAudio.h.

◆ title

std::string TgBot::InputMediaAudio::title

Optional. Title of the audio.

Definition at line 50 of file InputMediaAudio.h.

◆ TYPE

const std::string TgBot::InputMediaAudio::TYPE
static

Definition at line 19 of file InputMediaAudio.h.


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