EDA.Voice (EDA v0.3.0)

Copy Markdown View Source

Public API for Discord voice support.

Manages voice connections per guild, including joining/leaving voice channels, audio playback, and listening to incoming audio.

Usage

# Join a voice channel
EDA.Voice.join(guild_id, channel_id)

# Play audio from a URL
EDA.Voice.play(guild_id, "https://example.com/audio.mp3")

# Stop playback
EDA.Voice.stop(guild_id)

# Leave voice
EDA.Voice.leave(guild_id)

Summary

Functions

channel_id(guild_id)

Returns the channel ID the bot is connected to in the given guild, or nil.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_voice_state(guild_id)

Returns the voice state for the given guild if the connection is ready.

join(guild_id, channel_id, opts \\ [])

Joins a voice channel.

leave(guild_id)

Leaves the voice channel in the given guild.

listen(guild_id, count)

Receives count voice packets (blocking).

pause(guild_id)

Pauses audio playback.

play(guild_id, input)

Plays audio from the given input.

play(guild_id, input, opts)
play(guild_id, input, type, opts)
playing?(guild_id)

Returns true if audio is currently playing in the given guild.

ready?(guild_id)

Returns true if the voice connection is ready for the given guild.

resume(guild_id)

Resumes audio playback.

set_audio_pid(guild_id, pid)

Sets the audio pid for a guild, preventing conflicts with play/3. Use nil to clear it when done.

start_link(opts)
start_listening(guild_id)

Enables continuous audio receiving for the given guild.

stop(guild_id)

Stops audio playback in the given guild.

stop_listening(guild_id)

Disables continuous audio receiving for the given guild.

Functions

channel_id(guild_id)

@spec channel_id(String.t()) :: String.t() | nil

Returns the channel ID the bot is connected to in the given guild, or nil.

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

get_voice_state(guild_id)

@spec get_voice_state(String.t()) ::
  {:ok, EDA.Voice.State.t()} | {:error, :not_ready | :not_connected}

Returns the voice state for the given guild if the connection is ready.

join(guild_id, channel_id, opts \\ [])

@spec join(String.t(), String.t(), keyword()) :: :ok

Joins a voice channel.

Options:

  • :mute - Join self-muted (default: false)
  • :deaf - Join self-deafened (default: false)

leave(guild_id)

@spec leave(String.t()) :: :ok

Leaves the voice channel in the given guild.

listen(guild_id, count)

@spec listen(String.t(), integer()) :: [{integer(), binary()}]

Receives count voice packets (blocking).

Returns a list of {ssrc, opus_data} tuples.

pause(guild_id)

@spec pause(String.t()) :: :ok

Pauses audio playback.

play(guild_id, input)

@spec play(String.t(), String.t() | Enumerable.t()) :: :ok | {:error, term()}

Plays audio from the given input.

Types:

  • :url - URL or file path (passed to ffmpeg)
  • :raw - Raw opus frames

Options:

  • :volume - FFmpeg volume multiplier applied to :url inputs

play(guild_id, input, opts)

@spec play(String.t(), String.t() | Enumerable.t(), keyword()) ::
  :ok | {:error, term()}
@spec play(String.t(), String.t() | Enumerable.t(), atom()) :: :ok | {:error, term()}

play(guild_id, input, type, opts)

@spec play(String.t(), String.t() | Enumerable.t(), atom(), keyword()) ::
  :ok | {:error, term()}

playing?(guild_id)

@spec playing?(String.t()) :: boolean()

Returns true if audio is currently playing in the given guild.

ready?(guild_id)

@spec ready?(String.t()) :: boolean()

Returns true if the voice connection is ready for the given guild.

resume(guild_id)

@spec resume(String.t()) :: :ok

Resumes audio playback.

set_audio_pid(guild_id, pid)

@spec set_audio_pid(String.t(), pid() | nil) :: :ok

Sets the audio pid for a guild, preventing conflicts with play/3. Use nil to clear it when done.

start_link(opts)

start_listening(guild_id)

@spec start_listening(String.t()) :: :ok | {:error, term()}

Enables continuous audio receiving for the given guild.

Incoming voice packets will be dispatched as VOICE_AUDIO events via EDA.Gateway.Events, along with VOICE_SPEAKING_START and VOICE_SPEAKING_STOP events when users begin or stop speaking.

stop(guild_id)

@spec stop(String.t()) :: :ok

Stops audio playback in the given guild.

stop_listening(guild_id)

@spec stop_listening(String.t()) :: :ok

Disables continuous audio receiving for the given guild.