Skip to content

Enums

All enumerations used throughout RevvLink.


NodeStatus

Bases: Enum

Enum representing the connection status of a Node.

Attributes:

Name Type Description
DISCONNECTED

The Node has been disconnected or has never been connected previously.

CONNECTING

The Node is currently attempting to connect.

CONNECTED

The Node is currently connected.


TrackSource

Bases: Enum

Enum representing a :class:Playable source.

Attributes:

Name Type Description
YouTube

A source representing a track that comes from YouTube.

YouTubeMusic

A source representing a track that comes from YouTube Music.

SoundCloud

A source representing a track that comes from SoundCloud.

Plugin Sources

Spotify, Apple Music, Deezer, and other plugin sources are not enum members. Pass their search prefix as a raw string instead:

# Requires LavaSrc plugin
tracks = await revvlink.Playable.search("lofi", source="spsearch")   # Spotify
tracks = await revvlink.Playable.search("lofi", source="amsearch")   # Apple Music
tracks = await revvlink.Playable.search("lofi", source="dzsearch")   # Deezer

AutoPlayMode

Bases: Enum

Enum representing the various AutoPlay modes.

Attributes:

Name Type Description
enabled

When enabled, AutoPlay will work fully autonomously and fill the auto_queue with recommended tracks. If a song is put into a players standard queue, AutoPlay will use it as a priority.

partial

When partial, AutoPlay will work fully autonomously but will not fill the auto_queue with recommended tracks.

disabled

When disabled, AutoPlay will not do anything automatically.


QueueMode

Bases: Enum

Enum representing the various modes on :class:revvlink.Queue

Attributes:

Name Type Description
normal

When set, the queue will not loop either track or history. This is the default.

loop

When set, the track will continuously loop.

loop_all

When set, the queue will continuously loop through all tracks.


DiscordVoiceCloseType

Bases: Enum

Enum representing the various Discord Voice Websocket Close Codes.

Attributes:

Name Type Description
CLOSE_NORMAL

1000

UNKNOWN_OPCODE

4001

FAILED_DECODE_PAYLOAD

4002

NOT_AUTHENTICATED

4003

AUTHENTICATION_FAILED

4004

ALREADY_AUTHENTICATED

4005

SESSION_INVALID

4006

SESSION_TIMEOUT

4009

SERVER_NOT_FOUND

4011

UNKNOWN_PROTOCOL

4012

DISCONNECTED

4014

VOICE_SERVER_CRASHED

4015

UNKNOWN_ENCRYPTION_MODE

4016