Nostrum.Voice.stop
You're seeing just the function
stop
, go back to Nostrum.Voice module for more information.
Specs
stop(Nostrum.Struct.Guild.id()) :: :ok | {:error, String.t()}
Stops the current sound being played in a voice channel.
The bot must be connected to a voice channel in the guild specified.
Parameters
guild_id
- ID of guild whose voice channel the sound will be stopped in.
Returns {:error, reason}
if unable to stop or no sound is playing, else :ok
.
If a sound has finished playing, this function does not need to be called to start playing another sound.
Examples
iex> Nostrum.Voice.join_channel(123456789, 420691337)
iex> Nostrum.Voice.play(123456789, "http://brandthill.com/files/weird_dubstep_noises.mp3")
iex> Nostrum.Voice.stop(123456789)