Getting Started:

Quickstart

You can view documentation on the core library here:

Obsidian.py Documentation
- Node
- Players
- Tracks
- Filters
- Events
- Queues
- Enums
- Stats
- Exceptions and Errors
Obsidian.py Changelog
- v0.2.0

You can view documentation on the extension here:

Adding Spotify support to Obsidian.py
- Enabling spotify support
- Making use of Spotify support

Index

A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | Q | R | S | T | U | V | W | Y

A

add() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
add_filter() (obsidian.Player method)
- (obsidian.PresetPlayer method)

add_filters() (obsidian.Player method)
- (obsidian.PresetPlayer method)
append() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
author (obsidian.Track property)

B

BANDCAMP (obsidian.enums.Source attribute)
BaseEvent (class in obsidian.events)
BaseFilter (class in obsidian)
BaseNode (class in obsidian)

bot (obsidian.BaseNode property)
by_remote (obsidian.events.WebsocketCloseEvent property)

C

cause (obsidian.events.TrackExceptionEvent property)
channel (obsidian.Player property)
- (obsidian.PresetPlayer property)
ChannelMixFilter (class in obsidian)
CLEANUP (obsidian.enums.TrackEndReason attribute)
clear() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
code (obsidian.events.WebsocketCloseEvent property)
COMMON (obsidian.enums.TrackExceptionSeverity attribute)
connect() (obsidian.BaseNode method)
connected (obsidian.BaseNode property)

copy() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
count (obsidian.Playlist property)
- (obsidian.PointerBasedQueue property)
- (obsidian.Queue property)
cpu_cores (obsidian.Stats attribute)
cpu_process_load (obsidian.Stats attribute)
cpu_system_load (obsidian.Stats attribute)
ctx (obsidian.Playlist property)
- (obsidian.Track property)
current (obsidian.Player property)
- (obsidian.PointerBasedQueue property)
- (obsidian.PresetPlayer property)
current_track_id (obsidian.Player property)
- (obsidian.PresetPlayer property)

D

decode_track() (obsidian.BaseNode method)
- (obsidian.Node method)
decode_tracks() (obsidian.BaseNode method)
- (obsidian.Node method)
destroy() (obsidian.BaseNode method)

destroy_player() (obsidian.BaseNode method)
- (obsidian.Node method)
disconnect() (obsidian.BaseNode method)
dj (obsidian.PresetPlayer property)
do_next() (obsidian.PresetPlayer method)

E

enqueue() (obsidian.PresetPlayer method)
eq (obsidian.Player property)
- (obsidian.PresetPlayer property)
Equalizer (class in obsidian)

equalizer (obsidian.Player property)
- (obsidian.PresetPlayer property)
EventType (class in obsidian.enums)
extend() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)

F

FAULT (obsidian.enums.TrackExceptionSeverity attribute)
filters (obsidian.Player property)
- (obsidian.PresetPlayer property)

FilterSink (class in obsidian)
FINISHED (obsidian.enums.TrackEndReason attribute)
full (obsidian.PointerBasedQueue property)
- (obsidian.Queue property)

G

get() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
get_player() (obsidian.BaseNode method)
- (obsidian.Node method)

guild (obsidian.Player property)
- (obsidian.PresetPlayer property)
guild_id (obsidian.events.BaseEvent property)
- (obsidian.Player property)
- (obsidian.PresetPlayer property)

H

heap_used_committed (obsidian.Stats attribute)
heap_used_init (obsidian.Stats attribute)
heap_used_max (obsidian.Stats attribute)
heap_used_used (obsidian.Stats attribute)

host (obsidian.BaseNode property)
- (obsidian.Node property)
HTTP (obsidian.enums.Source attribute)
HTTPError

I

id (obsidian.Track property)
identifier (obsidian.BaseNode property)
- (obsidian.Node property)
- (obsidian.Track property)
index (obsidian.PointerBasedQueue property)
- (obsidian.PresetPlayer property)

insert() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
internal_queue (obsidian.PointerBasedQueue property)
- (obsidian.Queue property)

K

KaraokeFilter (class in obsidian)

L

length (obsidian.Track property)
listeners (obsidian.Player property)
- (obsidian.PresetPlayer property)
LOAD_FAILED (obsidian.enums.LoadType attribute)
- (obsidian.enums.TrackEndReason attribute)

LoadType (class in obsidian.enums)
LOCAL (obsidian.enums.Source attribute)
loop_type (obsidian.PointerBasedQueue property)
LowPassFilter (class in obsidian)

M

max_size (obsidian.PointerBasedQueue property)
- (obsidian.Queue property)
message (obsidian.events.TrackExceptionEvent property)
module

move() (obsidian.Player method)
- (obsidian.PresetPlayer method)

N

name (obsidian.Playlist property)
NICO (obsidian.enums.Source attribute)
NO_MATCHES (obsidian.enums.LoadType attribute)
Node (class in obsidian)
node (obsidian.errors.ObsidianConnectionFailure attribute)
- (obsidian.Player property)
- (obsidian.PresetPlayer property)
NodeAlreadyExists

NodeCreationError
NodeNotConnected
non_heap_used_committed (obsidian.Stats attribute)
non_heap_used_init (obsidian.Stats attribute)
non_heap_used_max (obsidian.Stats attribute)
non_heap_used_used (obsidian.Stats attribute)
NoSearchMatchesFound
now_playing (obsidian.PresetPlayer property)

O

obsidian.enums
- module
obsidian.errors
- module
obsidian.events
- module
ObsidianAuthorizationFailure
ObsidianConnectionFailure

ObsidianException
ObsidianSearchFailure
ObsidianSpotifyException
on_voice_server_update() (obsidian.player.Protocol method)
on_voice_state_update() (obsidian.player.Protocol method)
original (obsidian.errors.ObsidianConnectionFailure attribute)
overwrite_filters() (obsidian.Player method)
- (obsidian.PresetPlayer method)

P

password (obsidian.BaseNode property)
- (obsidian.Node property)
paused (obsidian.Player property)
- (obsidian.PresetPlayer property)
play() (obsidian.Player method)
- (obsidian.PresetPlayer method)
Player (class in obsidian)
players_active (obsidian.Stats attribute)
players_total (obsidian.Stats attribute)
playing (obsidian.Player property)
- (obsidian.PresetPlayer property)
Playlist (class in obsidian)

PLAYLIST_LOADED (obsidian.enums.LoadType attribute)
PointerBasedQueue (class in obsidian)
pop() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
port (obsidian.BaseNode property)
- (obsidian.Node property)
position (obsidian.Player property)
- (obsidian.PresetPlayer property)
- (obsidian.Track property)
PresetPlayer (class in obsidian)
Protocol (class in obsidian.player)
put() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)

Q

Queue (class in obsidian)

queue (obsidian.PresetPlayer property)

R

reason (obsidian.events.TrackEndEvent property)
- (obsidian.events.WebsocketCloseEvent property)
region (obsidian.BaseNode property)
- (obsidian.Node property)
remove() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
remove_filter() (obsidian.Player method)
- (obsidian.PresetPlayer method)
remove_filters() (obsidian.Player method)
- (obsidian.PresetPlayer method)

REPLACED (obsidian.enums.TrackEndReason attribute)
requester (obsidian.Playlist property)
- (obsidian.Track property)
reset_filter() (obsidian.Player method)
- (obsidian.PresetPlayer method)
reset_filters() (obsidian.Player method)
- (obsidian.PresetPlayer method)
RotationFilter (class in obsidian)

S

SEARCH_RESULT (obsidian.enums.LoadType attribute)
search_track() (obsidian.BaseNode method)
- (obsidian.Node method)
search_tracks() (obsidian.BaseNode method)
- (obsidian.Node method)
seek() (obsidian.Player method)
- (obsidian.PresetPlayer method)
seekable (obsidian.Track property)
selected_track (obsidian.Playlist property)
send() (obsidian.BaseNode method)
- (obsidian.Node method)
set() (obsidian.PointerBasedQueue method)
- (obsidian.Queue method)
set_eq() (obsidian.Player method)
- (obsidian.PresetPlayer method)
set_equalizer() (obsidian.Player method)
- (obsidian.PresetPlayer method)
set_filter() (obsidian.Player method)
- (obsidian.PresetPlayer method)
set_filters() (obsidian.Player method)
- (obsidian.PresetPlayer method)
set_loop_type() (obsidian.PresetPlayer method)
set_pause() (obsidian.Player method)
- (obsidian.PresetPlayer method)

set_position() (obsidian.Player method)
- (obsidian.PresetPlayer method)
set_vol() (obsidian.Player method)
- (obsidian.PresetPlayer method)
set_volume() (obsidian.Player method)
- (obsidian.PresetPlayer method)
severity (obsidian.events.TrackExceptionEvent property)
skip() (obsidian.PointerBasedQueue method)
- (obsidian.PresetPlayer method)
- (obsidian.Queue method)
SOUNDCLOUD (obsidian.enums.Source attribute)
Source (class in obsidian.enums)
source (obsidian.Playlist property)
- (obsidian.Track property)
SPOTIFY (obsidian.enums.Source attribute)
SpotifyAuthorizationFailure
SpotifyHTTPError
Stats (class in obsidian)
stats (obsidian.BaseNode property)
- (obsidian.Node property)
stop() (obsidian.Player method)
- (obsidian.PresetPlayer method)
STOPPED (obsidian.enums.TrackEndReason attribute)
stream (obsidian.Track property)
SUSPICIOUS (obsidian.enums.TrackExceptionSeverity attribute)

T

target (obsidian.events.WebsocketOpenEvent property)
threads_daemon (obsidian.Stats attribute)
threads_peak (obsidian.Stats attribute)
threads_running (obsidian.Stats attribute)
threads_total_started (obsidian.Stats attribute)
threshold (obsidian.events.TrackStuckEvent property)
threshold_ms (obsidian.events.TrackStuckEvent property)
thumbnail (obsidian.Track property)
TimescaleFilter (class in obsidian)
title (obsidian.Track property)
Track (class in obsidian)
TRACK_END (obsidian.enums.EventType attribute)
TRACK_EXCEPTION (obsidian.enums.EventType attribute)
track_id (obsidian.events.TrackEndEvent property)

TRACK_LOADED (obsidian.enums.LoadType attribute)
TRACK_START (obsidian.enums.EventType attribute)
TRACK_STUCK (obsidian.enums.EventType attribute)
TrackEndEvent (class in obsidian.events)
TrackEndReason (class in obsidian.enums)
TrackExceptionEvent (class in obsidian.events)
TrackExceptionSeverity (class in obsidian.enums)
tracks (obsidian.Playlist property)
TrackStartEvent (class in obsidian.events)
TrackStuckEvent (class in obsidian.events)
TremoloFilter (class in obsidian)
TWITCH (obsidian.enums.Source attribute)
type (obsidian.events.BaseEvent property)

U

uri (obsidian.Playlist property)
- (obsidian.Track property)

V

VibratoFilter (class in obsidian)
VIMEO (obsidian.enums.Source attribute)
voice_client (obsidian.Player property)
- (obsidian.PresetPlayer property)

volume (obsidian.Player property)
- (obsidian.PresetPlayer property)
VolumeFilter (class in obsidian)

W

WEBSOCKET_CLOSED (obsidian.enums.EventType attribute)
WEBSOCKET_OPEN (obsidian.enums.EventType attribute)

WebsocketCloseEvent (class in obsidian.events)
WebsocketOpenEvent (class in obsidian.events)

Y

YARN (obsidian.enums.Source attribute)

YOUTUBE (obsidian.enums.Source attribute)
YOUTUBE_MUSIC (obsidian.enums.Source attribute)