Voice¶

discord_http.voice module¶

class discord_http.voice.PartialVoiceState(*, state, id, channel_id=None, guild_id=None)¶

Bases: PartialBase

Represents a partial voice state object.

Parameters:

state (DiscordAPI)
id (int)
channel_id (int | None)
guild_id (int | None)

id: int¶: The ID of the user this voice state belongs to.

channel_id: int | None¶: The ID of the voice channel this user is in, if any.

guild_id: int | None¶: The ID of the guild this voice state is in, if any.

property member_id: int¶: The ID of the member (alias of id).

property guild: PartialGuild | None¶: The partial guild of the voice state, if available.

property member: PartialMember | PartialUser¶: The partial user/member of the state.

property channel: PartialChannel | None¶: The partial channel of the state, if available

async fetch() → VoiceState¶

Fetches the voice state of the member.

Return type:

Returns:

The voice state of the member

Raises:

NotFound –

If the member is not in the guild - If the member is not in a voice channel

async edit(*, suppress=<MISSING>) → None¶

Updates the voice state of the member.

Parameters:: suppress (bool) – Whether to suppress the user
Return type:: None

property created_at: datetime¶: The datetime of the snowflake.

class discord_http.voice.VoiceState(*, state, data, guild_id=None)¶

Bases: PartialVoiceState

Represents a voice state object.

Parameters:

state (DiscordAPI)
data (dict)
guild_id (int | None)

session_id: str¶: The session ID of the voice state.

deaf: bool¶: Whether the user is deafened by the server.

mute: bool¶: Whether the user is muted by the server.

self_deaf: bool¶: Whether the user is deafened by themselves.

self_mute: bool¶: Whether the user is muted by themselves.

self_stream: bool¶: Whether the user is streaming.

channel_id: int | None¶: The ID of the voice channel this user is in, if any.

property created_at: datetime¶: The datetime of the snowflake.

async edit(*, suppress=<MISSING>) → None¶

Updates the voice state of the member.

Parameters:: suppress (bool) – Whether to suppress the user
Return type:: None

async fetch() → VoiceState¶

Fetches the voice state of the member.

Return type:

Returns:

The voice state of the member

Raises:

NotFound –

If the member is not in the guild - If the member is not in a voice channel

guild_id: int | None¶: The ID of the guild this voice state is in, if any.

id: int¶: The ID of the user this voice state belongs to.

property member_id: int¶: The ID of the member (alias of id).

self_video: bool¶: Whether the user is using video.

suppress: bool¶: Whether the user is suppressed by the server.

request_to_speak_timestamp: datetime | None¶: The timestamp when the user requested to speak, if any.

property user: PartialUser¶: The user this voice state belongs to. Resolved live from cache.

property guild: PartialGuild | None¶: The guild this voice state is in, if any. Resolved live from cache.

property channel: BaseChannel | PartialChannel | None¶: The voice channel this user is in, if any. Resolved live from cache.

property member: Member | None¶

The member this voice state belongs to, if any.

Prefers an already-cached Member for this guild (so this doesn’t hold its own separate copy of member/user data), falling back to building one from the voice state payload if not cached.