Package com.sedmelluq.discord.lavaplayer.source

Interface AudioSourceManager

All Known Implementing Classes:

BandcampAudioSourceManager, BeamAudioSourceManager, GetyarnAudioSourceManager, HttpAudioSourceManager, LocalAudioSourceManager, NicoAudioSourceManager, ProbingAudioSourceManager, SoundCloudAudioSourceManager, TwitchStreamAudioSourceManager, VimeoAudioSourceManager, YandexMusicAudioSourceManager, YoutubeAudioSourceManager

public interface AudioSourceManager

Manager for a source of audio items.

Method Summary

Modifier and Type	Method	Description
AudioTrack	decodeTrack(AudioTrackInfo trackInfo, java.io.DataInput input)	Decodes an audio track from the encoded format encoded with encodeTrack().
void	encodeTrack(AudioTrack track, java.io.DataOutput output)	Encodes an audio track into the specified output.
java.lang.String	getSourceName()	Every source manager implementation should have its unique name as it is used to determine which source manager should be able to decode a serialized audio track.
boolean	isTrackEncodable(AudioTrack track)	Returns whether the specified track can be encoded.
AudioItem	loadItem(AudioPlayerManager manager, AudioReference reference)	Returns an audio track for the input string.
void	shutdown()	Shut down the source manager, freeing all associated resources and threads.

Method Detail

getSourceName

java.lang.String getSourceName()

Every source manager implementation should have its unique name as it is used to determine which source manager should be able to decode a serialized audio track.

Returns:

The name of this source manager

loadItem

AudioItem loadItem(AudioPlayerManager manager,
                   AudioReference reference)

Returns an audio track for the input string. It should return null if it can immediately detect that there is no track for this identifier for this source. If checking that requires more expensive operations, then it should return a track instance and check that in InternalAudioTrack#loadTrackInfo.

Parameters:

manager - The audio manager to attach to the loaded tracks

reference - The reference with the identifier which the source manager should find the track with

Returns:

The loaded item or null on unrecognized identifier

isTrackEncodable

boolean isTrackEncodable(AudioTrack track)

Returns whether the specified track can be encoded. The argument is always a track created by this manager. Being encodable also means that it must be possible to play this track on a different node, so it should not depend on any resources that are only available on the current system.

Parameters:

track - The track to check

Returns:

True if it is encodable

encodeTrack

void encodeTrack(AudioTrack track,
                 java.io.DataOutput output)
          throws java.io.IOException

Encodes an audio track into the specified output. The contents of AudioTrackInfo do not have to be included since they are written to the output already before this call. This will only be called for tracks which were loaded by this source manager and for which isEncodable() returns true.

Parameters:

track - The track to encode

output - Output where to write the decoded format to

Throws:

java.io.IOException - On write error.

decodeTrack

AudioTrack decodeTrack(AudioTrackInfo trackInfo,
                       java.io.DataInput input)
                throws java.io.IOException

Decodes an audio track from the encoded format encoded with encodeTrack().

Parameters:

trackInfo - The track info

input - The input where to read the bytes of the encoded format

Returns:

The decoded track

Throws:

java.io.IOException - On read error.

shutdown

void shutdown()

Shut down the source manager, freeing all associated resources and threads. A source manager is not responsible for terminating the tracks that it has created.