pomice/docs/_build/html/searchindex.js

Search.setIndex({"docnames": ["api/enums", "api/events", "api/exceptions", "api/filters", "api/index", "api/objects", "api/player", "api/pool", "api/queue", "api/utils", "faq", "hdi/events", "hdi/filters", "hdi/index", "hdi/node", "hdi/player", "hdi/pool", "hdi/queue", "index", "installation", "quickstart"], "filenames": ["api\\enums.md", "api\\events.md", "api\\exceptions.md", "api\\filters.md", "api\\index.md", "api\\objects.md", "api\\player.md", "api\\pool.md", "api\\queue.md", "api\\utils.md", "faq.md", "hdi\\events.md", "hdi\\filters.md", "hdi\\index.md", "hdi\\node.md", "hdi\\player.md", "hdi\\pool.md", "hdi\\queue.md", "index.md", "installation.md", "quickstart.md"], "titles": ["Enums", "Events", "Exceptions", "Filters", "API Reference", "Objects", "Player", "Pool", "Queue", "Utils", "Frequently Asked Questions", "Use the Events class", "Use the Filter class", "How Do I?", "Use the Node class", "Use the Player class", "Use the NodePool class", "Use the Queue class", "Pomice", "Installation", "Quick Jumpstart"], "terms": {"class": [0, 1, 3, 4, 5, 6, 7, 8, 9, 13, 20], "pomic": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 19, 20], "loopmod": [0, 8], "valu": [0, 3, 6, 14, 15, 16], "base": [0, 1, 2, 3, 5, 6, 7, 8, 9, 16, 19], "The": [0, 1, 2, 3, 5, 6, 7, 9, 14, 15, 16], "differ": [0, 4, 15, 16], "loop": [0, 8], "mode": [0, 8], "thi": [0, 2, 3, 6, 7, 8, 9, 10, 13, 14, 15, 16, 19, 20], "featur": [0, 16, 18, 19], "i": [0, 1, 2, 3, 6, 7, 8, 9, 10, 14, 15, 16, 18, 19, 20], "exclus": 0, "queue": [0, 2, 4, 13, 14, 15], "util": [0, 4], "If": [0, 1, 3, 6, 7, 8, 10, 13, 14, 15, 16, 19, 20], "you": [0, 1, 3, 4, 5, 6, 7, 10, 13, 14, 15, 16, 19, 20], "ar": [0, 2, 6, 7, 10, 14, 15, 16, 19], "us": [0, 2, 3, 4, 6, 7, 9, 10, 13, 18, 19, 20], "necessari": [0, 3], "track": [0, 1, 2, 3, 5, 6, 7, 8, 13, 16, 20], "set": [0, 3, 6, 7, 8, 13, 14, 16, 19], "current": [0, 2, 3, 6, 8, 15], "whole": 0, "nodealgorithm": [0, 7, 16], "node": [0, 1, 2, 6, 7, 9, 10, 13, 15, 19, 20], "algorithm": [0, 7, 16], "onli": [0, 6], "differenti": 0, "method": [0, 3, 4, 6, 7], "sinc": 0, "actual": 0, "handl": [0, 6, 14, 15, 19], "get_best_nod": [0, 7, 16], "by_p": [0, 7, 16], "return": [0, 1, 5, 6, 7, 8, 14, 15, 16], "": [0, 1, 2, 3, 6, 7, 8, 10, 15, 19], "latenc": [0, 7, 14], "prefer": [0, 3, 7, 10], "lowest": 0, "respons": 0, "time": [0, 15], "by_play": [0, 7, 16], "how": [0, 7, 10, 14, 15, 18, 19, 20], "mani": [0, 7, 8, 14], "player": [0, 1, 4, 7, 13, 20], "ha": [0, 1, 6, 7, 8, 14, 15, 16], "least": [0, 7], "amount": [0, 3, 7, 8, 15], "platformrecommend": 0, "choos": [0, 7], "what": [0, 10, 15, 16], "platform": 0, "want": [0, 1, 7, 10, 14, 15, 16, 19, 20], "recommend": [0, 6, 7, 13], "function": [0, 2, 13, 14, 15, 16, 18], "spotifi": [0, 2, 5, 6, 7, 14, 15, 16, 18], "come": 0, "from": [0, 2, 3, 6, 7, 8, 9, 14, 15, 16, 20], "youtub": [0, 6, 7], "playlisttyp": [0, 5], "playlist": [0, 2, 5, 6, 7, 14, 15, 20], "type": [0, 14, 15, 16, 20], "defin": 0, "soundcloud": 0, "apple_mus": [0, 7, 16], "appl": [0, 2, 5, 7, 14, 15, 16, 18], "music": [0, 2, 3, 5, 7, 14, 15, 16, 18, 19, 20], "apple_music_list": 0, "soundcloud_playlist": 0, "spotify_playlist": 0, "youtube_playlist": 0, "routeiptyp": 0, "specifi": [0, 3, 8, 14, 15, 16, 20], "rout": 0, "planner": 0, "ip": [0, 16], "block": 0, "lavalink": [0, 2, 3, 5, 6, 7, 10, 14, 15, 16, 18, 19], "routeplann": 0, "ipv4": 0, "ipv6": 0, "inet4address": 0, "inet6address": 0, "routestrategi": 0, "strategi": 0, "rotate_on_ban": 0, "rotat": [0, 3], "whenev": 0, "thei": [0, 16], "get": [0, 5, 6, 7, 8, 13, 19], "ban": 0, "load_bal": 0, "select": 0, "random": [0, 7, 16], "balanc": 0, "out": [0, 3, 9, 19], "request": [0, 2, 5, 6], "between": 0, "them": [0, 13, 16], "nano_switch": 0, "switch": 0, "everi": [0, 1, 9], "cpu": 0, "clock": 0, "cycl": 0, "rotating_nano_switch": 0, "balancingiprouteplann": 0, "nanoiprouteplann": 0, "rotatingiprouteplann": 0, "rotatingnanoiprouteplann": 0, "searchtyp": [0, 5, 6, 7, 14, 15], "search": [0, 2, 6, 7, 14, 15, 20], "ytsearch": [0, 5, 6, 7, 14, 15], "regular": 0, "which": [0, 3, 6, 7, 9, 14, 15, 19], "best": [0, 3, 7, 13], "all": [0, 1, 2, 3, 6, 7, 8, 9, 13, 14, 15, 16, 19], "scenario": 0, "ytmsearch": 0, "audio": [0, 3, 19], "result": [0, 20], "scsearch": 0, "an": [0, 2, 3, 5, 6, 7, 8, 9, 15, 19], "altern": 0, "tracktyp": [0, 5], "http": [0, 20], "sourc": 0, "apple_music_track": 0, "http_sourc": 0, "soundcloud_track": 0, "spotify_track": 0, "youtube_track": 0, "urlregex": 0, "object": [0, 1, 3, 4, 6, 7, 8, 9, 14, 15, 16], "url": [0, 5, 6, 7, 16], "regex": 0, "spotify_url": 0, "discord_mp3_url": 0, "discord": [0, 5, 6, 7, 10, 14, 16, 18, 19, 20], "mp3": 0, "youtube_url": 0, "youtube_timestamp": 0, "timestamp": [0, 5], "am_url": 0, "soundcloud_url": 0, "base_url": 0, "standard": 0, "am_single_in_album_regex": 0, "re": [0, 20], "compil": [0, 20], "com": 0, "p": 0, "countri": 0, "za": 0, "z": 0, "2": [0, 3, 6], "album": [0, 2, 5, 6, 7], "song": [0, 3, 6, 15], "artist": 0, "name": [0, 1, 14, 15, 16, 20], "id": [0, 7, 14, 16], "id2": 0, "www": [0, 20], "cdn": 0, "discordapp": 0, "attach": 0, "channel_id": 0, "0": [0, 2, 3, 6, 15, 20], "9": 0, "message_id": 0, "file": [0, 9], "z0": 0, "9_": 0, "lavalink_search": 0, "ytm": 0, "sc": 0, "soundcloud_playlist_url": 0, "m": [0, 20], "soundcloud_track_in_set_url": 0, "_": [0, 1], "open": 0, "youtube_playlist_url": 0, "youtu": 0, "list": [0, 3, 5, 6, 7, 8, 10, 14, 15, 16], "video": 0, "t": [0, 8, 10, 16], "start": [0, 1, 6, 15, 19, 20], "d": 0, "w": 0, "v": 0, "emb": 0, "youtube_vid_in_playlist": 0, "pomiceev": 1, "dispatch": 1, "must": [1, 2, 3, 6, 7, 15, 20], "format": [1, 3, 6], "within": [1, 4, 6, 8, 15, 16, 18, 19], "your": [1, 5, 6, 7, 10, 14, 15, 16, 18, 19], "bot": [1, 6, 7, 14, 15, 16, 18, 20], "code": [1, 19], "listen": [1, 3, 20], "e": [1, 3, 6], "when": [1, 2, 3, 6, 8, 14, 15, 16], "would": [1, 6, 13, 14, 15, 16], "py": [1, 5, 6, 7, 10, 14, 16, 18], "async": [1, 6, 7, 20], "def": [1, 20], "on_pomice_track_start": 1, "self": [1, 6, 20], "union": [1, 5, 6, 7, 14, 15], "client": [1, 2, 6, 7, 14, 15, 16, 18], "handler_arg": 1, "trackendev": 1, "data": [1, 6, 7, 9], "dict": [1, 5, 6, 7, 9, 14], "fire": 1, "successfulli": 1, "end": [1, 6, 8, 15, 16], "associ": [1, 6, 9, 14, 15], "along": [1, 16], "reason": 1, "track_end": 1, "trackexceptionev": 1, "error": [1, 2], "occur": 1, "except": [1, 4, 8], "track_except": 1, "trackstartev": 1, "track_start": 1, "trackstuckev": 1, "stuck": 1, "cannot": [1, 10], "plai": [1, 3, 6, 7, 13, 14, 20], "further": 1, "pars": [1, 5, 6, 7], "user": [1, 5, 19], "track_stuck": 1, "websocketclosedev": 1, "websocket": 1, "connect": [1, 2, 6, 7, 9, 10, 13, 14, 16, 20], "been": [1, 6, 15], "close": [1, 2], "websocket_clos": 1, "websocketclosedpayload": 1, "websocketopenev": 1, "initi": [1, 6, 7, 14, 15, 16], "target": 1, "session": [1, 7], "ssrc": 1, "websocket_open": 1, "applemusicnoten": 2, "pomiceexcept": 2, "link": [2, 7, 14], "wa": [2, 3], "pass": [2, 3, 5, 6, 7, 15], "enabl": [2, 7, 8, 14, 15, 16], "filterinvalidargu": 2, "invalid": 2, "argument": [2, 8, 20], "filter": [2, 4, 5, 6, 7, 8, 13, 14], "filtertagalreadyinus": 2, "A": [2, 6, 9, 15, 16], "tag": [2, 3, 6], "alreadi": [2, 8], "anoth": 2, "filtertaginvalid": 2, "unabl": 2, "find": [2, 4, 8, 13, 14], "invalidspotifyclientauthor": 2, "No": [2, 20], "author": [2, 6, 9, 20], "provid": [2, 7, 9, 14, 15, 19], "lavalinkversionincompat": 2, "version": [2, 3, 6], "incompat": 2, "3": 2, "7": 2, "avoid": 2, "nonodesavail": 2, "There": [2, 14, 15], "avail": [2, 8, 15, 16], "nodeconnectionclos": 2, "nodeexcept": 2, "nodeconnectionfailur": 2, "problem": 2, "while": [2, 19], "nodecreationerror": 2, "creat": [2, 6, 7, 8, 14, 15, 16], "nodenotavail": 2, "unavail": 2, "noderestexcept": 2, "made": [2, 19], "rest": [2, 6, 7], "uri": [2, 5], "fail": [2, 6], "queueempti": [2, 8], "queueexcept": [2, 8], "rais": [2, 8, 20], "attempt": 2, "retriev": 2, "empti": [2, 6], "queueful": 2, "add": [2, 6, 7, 8, 15, 16, 19], "full": [2, 3], "spotifyalbumloadfail": 2, "load": 2, "spotifyplaylistloadfail": 2, "spotifytrackloadfail": 2, "trackinvalidposit": 2, "posit": [2, 6, 8, 13], "chosen": 2, "trackloaderror": 2, "channelmix": 3, "str": [3, 5, 6, 7, 14, 15, 16, 20], "left_to_left": 3, "float": [3, 5, 6, 9, 14, 15], "1": [3, 9, 20], "right_to_right": 3, "left_to_right": 3, "right_to_left": 3, "manual": 3, "adjust": [3, 15], "pan": 3, "can": [3, 5, 6, 7, 10, 14, 15, 16, 18, 19], "make": [3, 15, 18], "some": [3, 6, 10, 14, 15], "cool": 3, "effect": 3, "done": 3, "correctli": 3, "distort": 3, "sin_offset": 3, "sin_scal": 3, "cos_offset": 3, "cos_scal": 3, "tan_offset": 3, "tan_scal": 3, "offset": 3, "scale": 3, "gener": 3, "certain": [3, 13, 14, 15, 16], "implement": [3, 14, 15, 19], "where": 3, "need": [3, 5, 10, 14, 15, 16, 19], "equal": 3, "level": 3, "repres": [3, 6, 7], "15": 3, "band": 3, "dynam": 3, "sound": [3, 15], "appli": [3, 6, 7, 8, 14, 15], "bass": 3, "boost": 3, "emphas": 3, "tupl": 3, "int": [3, 6, 7, 8, 9, 14, 15, 16], "classmethod": [3, 7], "preset": 3, "fun": 3, "energet": 3, "increas": 3, "high": 3, "flat": 3, "eq": 3, "board": 3, "default": [3, 6, 14, 15, 16], "metal": 3, "mid": 3, "one": [3, 14], "genr": 3, "more": [3, 10, 19], "concert": 3, "like": [3, 6, 14, 15, 16], "piano": 3, "stand": 3, "have": [3, 6, 10, 13, 14, 15, 16, 19], "latest": 3, "instal": [3, 10, 18], "do": [3, 9, 10, 14, 15, 16, 18], "work": [3, 6, 7, 10, 15, 16, 19], "each": 3, "put": [3, 8, 14, 15], "remov": [3, 6, 7, 8, 15], "set_preload": 3, "bool": [3, 6, 7, 8, 9, 14, 15, 16], "intern": [3, 6], "whether": [3, 6, 7, 9, 14, 15], "preload": [3, 6], "karaok": 3, "mono_level": 3, "filter_band": 3, "220": 3, "filter_width": 3, "100": [3, 18], "vocal": 3, "ani": [3, 6, 7, 8, 9, 10, 19], "leav": 3, "instrument": 3, "impli": [3, 9], "lowpass": 3, "smooth": [3, 19], "20": 3, "supress": 3, "higher": [3, 15], "frequenc": 3, "allow": 3, "lower": [3, 15], "also": [3, 5, 6, 7, 14, 15, 18, 19], "easier": [3, 18], "wai": [3, 19], "rotation_hertz": 3, "5": 3, "produc": 3, "stereo": 3, "being": [3, 19], "around": 3, "head": 3, "timescal": 3, "speed": 3, "pitch": 3, "rate": 3, "chang": [3, 6], "veri": 3, "nice": 3, "vaporwav": 3, "esqu": 3, "slow": 3, "down": 3, "said": 3, "nightcor": 3, "up": [3, 14, 15, 16, 19], "match": 3, "sped": 3, "assign": 3, "give": [3, 9], "half": 3, "record": 3, "casett": 3, "tremolo": 3, "depth": 3, "waver": 3, "tone": 3, "caus": 3, "volum": [3, 6, 13], "rapidli": 3, "vibrato": 3, "similar": 3, "rather": [3, 13], "than": [3, 15, 19], "here": [4, 10, 14, 15, 16, 19, 20], "enum": [4, 8, 14, 15, 16], "event": [4, 9, 13], "pool": [4, 14, 16], "playlist_info": 5, "playlist_typ": 5, "thumbnail": 5, "option": [5, 6, 7, 8, 14, 15, 16], "none": [5, 6, 7, 8, 20], "critic": [5, 9], "inform": [5, 9, 10], "command": [5, 14, 15, 16, 20], "context": [5, 6, 7, 14, 15, 20], "properti": [5, 6, 7, 8, 14, 15], "either": [5, 6, 7, 8, 10, 15, 16], "its": [5, 6], "neither": 5, "those": [5, 14, 15, 16], "track_id": 5, "info": 5, "ctx": [5, 6, 7, 14, 15, 20], "track_typ": 5, "search_typ": [5, 6, 7, 14, 15], "member": [5, 8], "helper": [6, 15], "add_filt": [6, 15], "check": 6, "get_all_payload": 6, "payload": 6, "get_filt": 6, "get_preload_filt": 6, "has_filt": 6, "filter_tag": 6, "exist": [6, 14], "has_glob": 6, "global": 6, "has_preload": 6, "were": [6, 20], "remove_filt": [6, 15], "reset_filt": [6, 15], "channel": [6, 10, 15, 20], "voicechannel": 6, "voiceprotocol": 6, "In": [6, 19], "order": [6, 19], "cl": [6, 15, 20], "await": [6, 14, 15, 16, 20], "voic": [6, 7, 20], "fast_appli": [6, 15], "fals": [6, 7, 8, 9, 15], "take": [6, 7, 8, 19], "support": [6, 10], "instantli": [6, 15], "arg": 6, "true": [6, 7, 8, 15, 16], "instanc": [6, 15], "timeout": 6, "reconnect": 6, "self_deaf": 6, "self_mut": 6, "coro": 6, "abstract": 6, "call": 6, "librari": [6, 10, 18, 19], "constructor": 6, "under": 6, "__init__": [6, 20], "point": 6, "disconnect": [6, 7], "flow": 6, "guild": [6, 7, 14, 15], "change_voice_st": 6, "after": [6, 14, 15, 16, 19], "on_voice_server_upd": 6, "on_voice_state_upd": 6, "two": 6, "unspecifi": 6, "expect": 6, "indic": 6, "should": [6, 14, 15, 16], "mute": 6, "new": [6, 8], "deafen": 6, "destroi": [6, 7, 13], "run": [6, 14, 15, 16, 20], "cleanup": 6, "forc": 6, "interact": [6, 14, 15], "get_recommend": [6, 7, 14, 15], "get_track": [6, 7, 14, 15, 20], "queri": [6, 7, 14, 15, 18, 20], "fetch": [6, 7, 14, 15], "api": [6, 7, 10, 13, 18, 19], "credenti": [6, 7], "accordingli": [6, 7], "mai": [6, 7], "onc": [6, 7], "is_connect": [6, 7, 14, 15], "is_dead": [6, 15], "dead": [6, 15], "consid": [6, 15], "store": [6, 15], "is_paus": [6, 15], "paus": [6, 13], "is_plai": [6, 15], "activ": [6, 15, 20], "correspond": 6, "voice_server_upd": 6, "raw": 6, "ddoc": 6, "server": 6, "updat": [6, 9], "topic": 6, "gatewai": 6, "state": 6, "voice_state_upd": 6, "resourc": [6, 10, 19], "ignore_if_plai": [6, 15], "millisecond": [6, 15], "reset": 6, "seek": [6, 13], "set_paus": [6, 15], "set_volum": [6, 15], "integ": [6, 15], "accept": [6, 15], "500": [6, 15], "stop": [6, 13], "host": [7, 10, 16, 20], "port": [7, 16, 20], "password": [7, 16, 20], "identifi": [7, 16, 20], "secur": 7, "heartbeat": 7, "30": 7, "clientsess": 7, "spotify_client_id": [7, 16], "spotify_client_secret": [7, 16], "To": [7, 14, 15, 16], "proper": [7, 10, 14, 15, 16], "secret": [7, 16], "paramet": [7, 14, 15, 16], "build_track": 7, "build": 7, "valid": 7, "get_play": [7, 14], "guild_id": [7, 14], "els": [7, 20], "ping": [7, 14], "alia": 7, "player_count": [7, 14], "contain": [7, 14], "apart": [7, 14], "send": [7, 20], "path": 7, "include_vers": 7, "stat": [7, 9, 14], "nodestat": [7, 9, 14], "nodepool": [7, 13, 14, 20], "hold": 7, "create_nod": [7, 16, 20], "ad": [7, 8, 13, 14], "For": [7, 10, 16], "capabilit": [7, 18], "multi": 7, "setup": 7, "region": 7, "get_nod": [7, 16], "node_count": 7, "max_siz": 8, "overflow": 8, "iter": 8, "input": [8, 15], "includ": [8, 9, 15, 16, 18], "shuffl": 8, "clear": 8, "item": 8, "clear_track_filt": 8, "copi": [8, 9], "count": 8, "disable_loop": 8, "disabl": 8, "extend": 8, "atom": 8, "given": 8, "upon": 8, "possibl": 8, "won": 8, "prevent": 8, "drop": [8, 19], "find_posit": 8, "valueerror": 8, "next": [8, 18], "immedi": 8, "get_queu": 8, "is_empti": 8, "is_ful": 8, "reach": 8, "is_loop": 8, "jump": 8, "begin": 8, "loop_mod": 8, "pop": 8, "right": [8, 9], "side": 8, "back": 8, "put_at_front": 8, "front": 8, "put_at_index": 8, "index": 8, "set_loop_mod": 8, "size": 8, "exponentialbackoff": 9, "integr": 9, "mit": 9, "licens": 9, "copyright": 9, "c": 9, "2015": 9, "present": 9, "rapptz": 9, "permiss": 9, "herebi": 9, "grant": 9, "free": [9, 16, 19], "charg": 9, "person": 9, "obtain": 9, "softwar": 9, "document": 9, "deal": 9, "without": [9, 15, 19, 20], "restrict": 9, "limit": 9, "modifi": 9, "merg": 9, "publish": 9, "distribut": 9, "sublicens": 9, "sell": 9, "permit": 9, "whom": 9, "furnish": 9, "so": [9, 16, 19], "subject": 9, "follow": 9, "condit": 9, "abov": 9, "notic": 9, "shall": 9, "substanti": 9, "portion": 9, "THE": 9, "AS": 9, "warranti": 9, "OF": 9, "kind": 9, "express": 9, "OR": 9, "BUT": 9, "NOT": 9, "TO": 9, "merchant": 9, "fit": 9, "FOR": 9, "particular": 9, "purpos": 9, "AND": 9, "noninfring": 9, "IN": 9, "NO": 9, "holder": 9, "BE": 9, "liabl": 9, "claim": 9, "damag": 9, "other": [9, 10, 16], "liabil": 9, "action": 9, "contract": 9, "tort": 9, "otherwis": 9, "aris": 9, "WITH": 9, "delai": 9, "minut": 9, "why": 10, "sai": 10, "common": 10, "issu": 10, "don": [10, 16], "configur": 10, "properli": 10, "unreach": 10, "due": 10, "firewal": 10, "rule": 10, "malform": 10, "network": 10, "experienc": 10, "first": [10, 16], "download": [10, 19], "As": 10, "consult": 10, "doc": 10, "go": 10, "through": 10, "specfic": 10, "hand": 10, "pleas": [10, 19], "experi": 10, "assum": 10, "python": [10, 18], "asynchron": [10, 18], "program": 10, "refer": [10, 13, 14, 15, 16, 18, 19], "section": [10, 13, 16, 19], "interest": 10, "learn": [10, 14, 15], "quick": [10, 19], "exampl": [10, 19, 20], "quickstart": [10, 18], "cover": 13, "basic": 13, "too": 13, "confus": 13, "straightforward": 13, "explan": 13, "three": 16, "main": [14, 16, 20], "our": [14, 15, 16, 19], "we": [14, 15, 16, 18], "fill": [14, 15, 16], "rememb": 16, "field": 16, "By": 16, "2333": 16, "distinguish": 16, "itself": 16, "goe": 16, "later": 16, "look": [14, 15, 16, 20], "someth": [14, 15, 16], "note": [], "requir": [16, 19], "anyth": [16, 19], "queu": 16, "anywai": 16, "becaus": 16, "now": [15, 16], "move": 16, "see": [15, 16], "grab": 16, "ll": [14, 16], "view": 16, "xyz": 16, "fulli": 18, "design": [18, 19], "commun": 18, "seamlessli": 18, "It": 18, "coverag": 18, "entir": 18, "spec": 18, "access": [14, 15, 18], "easi": [18, 19], "understand": 18, "built": 18, "custom": 18, "develop": 18, "big": 18, "frequent": [14, 15, 18], "ask": 18, "question": 18, "deliveri": 19, "system": 19, "directli": 19, "interfac": 19, "butteri": 19, "wast": 19, "preciou": 19, "conveni": 19, "everyth": 19, "customiz": 19, "pip": 19, "depend": [15, 19], "hitch": 19, "familiar": 19, "just": 19, "advanc": 19, "cog": [19, 20], "advantag": 19, "applic": 19, "outsid": 19, "below": 20, "import": 20, "ext": 20, "url_reg": 20, "r": 20, "mybot": 20, "super": 20, "command_prefix": 20, "activitytyp": 20, "add_cog": 20, "on_readi": 20, "print": 20, "onlin": 20, "start_nod": 20, "127": 20, "3030": 20, "youshallnotpass": 20, "f": 20, "readi": 20, "join": 20, "alias": 20, "textchannel": 20, "getattr": 20, "checkfailur": 20, "voice_cli": [15, 20], "invok": 20, "commanderror": 20, "found": 20, "term": 20, "isinst": 20, "token": 20, "tabl": [], "header": [], "row": [], "descript": [14, 15, 16], "most": 15, "coupl": [14, 15], "same": [14, 15], "thing": [14, 15], "regardless": 14, "string": [14, 15], "whatev": [14, 15], "ideal": [14, 15], "sort": [14, 15], "about": [14, 15], "recommad": 14, "control": 13, "unpaus": 13, "voice_channel": 15, "few": 15, "ignor": 15, "replac": 15, "boolean": 15, "mean": 15, "po": 15, "rang": 15, "extens": 15, "suit": 15, "manag": 15, "tool": 15, "help": 15, "almost": 15, "chose": 15}, "objects": {"pomice": [[0, 0, 0, "-", "enums"], [1, 0, 0, "-", "events"], [2, 0, 0, "-", "exceptions"], [3, 0, 0, "-", "filters"], [5, 0, 0, "-", "objects"], [6, 0, 0, "-", "player"], [7, 0, 0, "-", "pool"], [8, 0, 0, "-", "queue"], [9, 0, 0, "-", "utils"]], "pomice.enums": [[0, 1, 1, "", "LoopMode"], [0, 1, 1, "", "NodeAlgorithm"], [0, 1, 1, "", "PlatformRecommendation"], [0, 1, 1, "", "PlaylistType"], [0, 1, 1, "", "RouteIPType"], [0, 1, 1, "", "RouteStrategy"], [0, 1, 1, "", "SearchType"], [0, 1, 1, "", "TrackType"], [0, 1, 1, "", "URLRegex"]], "pomice.enums.LoopMode": [[0, 2, 1, "", "QUEUE"], [0, 2, 1, "", "TRACK"]], "pomice.enums.NodeAlgorithm": [[0, 2, 1, "", "by_ping"], [0, 2, 1, "", "by_players"]], "pomice.enums.PlatformRecommendation": [[0, 2, 1, "", "SPOTIFY"], [0, 2, 1, "", "YOUTUBE"]], "pomice.enums.PlaylistType": [[0, 2, 1, "", "APPLE_MUSIC"], [0, 2, 1, "", "SOUNDCLOUD"], [0, 2, 1, "", "SPOTIFY"], [0, 2, 1, "", "YOUTUBE"]], "pomice.enums.RouteIPType": [[0, 2, 1, "", "IPV4"], [0, 2, 1, "", "IPV6"]], "pomice.enums.RouteStrategy": [[0, 2, 1, "", "LOAD_BALANCE"], [0, 2, 1, "", "NANO_SWITCH"], [0, 2, 1, "", "ROTATE_ON_BAN"], [0, 2, 1, "", "ROTATING_NANO_SWITCH"]], "pomice.enums.SearchType": [[0, 2, 1, "", "scsearch"], [0, 2, 1, "", "ytmsearch"], [0, 2, 1, "", "ytsearch"]], "pomice.enums.TrackType": [[0, 2, 1, "", "APPLE_MUSIC"], [0, 2, 1, "", "HTTP"], [0, 2, 1, "", "SOUNDCLOUD"], [0, 2, 1, "", "SPOTIFY"], [0, 2, 1, "", "YOUTUBE"]], "pomice.enums.URLRegex": [[0, 2, 1, "", "AM_SINGLE_IN_ALBUM_REGEX"], [0, 2, 1, "", "AM_URL"], [0, 2, 1, "", "BASE_URL"], [0, 2, 1, "", "DISCORD_MP3_URL"], [0, 2, 1, "", "LAVALINK_SEARCH"], [0, 2, 1, "", "SOUNDCLOUD_PLAYLIST_URL"], [0, 2, 1, "", "SOUNDCLOUD_TRACK_IN_SET_URL"], [0, 2, 1, "", "SOUNDCLOUD_URL"], [0, 2, 1, "", "SPOTIFY_URL"], [0, 2, 1, "", "YOUTUBE_PLAYLIST_URL"], [0, 2, 1, "", "YOUTUBE_TIMESTAMP"], [0, 2, 1, "", "YOUTUBE_URL"], [0, 2, 1, "", "YOUTUBE_VID_IN_PLAYLIST"]], "pomice.events": [[1, 1, 1, "", "PomiceEvent"], [1, 1, 1, "", "TrackEndEvent"], [1, 1, 1, "", "TrackExceptionEvent"], [1, 1, 1, "", "TrackStartEvent"], [1, 1, 1, "", "TrackStuckEvent"], [1, 1, 1, "", "WebSocketClosedEvent"], [1, 1, 1, "", "WebSocketClosedPayload"], [1, 1, 1, "", "WebSocketOpenEvent"]], "pomice.events.PomiceEvent": [[1, 3, 1, "", "dispatch"], [1, 2, 1, "", "handler_args"], [1, 2, 1, "", "name"]], "pomice.events.TrackEndEvent": [[1, 2, 1, "", "name"]], "pomice.events.TrackExceptionEvent": [[1, 2, 1, "", "name"]], "pomice.events.TrackStartEvent": [[1, 2, 1, "", "name"]], "pomice.events.TrackStuckEvent": [[1, 2, 1, "", "name"]], "pomice.events.WebSocketClosedEvent": [[1, 2, 1, "", "name"]], "pomice.events.WebSocketOpenEvent": [[1, 2, 1, "", "name"]], "pomice.exceptions": [[2, 4, 1, "", "AppleMusicNotEnabled"], [2, 4, 1, "", "FilterInvalidArgument"], [2, 4, 1, "", "FilterTagAlreadyInUse"], [2, 4, 1, "", "FilterTagInvalid"], [2, 4, 1, "", "InvalidSpotifyClientAuthorization"], [2, 4, 1, "", "LavalinkVersionIncompatible"], [2, 4, 1, "", "NoNodesAvailable"], [2, 4, 1, "", "NodeConnectionClosed"], [2, 4, 1, "", "NodeConnectionFailure"], [2, 4, 1, "", "NodeCreationError"], [2, 4, 1, "", "NodeException"], [2, 4, 1, "", "NodeNotAvailable"], [2, 4, 1, "", "NodeRestException"], [2, 4, 1, "", "PomiceException"], [2, 4, 1, "", "QueueEmpty"], [2, 4, 1, "", "QueueException"], [2, 4, 1, "", "QueueFull"], [2, 4, 1, "", "SpotifyAlbumLoadFailed"], [2, 4, 1, "", "SpotifyPlaylistLoadFailed"], [2, 4, 1, "", "SpotifyTrackLoadFailed"], [2, 4, 1, "", "TrackInvalidPosition"], [2, 4, 1, "", "TrackLoadError"]], "pomice.filters": [[3, 1, 1, "", "ChannelMix"], [3, 1, 1, "", "Distortion"], [3, 1, 1, "", "Equalizer"], [3, 1, 1, "", "Filter"], [3, 1, 1, "", "Karaoke"], [3, 1, 1, "", "LowPass"], [3, 1, 1, "", "Rotation"], [3, 1, 1, "", "Timescale"], [3, 1, 1, "", "Tremolo"], [3, 1, 1, "", "Vibrato"]], "pomice.filters.Equalizer": [[3, 3, 1, "", "boost"], [3, 3, 1, "", "flat"], [3, 3, 1, "", "metal"], [3, 3, 1, "", "piano"]], "pomice.filters.Filter": [[3, 3, 1, "", "set_preload"]], "pomice.filters.Timescale": [[3, 3, 1, "", "nightcore"], [3, 3, 1, "", "vaporwave"]], "pomice.objects": [[5, 1, 1, "", "Playlist"], [5, 1, 1, "", "Track"]], "pomice.objects.Playlist": [[5, 5, 1, "", "thumbnail"], [5, 5, 1, "", "uri"]], "pomice.player": [[6, 1, 1, "", "Filters"], [6, 1, 1, "", "Player"]], "pomice.player.Filters": [[6, 3, 1, "", "add_filter"], [6, 5, 1, "", "empty"], [6, 3, 1, "", "get_all_payloads"], [6, 3, 1, "", "get_filters"], [6, 3, 1, "", "get_preload_filters"], [6, 3, 1, "", "has_filter"], [6, 5, 1, "", "has_global"], [6, 5, 1, "", "has_preload"], [6, 3, 1, "", "remove_filter"], [6, 3, 1, "", "reset_filters"]], "pomice.player.Player": [[6, 3, 1, "", "add_filter"], [6, 5, 1, "", "bot"], [6, 3, 1, "", "connect"], [6, 5, 1, "", "current"], [6, 3, 1, "", "destroy"], [6, 3, 1, "", "disconnect"], [6, 5, 1, "", "filters"], [6, 3, 1, "", "get_recommendations"], [6, 3, 1, "", "get_tracks"], [6, 5, 1, "", "guild"], [6, 5, 1, "", "is_connected"], [6, 5, 1, "", "is_dead"], [6, 5, 1, "", "is_paused"], [6, 5, 1, "", "is_playing"], [6, 5, 1, "", "node"], [6, 3, 1, "", "on_voice_server_update"], [6, 3, 1, "", "on_voice_state_update"], [6, 3, 1, "", "play"], [6, 5, 1, "", "position"], [6, 3, 1, "", "remove_filter"], [6, 3, 1, "", "reset_filters"], [6, 3, 1, "", "seek"], [6, 3, 1, "", "set_pause"], [6, 3, 1, "", "set_volume"], [6, 3, 1, "", "stop"], [6, 5, 1, "", "volume"]], "pomice.pool": [[7, 1, 1, "", "Node"], [7, 1, 1, "", "NodePool"]], "pomice.pool.Node": [[7, 5, 1, "", "bot"], [7, 3, 1, "", "build_track"], [7, 3, 1, "", "connect"], [7, 3, 1, "", "disconnect"], [7, 3, 1, "", "get_player"], [7, 3, 1, "", "get_recommendations"], [7, 3, 1, "", "get_tracks"], [7, 5, 1, "", "is_connected"], [7, 5, 1, "", "latency"], [7, 5, 1, "", "ping"], [7, 5, 1, "", "player_count"], [7, 5, 1, "", "players"], [7, 5, 1, "", "pool"], [7, 3, 1, "", "send"], [7, 5, 1, "", "stats"]], "pomice.pool.NodePool": [[7, 3, 1, "", "create_node"], [7, 3, 1, "", "get_best_node"], [7, 3, 1, "", "get_node"], [7, 5, 1, "", "node_count"], [7, 5, 1, "", "nodes"]], "pomice.queue": [[8, 1, 1, "", "Queue"]], "pomice.queue.Queue": [[8, 3, 1, "", "clear"], [8, 3, 1, "", "clear_track_filters"], [8, 3, 1, "", "copy"], [8, 5, 1, "", "count"], [8, 3, 1, "", "disable_loop"], [8, 3, 1, "", "extend"], [8, 3, 1, "", "find_position"], [8, 3, 1, "", "get"], [8, 3, 1, "", "get_queue"], [8, 5, 1, "", "is_empty"], [8, 5, 1, "", "is_full"], [8, 5, 1, "", "is_looping"], [8, 3, 1, "", "jump"], [8, 5, 1, "", "loop_mode"], [8, 3, 1, "", "pop"], [8, 3, 1, "", "put"], [8, 3, 1, "", "put_at_front"], [8, 3, 1, "", "put_at_index"], [8, 3, 1, "", "remove"], [8, 3, 1, "", "set_loop_mode"], [8, 3, 1, "", "shuffle"], [8, 5, 1, "", "size"]], "pomice.utils": [[9, 1, 1, "", "ExponentialBackoff"], [9, 1, 1, "", "NodeStats"]], "pomice.utils.ExponentialBackoff": [[9, 3, 1, "", "delay"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:exception", "5": "py:property"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "exception", "Python exception"], "5": ["py", "property", "Python property"]}, "titleterms": {"enum": 0, "event": [1, 11], "except": 2, "filter": [3, 12, 15], "api": 4, "refer": 4, "object": 5, "player": [6, 14, 15], "paramet": 6, "pool": 7, "queue": [8, 17], "util": 9, "frequent": 10, "ask": 10, "question": 10, "us": [11, 12, 14, 15, 16, 17], "class": [11, 12, 14, 15, 16, 17], "how": 13, "do": 13, "i": 13, "node": [14, 16], "nodepool": 16, "ad": [15, 16], "get": [14, 15, 16], "best": 16, "pomic": 18, "quick": [18, 20], "link": 18, "instal": 19, "jumpstart": 20, "track": [14, 15], "recommend": [14, 15], "connect": 15, "control": 15, "destroi": 15, "plai": 15, "seek": 15, "posit": 15, "paus": 15, "unpaus": 15, "set": 15, "volum": 15, "stop": 15}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Enums": [[0, "module-pomice.enums"]], "Events": [[1, "module-pomice.events"]], "Exceptions": [[2, "module-pomice.exceptions"]], "Filters": [[3, "module-pomice.filters"]], "API Reference": [[4, "api-reference"]], "Objects": [[5, "module-pomice.objects"]], "Player": [[6, "module-pomice.player"]], "Parameters": [[6, "parameters"], [6, "id1"], [6, "id4"]], "Pool": [[7, "module-pomice.pool"]], "Queue": [[8, "module-pomice.queue"]], "Utils": [[9, "module-pomice.utils"]], "Frequently Asked Questions": [[10, "frequently-asked-questions"]], "Use the Events class": [[11, "use-the-events-class"]], "Use the Filter class": [[12, "use-the-filter-class"]], "Use the Queue class": [[17, "use-the-queue-class"]], "Pomice": [[18, "pomice"]], "Quick Links:": [[18, "quick-links"]], "Installation": [[19, "installation"]], "Quick Jumpstart": [[20, "quick-jumpstart"]], "Use the NodePool class": [[16, "use-the-nodepool-class"]], "Adding a node": [[16, "adding-a-node"]], "Getting a node": [[16, "getting-a-node"]], "Getting the best node": [[16, "getting-the-best-node"]], "Use the Node class": [[14, "use-the-node-class"]], "Getting a player": [[14, "getting-a-player"]], "Getting tracks": [[14, "getting-tracks"], [15, "getting-tracks"]], "Getting recommendations": [[14, "getting-recommendations"], [15, "getting-recommendations"]], "How Do I?": [[13, "how-do-i"]], "Use the Player class": [[15, "use-the-player-class"]], "Connecting a player": [[15, "connecting-a-player"]], "Controlling the player": [[15, "controlling-the-player"]], "Destroying a player": [[15, "destroying-a-player"]], "Playing a track": [[15, "playing-a-track"]], "Seeking to a position": [[15, "seeking-to-a-position"]], "Pausing/unpausing the player": [[15, "pausing-unpausing-the-player"]], "Setting the player volume": [[15, "setting-the-player-volume"]], "Stopping the player": [[15, "stopping-the-player"]], "Controlling filters": [[15, "controlling-filters"]], "Adding a filter": [[15, "adding-a-filter"]]}, "indexentries": {}})