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

Represents a video to be sent. More...

#include <InputMediaVideo.h>

Inheritance diagram for TgBot::InputMediaVideo:
TgBot::InputMedia

Public Types

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

Public Member Functions

 InputMediaVideo ()
 
- 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.
 
std::int32_t width
 Optional. Video width.
 
std::int32_t height
 Optional. Video height.
 
std::int32_t duration
 Optional. Video duration in seconds.
 
bool supportsStreaming
 Optional. Pass True if the uploaded video is suitable for streaming.
 
bool hasSpoiler
 Optional. Pass True if the video needs to be covered with a spoiler animation.
 
- 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 a video to be sent.

Definition at line 17 of file InputMediaVideo.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 21 of file InputMediaVideo.h.

Constructor & Destructor Documentation

◆ InputMediaVideo()

TgBot::InputMediaVideo::InputMediaVideo ( )
inline

Definition at line 23 of file InputMediaVideo.h.

Member Data Documentation

◆ duration

std::int32_t TgBot::InputMediaVideo::duration

Optional. Video duration in seconds.

Definition at line 51 of file InputMediaVideo.h.

◆ hasSpoiler

bool TgBot::InputMediaVideo::hasSpoiler

Optional. Pass True if the video needs to be covered with a spoiler animation.

Definition at line 61 of file InputMediaVideo.h.

◆ height

std::int32_t TgBot::InputMediaVideo::height

Optional. Video height.

Definition at line 46 of file InputMediaVideo.h.

◆ supportsStreaming

bool TgBot::InputMediaVideo::supportsStreaming

Optional. Pass True if the uploaded video is suitable for streaming.

Definition at line 56 of file InputMediaVideo.h.

◆ thumbnail

std::string TgBot::InputMediaVideo::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 36 of file InputMediaVideo.h.

◆ TYPE

const std::string TgBot::InputMediaVideo::TYPE
static

Definition at line 19 of file InputMediaVideo.h.

◆ width

std::int32_t TgBot::InputMediaVideo::width

Optional. Video width.

Definition at line 41 of file InputMediaVideo.h.


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