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

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). More...

#include <Animation.h>

Public Types

typedef std::shared_ptr< AnimationPtr
 

Public Attributes

std::string fileId
 Identifier for this file, which can be used to download or reuse the file.
 
std::string fileUniqueId
 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.
 
std::int32_t width
 Video width as defined by sender.
 
std::int32_t height
 Video height as defined by sender.
 
std::int32_t duration
 Duration of the video in seconds as defined by sender.
 
PhotoSize::Ptr thumb
 Optional. Animation thumbnail as defined by sender.
 
std::string fileName
 Optional. Original animation filename as defined by sender.
 
std::string mimeType
 Optional. MIME type of the file as defined by sender.
 
std::int64_t fileSize
 Optional. File size in bytes.
 

Detailed Description

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).

Definition at line 17 of file Animation.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 19 of file Animation.h.

Member Data Documentation

◆ duration

std::int32_t TgBot::Animation::duration

Duration of the video in seconds as defined by sender.

Definition at line 45 of file Animation.h.

◆ fileId

std::string TgBot::Animation::fileId

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

Definition at line 24 of file Animation.h.

◆ fileName

std::string TgBot::Animation::fileName

Optional. Original animation filename as defined by sender.

Definition at line 55 of file Animation.h.

◆ fileSize

std::int64_t TgBot::Animation::fileSize

Optional. File size in bytes.

It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Definition at line 68 of file Animation.h.

◆ fileUniqueId

std::string TgBot::Animation::fileUniqueId

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.

Definition at line 30 of file Animation.h.

◆ height

std::int32_t TgBot::Animation::height

Video height as defined by sender.

Definition at line 40 of file Animation.h.

◆ mimeType

std::string TgBot::Animation::mimeType

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

Definition at line 60 of file Animation.h.

◆ thumb

PhotoSize::Ptr TgBot::Animation::thumb

Optional. Animation thumbnail as defined by sender.

Definition at line 50 of file Animation.h.

◆ width

std::int32_t TgBot::Animation::width

Video width as defined by sender.

Definition at line 35 of file Animation.h.


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