* Send a simple note to Discord with an emoji depending of the given message Type. * @param {ChatInputCommandInteraction} interaction - User messag

* Establish new voice connection. * If a connection is already established disconnect first. * @param {ChatInputCommandInteraction} interaction

* Start playing if the playback ist stopped or resume playback if paused. * @param {ChatInputCommandInteraction} interaction - User message the pla

* Send either plain text or a MessageEmbed in markdown style. * @see {@link https://discord.js.org/#/docs/main/master/class/MessageEmbed} MessageEm

* Stop playback. * @param {ChatInputCommandInteraction} interaction - User message the playback was is invoked by.

* Announce the given message via tts to the given connection. * @param {string} message Message to announce. * @param {VoiceConnection} voiceCon

* Get songs via query. * @param {string} searchString - Url to get song from. * @param {number} count - Number of songs to be fetched. * @ret

* Display paged content with reaction based navigation. * @param {ChatInputCommandInteraction} interaction - User message this function is invoked

* Add a song to a playlist and save it to MongoDB. * If the playlist doesn't exist it will be created. * @param {Song} song - song to be added.

* Build a dummy message to prevent crashes when executing commands from the console. * @private

* Print color coded debug information for all chat interactions to console log. * @private * @param {string|Object|Error} content Content to be

* Get all songs of a playlist as array. * @param {string} plName - Playlist name to get songs from. * @returns {Promise<Song[]>} - Array of all

* Get song via url. * @param {string} searchString - Url to get song from. * @returns {Promise<Song>} - Song from url.

* Resolve the streaming source of a Song and get the stream accordingly as a promise. * @private * @param {Song} song song to get the Stream fro

* Play the next song from the queue. * @private * @param {ChatInputCommandInteraction} interaction - User message the playback was is invoked b

* Do a direct query search skipping checks for urls. * @param {string} payload - Payload containing song query. * @param {number} count - Count

* Search for a song using urls or queries on the preferred source and fallbacks. * @param {string} payload - Payload containing song url or query.

* Add multiple songs fairly to the queue. * Songs from requester with viewer songs gets added farther ahead in queue. * The resulting queue from

* Find a song by title in a playlist with fuzzy search. * @param {string} title - query to search titles with. * @param {string} plName - playli

* Get current Song which is position 0 of the history. * @returns {Promise<Song>} - The current song.

* Do Search from Youtube then SoundCloud. * @private * @param {string} searchString - Payload containing song query. * @param {number} count

* Get songs via playlist url. * @param {string} searchString - Url to get song from. * @returns {Promise<Song[]>} - Songs from playlist url.

* Play the given song immediately. * If another song is already playing it ends immediately. * @param {Song} song - Song to be played. * @par

* Remove the given position from the queue. * @param {number} position - position to remove.

* Shuffles the current queue.

* Skip current song. * @param {ChatInputCommandInteraction} interaction - User message the playback was is invoked by.

* Display a song in pretty markdown and add reaction based user rating. * @param {ChatInputCommandInteraction} interaction- User message this funct

* Add a song fairly to the queue. * Songs from requester with viewer songs gets added farther ahead in queue. * The resulting queue from only fa

* Gets the current auto playlist name. * @returns {Promise<string>} - current auto playlist name.

* Function to get a tuple of voting emoji names and IDs with defaults (👍/👎). * @todo make custom emojis configurable. * @private * @param {Ch

* Process reaction based user rating. * @private * @param {ChatInputCommandInteraction} interaction - given user reaction. * @param {number}

* Unescape html escaped characters. * @private * @param {string} str string possibly containing html escaped characters.

* Gets all playlist names as string. * @returns {Promise<string[]>} - Array containing all playlist names.

* Adds the given playlist from the DB to the current queue. * @param {string} plName - playlist name to load. * * @param {ChatInputCommandInt

* Pause playback. * @param {ChatInputCommandInteraction} interaction - User message the playback was is invoked by.

* Lookup phonetic nickname. * @private * @param {string} userName Username to process.

* Plays stream from the given song and return ste stream dispatcher. * @param audioPlayer * @param {Song} song song to be played * @param {Ch

* Rate a song up or down and handle cooldown and other implications like adding or removing the song. * Special cases: * Upvoted and rating is h

* (Re-) builds the player with controls. * Can be used to move the player down in chat. * @param {ChatInputCommandInteraction} interaction - Use

* Remove song from playlist. * If it was the last song of the playlist the playlist and MongoDB collection will be removed. * @param {Song} song

* Shuffles the given array and returns it. * @private * @param {Array} array - array to be shuffled * @returns {Array} - shuffled array.

* Add Reaction controls to player and refreshes listener recursively until message is destroyed. * @private * @param {ChatInputCommandInteractio

* Add a song to the top of the history. * Add a song at position 0 and trim the history if its longer than its max size. * @param {Song} song -

* Add multiple songs to a playlist and save it to MongoDB. * If the playlist doesn't exist it will be created. * The playlist is represented as

* Automatically pick a song from a list of songs based on some disfavored strings. * Disfavored:["cover", "live", "remix", "mix", "parody", "hour",

* Play last song again. * @param {ChatInputCommandInteraction} interaction - User message the playback was is invoked by.

* Build object for reaction based player functions. * @private * @param {ChatInputCommandInteraction} interaction - User message the playback wa

* Build a MessageEmbed for a song with markdown. * @private * @param {Song} song - Song to be displayed.

* Add song to auto playlist. * @private * @param {Song} song - Song to be Added. * @param delta - Delta rating score.

* Clear the current queue.

* Connection to MongoDB. * If a connection is already established disconnect first.

* Creates an AudioResource from Song.

* Delete an entire playlist and the corresponding MongoBD collection. * @param {string} plName - playlist name to be removed.

* Disconnect from MongoDB.

* Disconnect current voice connection. * @param {ChatInputCommandInteraction} interaction - User message this function is invoked by.

* Escape all regex characters from string. * @private * @param {string} text - text with with some regex characters.

* Get text to Speech stream for given text. * @param {string} text text to convert

* Gets a specific song from the history with its position. * 0 ist the song least added to the history. * @param {number} position - Index of hi

* Get a random Song from a Playlist. * @param {string} plName - playlist name to get the song from. * @returns {Promise<Song>} - A random Song f

* Do Search from SoundCloud then Youtube. * @private * @param {string} searchString - Payload containing song query. * @param {number} count

* Do Search from Spotify the Youtube then SoundCloud. * Spotify is only for searching and to get the exact song title and artist. * @private

* Get current rating cooldown by song and user. * @private * @param {Song} song - Song to be rated. * @param {string} user - User name rating

* Called when an error has occurred during playback. * @param {Error} err - Error caused by playback. * @param {ChatInputCommandInteraction} int

* Helper function to handle raw file urls. * @private * @param {string} searchString - Payload containing a link to a raw song file.

* Process reactions. * @private * @param {function} processFunction - Function to be invoked if rating was given.

* Called when a song has ended. and starting the next song from queue oe auto playlist when available. * @private * @param {ChatInputCommandInte

* Helper function to handle SoundCloud urls. * @private * @param {string} searchString - Payload containing a SoundCloud track url.

* Helper function to handle Spotify urls. * @private * @param {string} searchString - Payload containing a Spotify track or playlist url. * @

* Helper function to handle Youtube urls. * @private * @param {string} searchString - Payload containing a Youtube track or playlist url.

* Check if a voice connection to the server of the message is established. * @param {ChatInputCommandInteraction} interaction - User message this

* Merge two playlists by copying one into the other. * @param {string} source - name of the playlist to be copied from. * @param {string} target

* Given a Array of songs, play the first one immediately and queue the rest. * If another song is already playing it ends immediately. * @param

* Get next song which is position 0 of the queue. * @returns {Promise<Song>} - The next song.

* Remove Song from its playlist. * @private * @param {Song} song - Song to be removed.

* Rename a playlist with the given names. * The playlist and corresponding MongoDB collection will be removed. * @param {string} plName - playli

* Rename the artist or title of a song in a playlist. * @param {string} plName - playlist name to change the name in. * @param {Song} song - Son

* Play the current song again. * @param {ChatInputCommandInteraction} interaction - User message the playback was is invoked by.