Skip to content

GramIO API Reference / gramio/dist / TelegramInputMediaVideo

Interface: TelegramInputMediaVideo

Defined in: @gramio/types/out/objects.d.ts:5696

Represents a video to be sent.

Documentation

Properties

PropertyTypeDescriptionDefined in
caption?string | { toString: string; }Optional. Caption of the video to be sent, 0-1024 characters after entities parsing@gramio/types/out/objects.d.ts:5720
caption_entities?TelegramMessageEntity[]Optional. List of special entities that appear in the caption, which can be specified instead of parse_mode@gramio/types/out/objects.d.ts:5728
cover?string | BlobOptional. 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 »@gramio/types/out/objects.d.ts:5712
duration?numberOptional. Video duration in seconds@gramio/types/out/objects.d.ts:5744
has_spoiler?booleanOptional. Pass True if the video needs to be covered with a spoiler animation@gramio/types/out/objects.d.ts:5752
height?numberOptional. Video height@gramio/types/out/objects.d.ts:5740
mediastring | BlobFile 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 »@gramio/types/out/objects.d.ts:5704
parse_mode?"HTML" | "MarkdownV2" | "Markdown"Optional. Mode for parsing entities in the video caption. See formatting options for more details.@gramio/types/out/objects.d.ts:5724
show_caption_above_media?booleanOptional. Pass True, if the caption must be shown above the message media@gramio/types/out/objects.d.ts:5732
start_timestamp?numberOptional. Start timestamp for the video in the message@gramio/types/out/objects.d.ts:5716
supports_streaming?booleanOptional. Pass True if the uploaded video is suitable for streaming@gramio/types/out/objects.d.ts:5748
thumbnail?string | BlobOptional. 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 »@gramio/types/out/objects.d.ts:5708
type"video"Type of the result, must be video@gramio/types/out/objects.d.ts:5700
width?numberOptional. Video width@gramio/types/out/objects.d.ts:5736