alchemy v0.2.0 Alchemy.Voice
Contains the types and functions related to voice communication with discord.
Summary
Types
region :: %Alchemy.VoiceRegion{custom: Boolean, deprecated: Boolean, id: snowflake, name: String.t, optimal: Boolean, sample_hostname: String.t, sample_port: Integer, vip: Boolean}
Represents a voice region.
id
Represent the unique ID for this region.name
The name of this region.sample_hostname
An example hostname for the region.sample_port
An example port for the region.vip
True if this is a vip-only server.optimal
True for a single server that is closest to the client.deprecated
Whether this is a deprecated voice region.custom
Whether this is a custom voice region.
state :: %Alchemy.VoiceState{channel_id: snowflake, deaf: Boolean, guild_id: snowflake | nil, mute: Boolean, self_deaf: Boolean, self_mute: Boolean, session_id: String.t, suppress: Boolean, user_id: snowflake}
Represents the state of a user’s voice connection.
guild_id
The guild id this state is for.channel_id
The channel id this user is connected to.user_id
The id of the user this state belongs to.session_id
The session id for this voice state.deaf
Whether this user is deafened by the server.mute
Whether this user is muted by the server.self_deaf
Whether this user is locally deafened.self_mute
Whether this user is locally muted.suppress
Whether this user is muted by the current user.