Skip to main content

sendChannelAudio

Send audio to a channel: delivered to every active member of the channel, wherever they are (party or guild voice), as a ChannelAudioNotification on udpNotifications. The payload is opaque (at most 1024 bytes): your app or an SDK voice helper defines the format and codec. Requires a bearer game token, the channel send_voice permission and the player’s use_voice_chat; without either the server refuses it with UNAUTHORIZED (asynchronously, on udpNotifications). Opens a UDP proxy session automatically if none exists. The sender receives no echo. Every member’s downlink is billed as egress, so keep voice channels small. Returns Boolean! that is true only when the datagram was ACCEPTED FOR SENDING, not delivered; correlate failures by sequenceNumber (correlation only, not an idempotency key).

sendChannelAudio(
  input: ChannelMessageInput!
): Boolean!

Arguments​

sendChannelAudio.input ● ChannelMessageInput! non-null input​

The channel audio to send: channelId (groups.group_id), the sender’s 32-byte actor uuid, base64 payload (max 1024 bytes), and optional sequenceNumber. Same shape as sendChannelMessage.

Type​

Boolean scalar​

The Boolean scalar type represents true or false.