Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConnectionEvents

The events emitted from DisPlayConnection class.

Hierarchy

  • ConnectionEvents

Index

Methods

Methods

error

  • error(error: Error): void

selfDeafen

  • selfDeafen(flag: boolean): void

  • The event when deafening status of bot gets changed.

    Parameters

    • flag: boolean

      If true, bot is deafened and hence is unable to receive audio else undeafened.

    Returns void

selfMute

  • selfMute(flag: boolean): void

voiceConnectionCreate

  • voiceConnectionCreate(voiceId: null | string): void

  • The event when a voice channel is joined successfully.

    Parameters

    • voiceId: null | string

      The ID of the joined voice channel.

    Returns void

voiceConnectionDestroy

  • voiceConnectionDestroy(voiceId: null | string): void

  • The event when a voice channel is left due to manual disconnection, kicked or due to some error.

    Parameters

    • voiceId: null | string

      The ID of voice channel which was left.

    Returns void

voiceConnectionKick

  • voiceConnectionKick(voiceId: null | string): void

  • The event when bot is manually kicked from a voice channel.

    remarks

    May take upto 3 seconds for event to fire after the bot is kicked.

    Parameters

    • voiceId: null | string

      The ID of the voice channel from where the bot was kicked.

    Returns void

voiceConnectionMove

  • voiceConnectionMove(oldVoiceId: null | string, newVoiceId: null | string): void

  • The event when bot is moved from one voice channel to another.

    Parameters

    • oldVoiceId: null | string

      The ID of the previous voice channel.

    • newVoiceId: null | string

      The ID of the new voice channel.

    Returns void

Generated using TypeDoc