Class Audio

Hierarchy (View Summary)

InputFile
- Audio

Index

Constructors

constructor

new Audio(client: TelegramClient | BaseClient, data: Audio): Audio
Parameters
- client: TelegramClient | BaseClient
  The client that instantiated this
- data: Audio
  Data about the represents an audio file to be treated as music by the Telegram clients
Returns Audio
Overrides InputFile.constructor

Properties

duration

duration: number

Duration of the audio in seconds as defined by sender

id

id: string

The unique identifier for this file

`Optional`mimeType

mimeType?: string

MIME type of the file as defined by sender

`Optional`name

name?: string

Original filename as defined by sender

path

path: string | null

The path to the file on the Telegram server, if available

`Optional`performer

performer?: string

Performer of the audio as defined by sender or by audio tags

size

size: number | null

The size of the file in bytes, if available

`Optional`thumbnail

thumbnail?: Photo

Thumbnail of the album cover to which the music file belongs

uniqueId

uniqueId: string

The unique identifier for this file, which is supposed to be consistent across different bots

Accessors

client

get client(): TelegramClient
The client that instantiated this

Returns TelegramClient
Inherited from InputFile.client

url

get url(): string | null
Gets the URL to access the file on the Telegram server.

Returns string | null
Inherited from InputFile.url

Methods

`Protected`_clone

_clone(): Base
Protected
Creates a clone of the current instance

Returns Base
A clone of the current instance

Inherited from InputFile._clone

`Protected`_patch

_patch(data: Record<string, any>): Record<string, any>
Protected
Patches the current instance with new data
Parameters
- data: Record<string, any>
  The data to patch the instance with
Returns Record<string, any>
The patched data

Inherited from InputFile._patch

`Protected`_update

_update(data: Record<string, any>): Base
Protected
Updates the current instance with new data and returns a clone of the updated instance
Parameters
- data: Record<string, any>
  The data to update the instance with
Returns Base
A clone of the updated instance

Inherited from InputFile._update

download

download(): Promise<Buffer<ArrayBufferLike>>
Downloads the file from the Telegram server.

Returns Promise<Buffer<ArrayBufferLike>>
A promise that resolves with the file data as a Buffer.

Inherited from InputFile.download

fetch

fetch(): Promise<InputFile>
Fetch about the file

Returns Promise<InputFile>
Inherited from InputFile.fetch

toJSON

toJSON(
propsRecursive?: boolean,
...props: Record<string, string | boolean>[],
): Record<string, any>
Flatten an object. Any properties that are collections will get converted to an array of keys.
Parameters
- OptionalpropsRecursive: boolean
  Optional. If true, calls toJSON method on nested objects.
- ...props: Record<string, string | boolean>[]
  Optional. Specific properties to include/exclude, or rename.
Returns Record<string, any>
Flattened object.

Inherited from InputFile.toJSON

valueOf

valueOf(): string | null
Returns the id instance Chat, User, ChatMember and other

Returns string | null
Inherited from InputFile.valueOf

write

write(
    path: string,
    writeType?: "promise",
    options?: {
        encoding?: BufferEncoding;
        flag?: string;
        signal?: AbortSignal;
    },
): Promise<void>
Writes the file to the specified path.
Parameters
- path: string
  The path where the file should be written.
- OptionalwriteType: "promise"
  The type of write operation.
- Optionaloptions: { encoding?: BufferEncoding; flag?: string; signal?: AbortSignal }
  Additional options for writing the file.
Returns Promise<void>
A promise that resolves when the file has been written.

Inherited from InputFile.write
write(
    path: string,
    writeType: "stream",
    options?: {
        autoClose?: boolean;
        emitClose?: boolean;
        encoding?: BufferEncoding;
        flush?: boolean;
        highWaterMark?: number;
        start?: number;
    },
): Promise<void>
Writes the file to the specified path.
Parameters
- path: string
  The path where the file should be written.
- writeType: "stream"
  The type of write operation.
- Optionaloptions: {
      autoClose?: boolean;
      emitClose?: boolean;
      encoding?: BufferEncoding;
      flush?: boolean;
      highWaterMark?: number;
      start?: number;
  }
  Additional options for writing the file.
Returns Promise<void>
A promise that resolves when the file has been written.

Inherited from InputFile.write
write(
    path: string,
    writeType?: "stream" | "promise",
    options?: undefined,
): Promise<void>
Writes the file to the specified path.
Parameters
- path: string
  The path where the file should be written.
- OptionalwriteType: "stream" | "promise"
  The type of write operation.
- Optionaloptions: undefined
  Additional options for writing the file.
Returns Promise<void>
A promise that resolves when the file has been written.

Inherited from InputFile.write

Class Audio

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Audio

Properties

duration

id

OptionalmimeType

Optionalname

path

Optionalperformer

size

Optionalthumbnail

uniqueId

Accessors

client

Returns TelegramClient

url

Returns string | null

Methods

Protected_clone

Returns Base

Protected_patch

Parameters

Returns Record<string, any>

Protected_update

Parameters

Returns Base

download

Returns Promise<Buffer<ArrayBufferLike>>

fetch

Returns Promise<InputFile>

toJSON

Parameters

Returns Record<string, any>

valueOf

Returns string | null

write

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Settings

On This Page

`Optional`mimeType

`Optional`name

`Optional`performer

`Optional`thumbnail

`Protected`_clone

`Protected`_patch

`Protected`_update