samophis.lavalink.client.entities

Interface AudioWrapper

public interface AudioWrapper

Wraps a playlist of loaded tracks or a singular track into one object.

This is used (and is different from v0.3) simply to be compatible with Lavalink Server v3 and to contain the loaded track(s) in one object.
Older versions of Lavalink DO NOT fully support the getLoadType() and isPlaylist() methods.

Since:

1.0.0

Author:

SamOphis

Method Summary

Modifier and Type	Method and Description
java.util.List<TrackDataPair>	getLoadedTracks() Returns an unmodifiable, NOT-null list containing all the TrackDataPairs.
LoadType	getLoadType() Returns the type of loading that occurred.
java.lang.String	getPlaylistName() Returns the possibly-null name of the playlist this object wraps.
TrackDataPair	getSelectedTrack() Returns the possibly-null TrackDataPair resembling the selected track of the playlist this object wraps.
boolean	isPlaylist() Determines whether or not the loaded tracks are the contents of a playlist or simply a search result.

Method Detail

getLoadType

@Nonnull
LoadType getLoadType()

Returns the type of loading that occurred.

Older versions of Lavalink do not fully support this and will usually return UNKNOWN.

Returns:

A not-null LoadType.

isPlaylist

boolean isPlaylist()

Determines whether or not the loaded tracks are the contents of a playlist or simply a search result.

Note: This WILL RETURN FALSE ALL THE TIME if the used AudioNode is running Lavalink Server v2 (NOT v3).

Returns:

Whether the result was from a playlist or a search.

getPlaylistName

@Nullable
java.lang.String getPlaylistName()

Returns the possibly-null name of the playlist this object wraps.

Note: This may return null if this object does NOT wrap a playlist or if the used AudioNode is running Lavalink Server v2.

Returns:

The possibly-null name of the playlist this object represents.

getSelectedTrack

@Nullable
TrackDataPair getSelectedTrack()

Returns the possibly-null TrackDataPair resembling the selected track of the playlist this object wraps.

Note: This may return null if this object does NOT wrap a playlist or if the used AudioNode is running Lavalink Server v2.

Returns:

The possibly-null TrackDataPair with the information of the selected track.

getLoadedTracks

@Nonnull
java.util.List<TrackDataPair> getLoadedTracks()

Returns an unmodifiable, NOT-null list containing all the TrackDataPairs.

The TrackDataPair class just contains the AudioTrack itself and its encoded data.
Additionally, if no tracks were returned (errors, no matches, empty, etc.) then an empty list will be returned, NOT a null one.

Returns:

An not-null unmodifiable list containing all the TrackDataPairs.