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

This object represents a video file. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<Video>

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< PhotoSize > thumbnail { }
 Optional. Video thumbnail.
std::optional< std::vector< std::shared_ptr< PhotoSize > > > cover { }
 Optional. Available sizes of the cover of the video in the message.
std::optional< std::int32_t > startTimestamp { }
 Optional. Timestamp in seconds from which the video will play in the message.
std::optional< std::vector< std::shared_ptr< VideoQuality > > > qualities { }
 Optional. List of available qualities of the video.
std::optional< std::string > fileName { }
 Optional. Original 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 a video file.

Definition at line 14023 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 14024 of file Types.h.

Member Data Documentation

◆ cover

std::optional<std::vector<std::shared_ptr<PhotoSize> > > TgBot::Video::cover { }

Optional. Available sizes of the cover of the video in the message.

Definition at line 14054 of file Types.h.

◆ duration

std::int32_t TgBot::Video::duration { }

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

Definition at line 14046 of file Types.h.

◆ fileId

std::string TgBot::Video::fileId { }

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

Definition at line 14029 of file Types.h.

◆ fileName

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

Optional. Original filename as defined by the sender.

Definition at line 14066 of file Types.h.

◆ fileSize

std::optional<std::int64_t> TgBot::Video::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 14077 of file Types.h.

◆ fileUniqueId

std::string TgBot::Video::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 14034 of file Types.h.

◆ height

std::int32_t TgBot::Video::height { }

Video height as defined by the sender.

Definition at line 14042 of file Types.h.

◆ mimeType

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

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

Definition at line 14070 of file Types.h.

◆ qualities

std::optional<std::vector<std::shared_ptr<VideoQuality> > > TgBot::Video::qualities { }

Optional. List of available qualities of the video.

Definition at line 14062 of file Types.h.

◆ startTimestamp

std::optional<std::int32_t> TgBot::Video::startTimestamp { }

Optional. Timestamp in seconds from which the video will play in the message.

Definition at line 14058 of file Types.h.

◆ thumbnail

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

Optional. Video thumbnail.

Definition at line 14050 of file Types.h.

◆ width

std::int32_t TgBot::Video::width { }

Video width as defined by the sender.

Definition at line 14038 of file Types.h.


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