TgBot::InputPaidMediaVideo Struct Reference

The paid media to send is a video. More...

#include <Types.h>

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

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::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.

Static Public Attributes
static TGBOT_API const std::string	TYPE

Detailed Description

The paid media to send is a video.

Definition at line 7024 of file Types.h.

Member Typedef Documentation

Ptr

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

Definition at line 7025 of file Types.h.

Member Data Documentation

cover

std::optional<std::string> TgBot::InputPaidMediaVideo::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 7059 of file Types.h.

duration

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

Optional. Video duration in seconds.

Definition at line 7079 of file Types.h.

height

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

Optional. Video height.

Definition at line 7074 of file Types.h.

media

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

startTimestamp

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

Optional. Start timestamp for the video in the message.

Definition at line 7064 of file Types.h.

supportsStreaming

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

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

Definition at line 7084 of file Types.h.

thumbnail

std::optional<std::string> TgBot::InputPaidMediaVideo::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 7051 of file Types.h.

TYPE

TGBOT_API const std::string TgBot::InputPaidMediaVideo::TYPE

static

Definition at line 7027 of file Types.h.

type

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

Type of the media, must be video.

Definition at line 7032 of file Types.h.

width

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

Optional. Video width.

Definition at line 7069 of file Types.h.

---

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

• include/tgbot/Types.h