class InlineQueryResultVideo implements InlineQueryResultInterface

Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the video.

Methods

__construct(string $type, string $id, string $video_url, string $mime_type, string $thumb_url, string $title, string|null $caption = null, string|null $parse_mode = null, MessageEntity[]|null $caption_entities = null, int|null $video_width = null, int|null $video_height = null, int|null $video_duration = null, string|null $description = null, InlineKeyboardMarkup|null $reply_markup = null, InputMessageContentInterface|null $input_message_content = null)

No description

string
getType()

Type of the result, must be video.

string
getId()

Unique identifier for this result, 1-64 bytes.

string
getVideoUrl()

A valid URL for the embedded video player or video file.

string
getMimeType()

MIME type of the content of the video URL, “text/html” or “video/mp4”.

string
getThumbUrl()

URL of the thumbnail (JPEG only) for the video.

string
getTitle()

Title for the result.

string|null
getCaption()

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

string|null
getParseMode()

Optional. Mode for parsing entities in the video caption. See formatting options for more details.

array|null
getCaptionEntities()

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

int|null
getVideoWidth()

Optional. Video width.

int|null
getVideoHeight()

Optional. Video height.

int|null
getVideoDuration()

Optional. Video duration in seconds.

string|null
getDescription()

Optional. Short description of the result.

InlineKeyboardMarkup|null
getReplyMarkup()

Optional. Inline keyboard attached to the message.

InputMessageContentInterface|null
getInputMessageContent()

Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).

Details

at line 27
__construct(string $type, string $id, string $video_url, string $mime_type, string $thumb_url, string $title, string|null $caption = null, string|null $parse_mode = null, MessageEntity[]|null $caption_entities = null, int|null $video_width = null, int|null $video_height = null, int|null $video_duration = null, string|null $description = null, InlineKeyboardMarkup|null $reply_markup = null, InputMessageContentInterface|null $input_message_content = null)

No description

Parameters

string $type
string $id
string $video_url
string $mime_type
string $thumb_url
string $title
string|null $caption
string|null $parse_mode
MessageEntity[]|null $caption_entities
int|null $video_width
int|null $video_height
int|null $video_duration
string|null $description
InlineKeyboardMarkup|null $reply_markup
InputMessageContentInterface|null $input_message_content

at line 49
string getType()

Type of the result, must be video.

Return Value

string

at line 57
string getId()

Unique identifier for this result, 1-64 bytes.

Return Value

string

at line 65
string getVideoUrl()

A valid URL for the embedded video player or video file.

Return Value

string

at line 73
string getMimeType()

MIME type of the content of the video URL, “text/html” or “video/mp4”.

Return Value

string

at line 81
string getThumbUrl()

URL of the thumbnail (JPEG only) for the video.

Return Value

string

at line 89
string getTitle()

Title for the result.

Return Value

string

at line 97
string|null getCaption()

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

Return Value

string|null

at line 105
string|null getParseMode()

Optional. Mode for parsing entities in the video caption. See formatting options for more details.

Return Value

string|null

at line 115
array|null getCaptionEntities()

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

Return Value

array|null

at line 123
int|null getVideoWidth()

Optional. Video width.

Return Value

int|null

at line 131
int|null getVideoHeight()

Optional. Video height.

Return Value

int|null

at line 139
int|null getVideoDuration()

Optional. Video duration in seconds.

Return Value

int|null

at line 147
string|null getDescription()

Optional. Short description of the result.

Return Value

string|null

at line 155
InlineKeyboardMarkup|null getReplyMarkup()

Optional. Inline keyboard attached to the message.

Return Value

InlineKeyboardMarkup|null

at line 163
InputMessageContentInterface|null getInputMessageContent()

Optional. Content of the message to be sent instead of the video. This field is required if InlineQueryResultVideo is used to send an HTML-page as a result (e.g., a YouTube video).

Return Value

InputMessageContentInterface|null