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

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

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<Animation>

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 the sender.
std::int32_t height { }
 Video height as defined by the sender.
std::int32_t duration { }
 Duration of the video in seconds as defined by the sender.
std::shared_ptr< PhotoSizethumbnail { }
 Optional. Animation thumbnail as defined by the sender.
std::optional< std::string > fileName { }
 Optional. Original animation filename as defined by the sender.
std::optional< std::string > mimeType { }
 Optional. MIME type of the file as defined by the sender.
std::optional< std::int64_t > 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.

Detailed Description

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

Definition at line 486 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::Animation::Ptr = std::shared_ptr<Animation>

Definition at line 487 of file Types.h.

Member Data Documentation

◆ duration

std::int32_t TgBot::Animation::duration { }

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

Definition at line 513 of file Types.h.

◆ fileId

std::string TgBot::Animation::fileId { }

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

Definition at line 492 of file Types.h.

◆ fileName

std::optional<std::string> TgBot::Animation::fileName { }

Optional. Original animation filename as defined by the sender.

Definition at line 523 of file Types.h.

◆ fileSize

std::optional<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 536 of file Types.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 498 of file Types.h.

◆ height

std::int32_t TgBot::Animation::height { }

Video height as defined by the sender.

Definition at line 508 of file Types.h.

◆ mimeType

std::optional<std::string> TgBot::Animation::mimeType { }

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

Definition at line 528 of file Types.h.

◆ thumbnail

std::shared_ptr<PhotoSize> TgBot::Animation::thumbnail { }

Optional. Animation thumbnail as defined by the sender.

Definition at line 518 of file Types.h.

◆ width

std::int32_t TgBot::Animation::width { }

Video width as defined by the sender.

Definition at line 503 of file Types.h.


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