hikari.voices
#
Application and entities that are used to describe voice state on Discord.
VoiceRegion #
Represents a voice region server.
id class-attribute
instance-attribute
#
The string ID of this region.
Note
Unlike most parts of this API, this ID will always be a string type. This is intentional.
is_custom class-attribute
instance-attribute
#
Whether this region is custom (e.g. used for events).
is_deprecated class-attribute
instance-attribute
#
Whether this region is deprecated.
is_optimal_location class-attribute
instance-attribute
#
Whether this region's server is closest to the current user's client.
VoiceState #
Represents a user's voice connection status.
app class-attribute
instance-attribute
#
Client application that models may use for procedures.
channel_id class-attribute
instance-attribute
#
The ID of the channel this user is connected to.
This will be None
if they are leaving voice.
guild_id class-attribute
instance-attribute
#
The ID of the guild this voice state is in.
is_guild_deafened class-attribute
instance-attribute
#
Whether this user is deafened by the guild.
is_guild_muted class-attribute
instance-attribute
#
Whether this user is muted by the guild.
is_self_deafened class-attribute
instance-attribute
#
Whether this user is deafened by their client.
is_self_muted class-attribute
instance-attribute
#
Whether this user is muted by their client.
is_streaming class-attribute
instance-attribute
#
Whether this user is streaming using "Go Live".
is_suppressed class-attribute
instance-attribute
#
Whether this user is considered to be "suppressed" in a voice context.
In the context of a voice channel this may mean that the user is muted by the current user and in the context of a stage channel this means that the user is not a speaker.
is_video_enabled class-attribute
instance-attribute
#
Whether this user's camera is enabled.
member class-attribute
instance-attribute
#
The guild member this voice state is for.
requested_to_speak_at class-attribute
instance-attribute
#
When the user requested to speak in a stage channel.
Will be None
if they have not requested to speak.
session_id class-attribute
instance-attribute
#
The string ID of this voice state's session.