Class Video

Hierarchy

BaseEntity
- Video

Index

Constructors

Properties

Accessors

caption encryptedUrl fileSize key mimeType playback seconds sha256 size timestamp

Methods

Constructors

constructor

new Video(raw: IVideoMessage): Video
Parameters
- raw: IVideoMessage
Returns Video
Overrides BaseEntity.constructor
- Defined in src/structures/entities/video.ts:17

Properties

raw

raw: IVideoMessage

Accessors

caption

get caption(): undefined | string
Get caption from the video

Returns

Returns undefined | string
- Defined in src/structures/entities/video.ts:44

encryptedUrl

get encryptedUrl(): string
Get encrypted message media url

Returns

Returns string
Inherited from BaseEntity.encryptedUrl
- Defined in src/structures/entities/baseEntity.ts:33

fileSize

get fileSize(): number
Get file size of media

Returns

Returns number
Inherited from BaseEntity.fileSize
- Defined in src/structures/entities/baseEntity.ts:83

key

get key(): Uint8Array
Get mediaKey of media file

Returns

Returns Uint8Array
Inherited from BaseEntity.key
- Defined in src/structures/entities/baseEntity.ts:74

mimeType

get mimeType(): string
Get mimetype of media

Returns

Returns string
Inherited from BaseEntity.mimeType
- Defined in src/structures/entities/baseEntity.ts:42

playback

get playback(): boolean
Playback video?

Returns

Returns boolean
- Defined in src/structures/entities/video.ts:26

seconds

get seconds(): number
Get seconds duration from a message

Returns

Returns number
- Defined in src/structures/entities/video.ts:35

sha256

get sha256(): {
enc: Uint8Array;
source: Uint8Array;
}
SHA256 media file

Returns

Returns {
enc: Uint8Array;
source: Uint8Array;
}
- enc: Uint8Array
- source: Uint8Array
Inherited from BaseEntity.sha256
- Defined in src/structures/entities/baseEntity.ts:62

size

get size(): {
height: number;
width: number;
}
Get image video

Returns

Returns {
height: number;
width: number;
}
- height: number
- width: number
- Defined in src/structures/entities/video.ts:53

timestamp

get timestamp(): number
Get message timestamp message

Returns

Returns number
Inherited from BaseEntity.timestamp
- Defined in src/structures/entities/baseEntity.ts:51

Methods

retrieveFile

retrieveFile(type: "image" | "video" | "audio" | "ptt" | "sticker" | "document" | "product" | "gif" | "ppic" | "thumbnail-document" | "thumbnail-image" | "thumbnail-video" | "thumbnail-link" | "md-msg-hist" | "md-app-state" | "product-catalog-image" | "payment-bg-image"): Promise<Buffer>
Fetch encrypted url file.

Returns
Parameters
- type: "image" | "video" | "audio" | "ptt" | "sticker" | "document" | "product" | "gif" | "ppic" | "thumbnail-document" | "thumbnail-image" | "thumbnail-video" | "thumbnail-link" | "md-msg-hist" | "md-app-state" | "product-catalog-image" | "payment-bg-image"
  
  Media Type (e.g sticker, video, image)
Returns Promise<Buffer>
Inherited from BaseEntity.retrieveFile
- Defined in src/structures/entities/baseEntity.ts:95

Generated using TypeDoc