View Source Nostrum.Struct.Event.SpeakingUpdate (Nostrum v0.6.1)

Struct representing a Nostrum-generated Speaking Update event

Nostrum will generate this event when the bot starts or stops playing audio.

Link to this section Summary

Types

Id of the channel this speaking update is occurring in.

Current URL being played if a readable format.

Id of the guild this speaking update is occurring in.

Boolean representing if bot has started or stopped speaking.

t()

Boolean representing if speaking update was caused by an audio timeout.

Link to this section Types

Specs

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

Id of the channel this speaking update is occurring in.

Link to this type

current_url()

View Source (since 0.6.0)

Specs

current_url() :: String.t() | nil

Current URL being played if a readable format.

Specs

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

Id of the guild this speaking update is occurring in.

Specs

speaking() :: boolean()

Boolean representing if bot has started or stopped speaking.

Specs

t() :: %Nostrum.Struct.Event.SpeakingUpdate{
  channel_id: channel_id(),
  current_url: current_url(),
  guild_id: guild_id(),
  speaking: speaking(),
  timed_out: timed_out()
}
Link to this type

timed_out()

View Source (since 0.5.0)

Specs

timed_out() :: boolean()

Boolean representing if speaking update was caused by an audio timeout.