Class Video

A video, round video message or GIF animation.

Note: Legacy GIF animations are also wrapped with this class.

Hierarchy (View Summary)

Constructors

constructor

Properties

attr dcId? fileSize? location media? raw type

Accessors

codec date duration fileId fileName hasSpoiler height inputDocument inputMedia isAnimation isLegacyGif isRound mimeType thumbnails ttlSeconds uniqueFileId videoStartTs width

Methods

_fileIdType getThumbnail

Constructors

constructor

Properties

Readonlyattr

attr: RawDocumentAttributeImageSize | RawDocumentAttributeVideo

Optional ReadonlydcId

dcId?: number

DC ID of the file, when available

Optional ReadonlyfileSize

fileSize?: number

File size in bytes, when available

Readonlylocation

location:
    | Uint8Array
    | TypeInputFileLocation
    | TypeInputWebFileLocation
    | () => Uint8Array | TypeInputFileLocation | TypeInputWebFileLocation

Location of the file.

Either a TL object declaring remote file location, a Buffer containing actual file content (for stripped thumbnails and vector previews), or a function that will return either of those.

When a function is passed, it will be lazily resolved the first time downloading the file.

Optional Readonlymedia

media?: RawMessageMediaDocument

Readonlyraw

raw: RawDocument

Readonlytype

type: "video" = ...

Type of the media (for use in a tagged union)

Accessors

codec

  • get codec(): null | string

  • Returns null | string

date

  • get date(): Date

  • Date the document was sent

    Returns Date

duration

  • get duration(): number

  • Video duration in seconds.

    0 for legacy GIFs

    Returns number

fileId

  • get fileId(): string

  • Get TDLib and Bot API compatible File ID representing this document.

    Returns string

fileName

  • get fileName(): null | string

  • Original file name, extracted from the document attributes.

    Returns null | string

hasSpoiler

  • get hasSpoiler(): boolean

  • Whether this video is hidden with a spoiler

    Returns boolean

height

  • get height(): number

  • Video height in pixels

    Returns number

inputDocument

  • get inputDocument(): TypeInputDocument

  • Input document TL object generated from this object, to be used with methods that use it

    Returns TypeInputDocument

inputMedia

isAnimation

  • get isAnimation(): boolean

  • Whether this video is an animated GIF (represented either by actual GIF or a silent MP4 video)

    Returns boolean

isLegacyGif

  • get isLegacyGif(): boolean

  • Whether this video is a legacy GIF (i.e. its MIME is image/gif)

    Returns boolean

isRound

  • get isRound(): boolean

  • Whether this video is a round video message (aka video note)

    Returns boolean

mimeType

  • get mimeType(): string

  • File MIME type, as defined by the sender.

    Returns string

thumbnails

  • get thumbnails(): readonly Thumbnail[]

  • Available thumbnails, if any.

    If there are no thumbnails, the array will be empty.

    Returns readonly Thumbnail[]

ttlSeconds

  • get ttlSeconds(): null | number

  • For self-destructing videos, TTL in seconds

    Returns null | number

uniqueFileId

  • get uniqueFileId(): string

  • Get a unique File ID representing this document.

    Returns string

videoStartTs

  • get videoStartTs(): null | number

  • Returns null | number

width

  • get width(): number

  • Video width in pixels

    Returns number

Methods

Protected_fileIdType

getThumbnail

  • getThumbnail(type: string): null | Thumbnail

  • Get a thumbnail by its type.

    Thumbnail types are described in the Telegram docs, and are also available as static members of Thumbnail for convenience.

    Parameters

    • type: string

      Thumbnail type

    Returns null | Thumbnail

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods