InputMediaVideo

class telegram.InputMediaVideo(media, caption=None, width=None, height=None, duration=None, supports_streaming=None, parse_mode=None, caption_entities=None, filename=None, has_spoiler=None, thumbnail=None, show_caption_above_media=None, *, api_kwargs=None)

Bases: telegram.InputMedia

Represents a video to be sent.

Use In

• telegram.Bot.edit_message_media()

• telegram.Bot.send_media_group()

See also

Working with Files and Media

Note

• When using a telegram.Video for the media attribute, it will take the width, height and duration from that video, unless otherwise specified with the optional arguments.

• thumbnail will be ignored for small video files, for which Telegram can

  easily generate thumbnails. However, this behaviour is undocumented and might be changed by Telegram.

Changed in version 20.5: Removed the deprecated argument and attribute thumb.

Parameters:

• media (str | file object | InputFile | bytes | pathlib.Path | telegram.Video) –

  File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one. To upload a file, you can either pass a file object (e.g. open("filename", "rb")) or the file contents as bytes. If the bot is running in local_mode, passing the path of the file (as string or pathlib.Path object) is supported as well. Lastly you can pass an existing telegram.Video object to send.

  Changed in version 13.2: Accept bytes as input.

• filename (str, optional) –

  Custom file name for the video, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

  Added in version 13.1.

• caption (str, optional) – Caption of the video to be sent, 0-1024 characters after entities parsing.

• parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

• caption_entities (Sequence[telegram.MessageEntity], optional) –

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

  Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list. The input is converted to a tuple.

• width (int, optional) – Video width.

• height (int, optional) – Video height.

• duration (int, optional) – Video duration in seconds.

• supports_streaming (bool, optional) – Pass True, if the uploaded video is suitable for streaming.

• has_spoiler (bool, optional) –

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

  Added in version 20.0.

• thumbnail (file object | bytes | pathlib.Path | str, 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. To upload a file, you can either pass a file object (e.g. open("filename", "rb")) or the file contents as bytes. If the bot is running in local_mode, passing the path of the file (as string or pathlib.Path object) is supported as well.

  Added in version 20.2.

• show_caption_above_media (bool, optional) –

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

  Added in version 21.3.

type

'video'.

Type:

str

media

Video file to send.

Type:

str | telegram.InputFile

caption

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

Type:

str

parse_mode

Optional. Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

Type:

str

caption_entities

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

Changed in version 20.0:

• This attribute is now an immutable tuple.

• This attribute is now always a tuple, that may be empty.

Type:

Tuple[telegram.MessageEntity]

width

Optional. Video width.

Type:

int

height

Optional. Video height.

Type:

int

duration

Optional. Video duration in seconds.

Type:

int

supports_streaming

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

Type:

bool

has_spoiler

Optional. True, if the video is covered with a spoiler animation.

Added in version 20.0.

Type:

bool

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.

Added in version 20.2.

Type:

telegram.InputFile

show_caption_above_media

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

Added in version 21.3.

Type:

bool