Pylon Logo Pylon SDK Reference
📓 Changelog 🌟 Getting Started 🧰 SDK Reference
💬 Discord Server 🏠 Home

Results

Namespace

Type

A bot's guild-based voice state can be updated with the following options. Used with discord.Guild.setOwnVoiceState.

Hierarchy

  • ISetVoiceStateOptions <-- You are here!

Index

Properties

Properties

channelId

channelId: Snowflake | null

This field determines the channel id for the current user's voice connection.

If set to a valid channel id within the guild, the bot will connect to it. If a new voice session was created, a VOICE_SERVER_UPDATE event will be received with the voice server's connection details.

If set to null, the bot user will disconnect it's voice session.

Optional selfDeaf

selfDeaf: undefined | false | true

Set to true if the bot user should be self-deafened upon joining the channel.

Deafened means the bot user will not receive any audio.

Default: false

Optional selfMute

selfMute: undefined | false | true

Set to true if the bot user should be self-muted upon joining the channel.

Muted means the bot user will not be able to broadcast audio.

Default: false

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc