Remedy.Struct.Event.SpeakingUpdate (Remedy v0.5.2) View Source

Struct representing a Remedy-generated Speaking Update event

Remedy 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.

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() :: Remedy.Struct.Channel.id()

Id of the channel this speaking update is occurring in.

Specs

guild_id() :: Remedy.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() :: %Remedy.Struct.Event.SpeakingUpdate{
  channel_id: channel_id(),
  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.