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)[source]¶
Bases:
telegram.InputMedia
Represents a video to be sent.
See also
Note
When using a
telegram.Video
for themedia
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 caneasily 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 inlocal_mode
, passing the path of the file (as string orpathlib.Path
object) is supported as well. Lastly you can pass an existingtelegram.Video
object to send.Changed in version 13.2: Accept
bytes
as input.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. Seetelegram.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.supports_streaming (
bool
, optional) – PassTrue
, 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 inlocal_mode
, passing the path of the file (as string orpathlib.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.
- parse_mode[source]¶
Optional. Mode for parsing entities. See
telegram.constants.ParseMode
and formatting options for more details.- Type:
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
]
- has_spoiler[source]¶
Optional.
True
, if the video is covered with a spoiler animation.Added in version 20.0.
- Type:
- thumbnail[source]¶
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: