Voice

​

Available Endpoints

​

Get Current User Voice State

import { getCurrentUserVoiceState } from "@discordkit/client";

const voiceState = await getCurrentUserVoiceState({ guild: "123456789" });

• getCurrentUserVoiceState - Handler function
• getCurrentUserVoiceStateSchema - Valibot schema for validation
• getCurrentUserVoiceStateSafe - Validated handler
• getCurrentUserVoiceStateProcedure - tRPC procedure (query)
• getCurrentUserVoiceStateQuery - Query helper

​

Get User Voice State

import { getUserVoiceState } from "@discordkit/client";

const voiceState = await getUserVoiceState({
  guild: "123456789",
  user: "987654321"
});

• getUserVoiceState - Handler function
• getUserVoiceStateSchema - Valibot schema for validation
• getUserVoiceStateSafe - Validated handler
• getUserVoiceStateProcedure - tRPC procedure (query)
• getUserVoiceStateQuery - Query helper

​

List Voice Regions

import { listVoiceRegions } from "@discordkit/client";

const regions = await listVoiceRegions();

• listVoiceRegions - Handler function
• listVoiceRegionsSafe - Validated handler
• listVoiceRegionsProcedure - tRPC procedure (query)
• listVoiceRegionsQuery - Query helper

​

Modify Current User Voice State

import { modifyCurrentUserVoiceState } from "@discordkit/client";

await modifyCurrentUserVoiceState({
  guild: "123456789",
  body: {
    channelId: "987654321",
    suppress: false,
    requestToSpeakTimestamp: "2024-01-01T00:00:00.000Z"
  }
});

• channelId must currently point to a stage channel
• Current user must already have joined channelId
• You must have the MUTE_MEMBERS permission to unsuppress yourself (you can always suppress yourself)
• You must have the REQUEST_TO_SPEAK permission to request to speak (you can always clear your own request)
• You can set requestToSpeakTimestamp to any present or future time

• modifyCurrentUserVoiceState - Handler function
• modifyCurrentUserVoiceStateSchema - Valibot schema for validation
• modifyCurrentUserVoiceStateSafe - Validated handler
• modifyCurrentUserVoiceStateProcedure - tRPC procedure (mutation)

​

Modify User Voice State

import { modifyUserVoiceState } from "@discordkit/client";

await modifyUserVoiceState({
  guild: "123456789",
  user: "987654321",
  body: {
    channelId: "111111111",
    suppress: true
  }
});

• channelId must currently point to a stage channel
• User must already have joined channelId
• When unsuppressed, non-bot users will have their requestToSpeakTimestamp set to the current time (bot users will not)
• When suppressed, the user will have their requestToSpeakTimestamp removed

• modifyUserVoiceState - Handler function
• modifyUserVoiceStateSchema - Valibot schema for validation
• modifyUserVoiceStateSafe - Validated handler
• modifyUserVoiceStateProcedure - tRPC procedure (mutation)

​

Procedure Exports

import { voiceProcedures } from "@discordkit/client";

// Access any procedure:
voiceProcedures.getCurrentUserVoiceStateProcedure
voiceProcedures.getUserVoiceStateProcedure
// ... etc