InputPaidMediaVideo

class telegram.InputPaidMediaVideo(media, thumbnail=None, width=None, height=None, duration=None, supports_streaming=None, cover=None, start_timestamp=None, *, api_kwargs=None)[source]

Bases: telegram.InputPaidMedia

The paid media to send is a video.

See also

Working with Files and Media

Use In

telegram.Bot.send_paid_media()

Added in version 21.4.

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.

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.

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

  • cover (file object | bytes | pathlib.Path | str, optional) –

    Cover for the video in the message. 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.

    Changed in version 21.11.

  • start_timestamp (int, optional) –

    Start timestamp for the video in the message

    Changed in version 21.11.

  • width (int, optional) – Video width.

  • height (int, optional) – Video height.

  • duration (int | datetime.timedelta, optional) –

    Video duration in seconds.

    Changed in version v22.2: datetime.timedelta objects are accepted in addition to plain int values.

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

type[source]

Type of the media, always 'video'.

Type:

str

media[source]

Video to send.

Type:

str | telegram.InputFile

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.

Type:

telegram.InputFile

cover[source]

Optional. Cover for the video in the message. 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.

Changed in version 21.11.

Type:

telegram.InputFile

start_timestamp[source]

Optional. Start timestamp for the video in the message

Changed in version 21.11.

Type:

int

width[source]

Optional. Video width.

Type:

int

height[source]

Optional. Video height.

Type:

int

duration[source]

Optional. Video duration in seconds.

Deprecated since version v22.2: In a future major version this attribute will be of type datetime.timedelta. You can opt-in early by setting PTB_TIMEDELTA=true or PTB_TIMEDELTA=1 as an environment variable.

Type:

int | datetime.timedelta

supports_streaming[source]

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

Type:

bool