This object represents a video file. https://core.telegram.org/bots/api#video. More...

#include <Video.hpp>

Public Member Functions
	Video ()=default

	Video (const nl::json &json)

nl::json	toJson () const
	Serializes this object to JSON.

void	fromJson (const nl::json &json)
	Deserializes this object from JSON.

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.

Ptr< PhotoSize >	thumbnail
	Optional. Video thumbnail.

std::vector< Ptr< PhotoSize > >	cover
	Optional. Available sizes of the cover of the video in the message.

std::time_t	startTimestamp {}
	Optional. Timestamp in seconds from which the video will play in the message.

std::string	fileName
	Optional. Original 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. 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. https://core.telegram.org/bots/api#video.

Definition at line 8 of file Video.hpp.

Constructor & Destructor Documentation

◆ Video() [1/2]

tgbotxx::Video::Video ( )

default

◆ Video() [2/2]

tgbotxx::Video::Video ( const nl::json & json )

inlineexplicit

Definition at line 10 of file Video.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::Video::fromJson ( const nl::json & json )

inline

Deserializes this object from JSON.

Definition at line 69 of file Video.hpp.

◆ toJson()

nl::json tgbotxx::Video::toJson ( ) const

inline

Serializes this object to JSON.

Returns: JSON representation of this object

Definition at line 52 of file Video.hpp.

Member Data Documentation

◆ cover

std::vector<Ptr<PhotoSize> > tgbotxx::Video::cover

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

Definition at line 34 of file Video.hpp.

◆ duration

std::int32_t tgbotxx::Video::duration {}

Duration of the video in seconds as defined by sender.

Definition at line 28 of file Video.hpp.

◆ fileId

std::string tgbotxx::Video::fileId

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

Definition at line 15 of file Video.hpp.

◆ fileName

std::string tgbotxx::Video::fileName

Optional. Original filename as defined by sender.

Definition at line 40 of file Video.hpp.

◆ fileSize

std::int64_t tgbotxx::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 48 of file Video.hpp.

◆ fileUniqueId

std::string tgbotxx::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 19 of file Video.hpp.

◆ height

std::int32_t tgbotxx::Video::height {}

Video height as defined by sender.

Definition at line 25 of file Video.hpp.

◆ mimeType

std::string tgbotxx::Video::mimeType

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

Definition at line 43 of file Video.hpp.

◆ startTimestamp

std::time_t tgbotxx::Video::startTimestamp {}

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

Definition at line 37 of file Video.hpp.

◆ thumbnail

Ptr<PhotoSize> tgbotxx::Video::thumbnail

Optional. Video thumbnail.

Definition at line 31 of file Video.hpp.

◆ width

std::int32_t tgbotxx::Video::width {}

Video width as defined by sender.

Definition at line 22 of file Video.hpp.

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

include/tgbotxx/objects/Video.hpp

Public Member Functions

Public Attributes