Represents a video to be sent. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<InputMediaVideo>

Public Attributes
std::string	type { TYPE }
	Type of the media, must be video.
std::string	media { }
	File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
std::optional< 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 »
std::optional< std::string >	cover { }
	Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »
std::optional< std::int32_t >	startTimestamp { }
	Optional. Start timestamp for the video in the message.
std::optional< std::string >	caption { }
	Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.
std::optional< std::string >	parseMode { }
	Optional. Mode for parsing entities in the video caption. See formatting options for more details.
std::optional< std::vector< std::shared_ptr< MessageEntity > > >	captionEntities { }
	Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.
std::optional< bool >	showCaptionAboveMedia { }
	Optional. Pass True if the caption must be shown above the message media.
std::optional< std::int32_t >	width { }
	Optional. Video width.
std::optional< std::int32_t >	height { }
	Optional. Video height.
std::optional< std::int32_t >	duration { }
	Optional. Video duration in seconds.
std::optional< bool >	supportsStreaming { }
	Optional. Pass True if the uploaded video is suitable for streaming.
std::optional< bool >	hasSpoiler { }
	Optional. Pass True if the video needs to be covered with a spoiler animation.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

Represents a video to be sent.

Definition at line 6783 of file Types.h.

Member Typedef Documentation

◆ Ptr

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

Definition at line 6784 of file Types.h.

Member Data Documentation

◆ caption

std::optional<std::string> TgBot::InputMediaVideo::caption { }

Optional. Caption of the video to be sent, 0-1024 characters after entities parsing.

Definition at line 6828 of file Types.h.

◆ captionEntities

std::optional<std::vector<std::shared_ptr<MessageEntity> > > TgBot::InputMediaVideo::captionEntities { }

Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode.

Definition at line 6840 of file Types.h.

◆ cover

std::optional<std::string> TgBot::InputMediaVideo::cover { }

Optional. Cover for the video in the message. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

Definition at line 6818 of file Types.h.

◆ duration

std::optional<std::int32_t> TgBot::InputMediaVideo::duration { }

Optional. Video duration in seconds.

Definition at line 6860 of file Types.h.

◆ hasSpoiler

std::optional<bool> TgBot::InputMediaVideo::hasSpoiler { }

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

Definition at line 6870 of file Types.h.

◆ height

std::optional<std::int32_t> TgBot::InputMediaVideo::height { }

Optional. Video height.

Definition at line 6855 of file Types.h.

◆ media

std::string TgBot::InputMediaVideo::media { }

File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass “attach://<file_attach_name>” to upload a new one using multipart/form-data under <file_attach_name> name. More information on Sending Files »

Definition at line 6799 of file Types.h.

◆ parseMode

std::optional<std::string> TgBot::InputMediaVideo::parseMode { }

Optional. Mode for parsing entities in the video caption. See formatting options for more details.

Definition at line 6834 of file Types.h.

◆ showCaptionAboveMedia

std::optional<bool> TgBot::InputMediaVideo::showCaptionAboveMedia { }

Optional. Pass True if the caption must be shown above the message media.

Definition at line 6845 of file Types.h.

◆ startTimestamp

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

Optional. Start timestamp for the video in the message.

Definition at line 6823 of file Types.h.

◆ supportsStreaming

std::optional<bool> TgBot::InputMediaVideo::supportsStreaming { }

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

Definition at line 6865 of file Types.h.

◆ thumbnail

std::optional<std::string> TgBot::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 »

Definition at line 6810 of file Types.h.

◆ TYPE

TGBOT_API const std::string TgBot::InputMediaVideo::TYPE

static

Definition at line 6786 of file Types.h.

◆ type

std::string TgBot::InputMediaVideo::type { TYPE }

Type of the media, must be video.

Definition at line 6791 of file Types.h.

◆ width

std::optional<std::int32_t> TgBot::InputMediaVideo::width { }

Optional. Video width.

Definition at line 6850 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes

Static Public Attributes