com.sedmelluq.discord.lavaplayer.track.InternalAudioTrack Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lavaplayer Show documentation

A Lavaplayer fork maintained by Lavalink

The newest version!

package com.sedmelluq.discord.lavaplayer.track;

import com.sedmelluq.discord.lavaplayer.player.AudioPlayerManager;
import com.sedmelluq.discord.lavaplayer.track.playback.AudioFrameProvider;
import com.sedmelluq.discord.lavaplayer.track.playback.AudioTrackExecutor;
import com.sedmelluq.discord.lavaplayer.track.playback.LocalAudioTrackExecutor;

/**
 * Methods of an audio track that should not be visible outside of the library
 */
public interface InternalAudioTrack extends AudioTrack, AudioFrameProvider {
    /**
     * @param executor             Executor to assign to the track
     * @param applyPrimordialState True if the state previously applied to this track should be copied to new executor.
     */
    void assignExecutor(AudioTrackExecutor executor, boolean applyPrimordialState);

    /**
     * @return Get the active track executor
     */
    AudioTrackExecutor getActiveExecutor();

    /**
     * Perform any necessary loading and then enter the read/seek loop
     *
     * @param executor The local executor which processes this track
     * @throws Exception In case anything explodes.
     */
    void process(LocalAudioTrackExecutor executor) throws Exception;

    /**
     * @param playerManager The player manager which is executing this track
     * @return A custom local executor for this track. Unless this track requires a special executor, this should return
     * null as the default one will be used in that case.
     */
    AudioTrackExecutor createLocalExecutor(AudioPlayerManager playerManager);
}