Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • GramTGCalls

Index

Constructors

constructor

  • new GramTGCalls(client: TelegramClient, chat: EntityLike): GramTGCalls

Properties

chat

chat: EntityLike

client

client: TelegramClient

editParticipant

editParticipant: (participant: EntityLike, params: EditParams) => Promise<boolean> = ...

Alias for edit.

Type declaration

    • (participant: EntityLike, params: EditParams): Promise<boolean>
    • Edits the provided participant.

      Parameters

      Returns Promise<boolean>

editSelfParticipant

editSelfParticipant: (params: EditParams) => Promise<boolean> = ...

Alias for editSelf.

Type declaration

    • Edits self participant.

      Parameters

      Returns Promise<boolean>

Methods

audioFinished

  • audioFinished(): null | boolean
  • Tells if the audio has finished streaming. Returns null if not in call, true if finished or false if not.

    Returns null | boolean

edit

  • edit(participant: EntityLike, params: EditParams): Promise<boolean>
  • Edits the provided participant.

    Parameters

    Returns Promise<boolean>

editSelf

muteAudio

  • muteAudio(): null | boolean
  • Mutes the audio stream. Returns null if there is not in call, false if already muted or true if successful.

    Returns null | boolean

muteVideo

  • muteVideo(): null | boolean
  • Mutes the video stream. Returns null if there is not in call, false if already muted or true if successful.

    Returns null | boolean

pauseAudio

  • pauseAudio(): null | boolean
  • Pauses the audio stream. Returns null if there is not in call, false if already paused or true if successful.

    Returns null | boolean

pauseVideo

  • pauseVideo(): null | boolean
  • Pauses the video stream. Returns null if there is not in call, false if already paused or true if successful.

    Returns null | boolean

resumeAudio

  • resumeAudio(): null | boolean
  • Resumes the audio stream. Returns null if there is not in call, false if not paused or true if successful.

    Returns null | boolean

resumeVideo

  • resumeVideo(): null | boolean
  • Resumes the video stream. Returns null if there is not in call, false if not paused or true if successful.

    Returns null | boolean

stop

  • stop(): Promise<boolean>
  • Stops the stream, closes the WebRTC connection, sends leave request to Telegram and frees up resources. Returns false if not in call or true if successful.

    Returns Promise<boolean>

stream

unmuteAudio

  • unmuteAudio(): null | boolean
  • Unmutes the audio stream. Returns null if not in call, false if already muted or true if successful.

    Returns null | boolean

unmuteVideo

  • unmuteVideo(): null | boolean
  • Unmutes the audio stream. Returns null if not in call, false if already muted or true if successful.

    Returns null | boolean

videoFinished

  • videoFinished(): null | boolean
  • Tells if the video has finished streaming. Returns null if not in call, true if finished or false if not.

    Returns null | boolean

Generated using TypeDoc