import tgram
from typing import List
from typing import Union
from tgram.types import ForceReply
from tgram.types import InlineKeyboardMarkup
from tgram.types import Message
from tgram.types import MessageEntity
from tgram.types import ReplyKeyboardMarkup
from tgram.types import ReplyKeyboardRemove
from tgram.types import ReplyParameters
from pathlib import Path
from tgram.utils import get_file_path
[docs]
class SendVideo:
[docs]
async def send_video(
self: "tgram.TgBot",
chat_id: Union[int, str],
video: Union[Path, bytes, str],
business_connection_id: str = None,
message_thread_id: int = None,
duration: int = None,
width: int = None,
height: int = None,
thumbnail: Union[Path, bytes, str] = None,
caption: str = None,
parse_mode: str = None,
caption_entities: List[MessageEntity] = None,
show_caption_above_media: bool = None,
has_spoiler: bool = None,
supports_streaming: bool = None,
disable_notification: bool = None,
protect_content: bool = None,
message_effect_id: str = None,
reply_parameters: ReplyParameters = None,
reply_markup: Union[
InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply
] = None,
) -> Message:
"""
Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
Telegram documentation: https://core.telegram.org/bots/api#sendvideo
:param chat_id: Unique identifier for the target chat or username of the target channel (in the format @channelusername)
:type chat_id: :obj:`int` or :obj:`str`
:param video: Video to send. You can either pass a file_id as String to resend a video that is already on the Telegram servers, or upload a new video file using multipart/form-data.
:type video: :obj:`str` or :class:`tgram.types.InputFile`
:param duration: Duration of sent video in seconds
:type duration: :obj:`int`
:param width: Video width
:type width: :obj:`int`
:param height: Video height
:type height: :obj:`int`
:param thumbnail: 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>.
:type thumbnail: :obj:`str` or :class:`tgram.types.InputFile`
:param caption: Video caption (may also be used when resending videos by file_id), 0-1024 characters after entities parsing
:type caption: :obj:`str`
:param parse_mode: Mode for parsing entities in the video caption
:type parse_mode: :obj:`str`
:param caption_entities: List of special entities that appear in the caption, which can be specified instead of parse_mode
:type caption_entities: :obj:`list` of :class:`tgram.types.MessageEntity`
:param supports_streaming: Pass True, if the uploaded video is suitable for streaming
:type supports_streaming: :obj:`bool`
:param disable_notification: Sends the message silently. Users will receive a notification with no sound.
:type disable_notification: :obj:`bool`
:param protect_content: Protects the contents of the sent message from forwarding and saving
:type protect_content: :obj:`bool`
:param reply_to_message_id: Deprecated - Use reply_parameters instead. If the message is a reply, ID of the original message
:type reply_to_message_id: :obj:`int`
:param allow_sending_without_reply: Deprecated - Use reply_parameters instead. Pass True, if the message should be sent even if the specified replied-to message is not found
:type allow_sending_without_reply: :obj:`bool`
:param reply_markup: Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard
or to force a reply from the user.
:type reply_markup: :class:`tgram.types.InlineKeyboardMarkup` or :class:`tgram.types.ReplyKeyboardMarkup` or :class:`tgram.types.ReplyKeyboardRemove`
or :class:`tgram.types.ForceReply`
:param timeout: Timeout in seconds for the request.
:type timeout: :obj:`int`
:param data: function typo miss compatibility: do not use it
:type data: :obj:`str`
:param message_thread_id: Identifier of a message thread, in which the video will be sent
:type message_thread_id: :obj:`int`
:param has_spoiler: Pass True, if the video should be sent as a spoiler
:type has_spoiler: :obj:`bool`
:param thumb: Deprecated. Use thumbnail instead
:type thumb: :obj:`str` or :class:`tgram.types.InputFile`
:param reply_parameters: Reply parameters.
:type reply_parameters: :class:`tgram.types.ReplyParameters`
:param business_connection_id: Identifier of a business connection, in which the message will be sent
:type business_connection_id: :obj:`str`
:param message_effect_id: Unique identifier of the message effect
:type message_effect_id: :obj:`str`
:param show_caption_above_media: Pass True, if the caption must be shown above the message media. Supported only for animation, photo and video messages.
:type show_caption_above_media: :obj:`bool`
:return: On success, the sent Message is returned.
:rtype: :class:`tgram.types.Message`
"""
result = await self._send_request(
"sendVideo",
chat_id=chat_id,
video=get_file_path(video),
business_connection_id=business_connection_id,
message_thread_id=message_thread_id,
duration=duration,
width=width,
height=height,
thumbnail=get_file_path(thumbnail),
caption=caption,
parse_mode=parse_mode or self.parse_mode,
caption_entities=caption_entities,
show_caption_above_media=show_caption_above_media,
has_spoiler=has_spoiler,
supports_streaming=supports_streaming,
disable_notification=disable_notification,
protect_content=protect_content
if protect_content is not None
else self.protect_content,
message_effect_id=message_effect_id,
reply_parameters=reply_parameters,
reply_markup=reply_markup,
)
return Message._parse(me=self, d=result["result"])