hikari.voices#

Application and entities that are used to describe voice state on Discord.

Module Contents#

class hikari.voices.VoiceRegion[source]#

Represents a voice region server.

id: str[source]#

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: bool[source]#

Whether this region is custom (e.g. used for events).

is_deprecated: bool[source]#

Whether this region is deprecated.

is_optimal_location: bool[source]#

Whether this region’s server is closest to the current user’s client.

name: str[source]#

The name of this region.

class hikari.voices.VoiceState[source]#

Represents a user’s voice connection status.

app: hikari.traits.RESTAware[source]#

Client application that models may use for procedures.

channel_id: hikari.snowflakes.Snowflake | None[source]#

The ID of the channel this user is connected to.

This will be None if they are leaving voice.

guild_id: hikari.snowflakes.Snowflake[source]#

The ID of the guild this voice state is in.

is_guild_deafened: bool[source]#

Whether this user is deafened by the guild.

is_guild_muted: bool[source]#

Whether this user is muted by the guild.

is_self_deafened: bool[source]#

Whether this user is deafened by their client.

is_self_muted: bool[source]#

Whether this user is muted by their client.

is_streaming: bool[source]#

Whether this user is streaming using “Go Live”.

is_suppressed: bool[source]#

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: bool[source]#

Whether this user’s camera is enabled.

member: hikari.guilds.Member[source]#

The guild member this voice state is for.

requested_to_speak_at: datetime.datetime | None[source]#

When the user requested to speak in a stage channel.

Will be None if they have not requested to speak.

session_id: str[source]#

The string ID of this voice state’s session.

user_id: hikari.snowflakes.Snowflake[source]#

The ID of the user this voice state is for.