View Source Nostrum.Struct.Event.VoiceReady (Nostrum v0.10.0)

Struct representing a Nostrum-generated Voice Ready event

Nostrum will generate this event when the bot joins a voice channel and is ready to play audio.

Listening to this event may be used for bots that begin playing audio directly after joining a voice channel as an alternative to waiting until Nostrum.Voice.ready?/1 returns true.

Summary

Types

channel_id()

Id of the channel that voice is ready in.

guild_id()

Id of the guild that voice is ready in.

t()

Types

channel_id()

(since 0.5.0)

@type channel_id() :: Nostrum.Struct.Channel.id()

Id of the channel that voice is ready in.

guild_id()

(since 0.5.0)

@type guild_id() :: Nostrum.Struct.Guild.id()

Id of the guild that voice is ready in.

t()

(since 0.5.0)

@type t() :: %Nostrum.Struct.Event.VoiceReady{
  channel_id: channel_id(),
  guild_id: guild_id()
}