Represents a video to be sent. https://core.telegram.org/bots/api#inputmediavideo. More...

#include <InputMedia.hpp>

Inheritance diagram for tgbotxx::InputMediaVideo:

Public Member Functions
	InputMediaVideo ()

	InputMediaVideo (const nl::json &json)

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

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

Public Member Functions inherited from tgbotxx::InputMedia
	InputMedia ()=default

	InputMedia (const nl::json &json)

virtual	~InputMedia ()=default

Public Attributes
std::string	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>. More information on Sending Files » https://core.telegram.org/bots/api#sending-files.

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 animation needs to be covered with a spoiler animation.

Public Attributes inherited from tgbotxx::InputMedia
std::string	type
	Type of the result.

std::variant< cpr::File, 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. See https://core.telegram.org/bots/api#formatting-options for more details.

std::vector< Ptr< MessageEntity > >	captionEntities
	Optional. List of special entities that appear in the caption, which can be specified instead of parseMode.

Detailed Description

Represents a video to be sent. https://core.telegram.org/bots/api#inputmediavideo.

Definition at line 232 of file InputMedia.hpp.

Constructor & Destructor Documentation

◆ InputMediaVideo() [1/2]

tgbotxx::InputMediaVideo::InputMediaVideo ( )

inline

Definition at line 233 of file InputMedia.hpp.

◆ InputMediaVideo() [2/2]

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

inlineexplicit

Definition at line 236 of file InputMedia.hpp.

Member Function Documentation

◆ fromJson()

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

inlineoverridevirtual

Deserializes this object from JSON.

Reimplemented from tgbotxx::InputMedia.

Definition at line 273 of file InputMedia.hpp.

◆ toJson()

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

inlineoverridevirtual

Serializes this object to JSON.

Returns: JSON representation of this object

Reimplemented from tgbotxx::InputMedia.

Definition at line 263 of file InputMedia.hpp.

Member Data Documentation

◆ duration

std::int32_t tgbotxx::InputMediaVideo::duration {}

Optional. Video duration in seconds.

Definition at line 254 of file InputMedia.hpp.

◆ hasSpoiler

bool tgbotxx::InputMediaVideo::hasSpoiler {}

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

Definition at line 260 of file InputMedia.hpp.

◆ height

std::int32_t tgbotxx::InputMediaVideo::height {}

Optional. Video height.

Definition at line 251 of file InputMedia.hpp.

◆ supportsStreaming

bool tgbotxx::InputMediaVideo::supportsStreaming {}

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

Definition at line 257 of file InputMedia.hpp.

◆ thumbnail

std::string tgbotxx::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>. More information on Sending Files » https://core.telegram.org/bots/api#sending-files.

Definition at line 245 of file InputMedia.hpp.

◆ width

std::int32_t tgbotxx::InputMediaVideo::width {}

Optional. Video width.

Definition at line 248 of file InputMedia.hpp.

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

include/tgbotxx/objects/InputMedia.hpp

Public Member Functions

Public Attributes