Skip to content

First Release

Latest
Compare
Choose a tag to compare
@Cyberghxst Cyberghxst released this 21 Jan 18:46

ForgeMusic 1.0.0

After a lot of reworks, music finally has come.

Music Functions

  • $clearQueue: Clear the guild queue.
  • $clearQueueHistory: Clear the queue history.
  • $currentTrackTotalDuration: Returns the total duration of the current audio track.
  • $deleteQueue: Deletes the queue of the current guild.
  • $disableAllFilters: Disable the provided FFMPEG filters.
  • $enableAllFilters: Enable the provided FFMPEG filters.
  • $getAvailableProviders: Get the available audio providers.
  • $getDisabledFilters: Return the disabled FFMPEG filters.
  • $getEnabledFilters: Return the enabled FFMPEG filters.
  • $getLoopMode: Returns the state of the loop mode.
  • $getVolume: Get the current volume of the music player.
  • $hasMusicNode: Check whether the current guild has a music node created.
  • $isFilterEnabled: Check whether the provided filter is enabled.
  • $isPaused: Check whether the music player is paused.
  • $isPlaying: Check whether the music player is playing a track.
  • $isQueueHistoryDisabled: Returns whether the queue history is disabled.
  • $isQueueHistoryEmpty: Returns whether the queue history is empty.
  • $leaveVoiceChannel: Destroys the current voice connection.
  • $moveTrack: Moves the track to a new position.
  • $pauseTrack: Pauses the current track.
  • $playerElapsedTime: Returns the elapsed time of the current song in milliseconds.
  • $playNext: Play the next track in the queue, if any.
  • $playPrevious: Play the previous track in the queue history, if any.
  • $playTrack: Play a track by query.
  • $queue: Returns queue songs resolving the given text placeholders.
  • $queueEstimatedDuration: Returns the estimated duration of the current guild queue in milliseconds.
  • $queueHistory: Returns queue history songs resolving the given text placeholders.
  • $queueHistoryLength: Returns the length of the tracks that were played.
  • $queueLength: Returns the length of the current guild queue.
  • $queuePing: Returns the latency of the current guild queue.
  • $removeTrack: Removes the track that is located at the given position.
  • $resumeTrack: Resumes the current paused track.
  • $searchTrack: Search for a track using the given query.
  • $seekTrack: Seeks a track.
  • $setLoopMode: Set the loop mode of the music player.
  • $setVolume: Set the volume of the music player.
  • $shuffleQueue: Shuffle the queue when the current track ends, unlike $shuffleTracks that can be undone, this function does not mutates the queue.
  • $shuffleTracks: Shuffle the current guild queue.
  • $skipTo: Skip the current track to the given position.
  • $skipTrack: Skip the current track.
  • $stopTrack: Forces to stop the current track.
  • $toggleFilters: Toggle the provided FFMPEG filters.
  • $trackInfo: Returns information of the current track.
  • $unshuffleQueue: Disable shuffle mode for the queue.

Music Events

  • audioFiltersUpdate: Executed when FFMPEG audio filters are updated.
  • audioTrackAdd: Executed when audio track is added to the queue.
  • audioTrackRemove: Executed when audio track is removed from the queue.
  • audioTracksAdd: Executed when multiple audio track are added to the queue.
  • biquadFiltersUpdate: Executed when biquad filters is updated.
  • channelPopulate: Executed when a voice channel is populated.
  • connection: Executed when a connection is created.
  • connectionDestroyed: Executed when a connection is destroyed.
  • debug: Executed when the queue sends a debug info.
  • disconnect: Executed when the bot is disconnected from the channel.
  • dspUpdate: Executed when dsp filters are updated.
  • emptyChannel: Executed when the voice channel is empty.
  • emptyQueue: Executed when the queue is empty.
  • equalizerUpdate: Executed when equalizer config is updated.
  • error: Executed when the queue encounters error.
  • playerError: Executed when the audio player errors while streaming audio track.
  • playerFinish: Executed when the audio player finishes streaming audio track.
  • playerPause: Executed when audio player is paused.
  • playerResume: Executed when audio player is resumed.
  • playerSkip: Executed when the audio player skips current track.
  • playerStart: Executed when the audio player starts streaming audio track.
  • playerTrigger: Executed when the audio player is triggered.
  • queueCreate: Executed when a queue is successfully created.
  • queueDelete: Executed when a queue is successfully deleted.
  • volumeChange: Executed when audio player's volume is changed.

Supported Platforms (Natively)

  • AppleMusic
  • Local Files
  • Reverbnation
  • SoundCloud
  • Spotify
  • Vimeo

This doesn't mean that YouTube (and other platforms) are'nt supported, they are, but you must install a third-party extractor for it. Read package's README for further information.

Credits

@Cyberghxst (extension developer)