VoiceChannel

A VoiceChannel is a voice or stage channel: people talk in it, and can write too. It is what channel.isVoice() gives.

import type { VoiceChannel } from 'chapterjs';

async function openGame(channel: VoiceChannel, game: string) {
  await channel.setStatus(`Playing ${game}`);
  const seats = channel.userLimit === 0 ? 'no limit' : `${channel.userLimit} seats`;
  await channel.send(`${channel} is open: ${seats}.`);
}

How to send, edit and read messages is in Sending messages.

Properties

It also has everything of GuildChannel and what channels with messages share.

number

The audio quality, in bits per second.

number

How many people can join; 0 means no limit.

string | null

The voice region of the channel; null when Discord picks it.

boolean

Whether it is a stage channel, where a few speak and the others listen.

Actions

join()

join(options?: JoinOptions): Promise<VoiceConnection>

Joins the voice channel, or moves the bot there from another voice channel of the server. Resolves once the bot can play. On a stage, the bot becomes a speaker when it may, and asks to speak otherwise. See VoiceConnection and its JoinOptions. Discord documentation

setStatus()

setStatus(status: string | null, reason?: string): Promise<void>

Sets the status shown under the name of the voice channel; null removes it. Discord documentation

Reference

Your files

Structures

Types

CLI

Properties

Actions

join()

setStatus()