dev.arbjerg.lavalink.client.player.IUpdatablePlayer.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of lavalink-client Show documentation
Lavalink v4 client library
The newest version!
package dev.arbjerg.lavalink.client.player

import dev.arbjerg.lavalink.protocol.v4.Filters
import dev.arbjerg.lavalink.protocol.v4.PlayerUpdateTrack
import dev.arbjerg.lavalink.protocol.v4.VoiceState

interface IUpdatablePlayer {
    /**
     * Shortcut for setting the encoded track. This will also send any user-data supplied.
     * Please keep in mind that this will set the position field to the current position of the track.
     *
     * @param track The track to apply to this builder
     *
     * @return The updated builder, useful for chaining
     */
    fun setTrack(track: Track?): PlayerUpdateBuilder

    /**
     * Allows you to set the track via the [TrackUpdateBuilder].
     * To stop the player, you can use [stopTrack] or [setTrack] with a null track.
     *
     * @param update the update params created via the [TrackUpdateBuilder].
     *
     * @return The updated builder, useful for chaining
     */
    fun updateTrack(update: PlayerUpdateTrack): PlayerUpdateBuilder

    /**
     * Shortcut for setting the encoded track to {@code null}. This will also clear the user data.
     *
     * @return The updated builder, useful for chaining
     */
    fun stopTrack(): PlayerUpdateBuilder

    /**
     * Update the position of the player.
     *
     * @param position The new position of the player. Set it to `null` to exclude this field from being sent with an update.
     *
     * @return The updated builder, useful for chaining
     */
    fun setPosition(position: Long?): PlayerUpdateBuilder

    /**
     * Update the end time of the track.
     *
     * @param endTime The new end time of the track. Set it to `null` to exclude this field from being sent with an update.
     *
     * @return The updated builder, useful for chaining
     */
    fun setEndTime(endTime: Long?): PlayerUpdateBuilder

    /**
     * Omits the end time from being sent to the node during updates.
     *
     * @return The updated builder, useful for chaining
     */
    fun omitEndTime(): PlayerUpdateBuilder

    /**
     * Update the volume of the player.
     * While you could use the filters to set volume as well, do note that that is float based (1.0f is 100% volume)
     * and takes the time of your buffer size to apply. This method updates the volume instantly after the update is sent out.
     *
     * @param volume The new player volume, value is between 0 and 1000 where 100 is 100% (default) volume.
     *
     * @return The updated builder, useful for chaining
     */
    fun setVolume(volume: Int): PlayerUpdateBuilder

    /**
     * Update the paused state of the player.
     *
     * @param paused Whether the player should be paused or not.
     *
     * @return The updated builder, useful for chaining
     */
    fun setPaused(paused: Boolean): PlayerUpdateBuilder

    /**
     * Update the filters for the player.
     * Please use [setVolume] to update the player's volume instead. Setting the volume via filters is
     * float based (1.0f is 100% volume) and takes the time of your buffer size to apply.
     *
     * @param filters The new filters to apply to the player. You can use the [dev.arbjerg.lavalink.client.player.FilterBuilder] to easily create this object.
     *
     * @return The updated builder, useful for chaining
     */
    fun setFilters(filters: Filters): PlayerUpdateBuilder

    /**
     * Update the voice state for the player.

     * IMPORTANT: Only ever use [Link.onVoiceServerUpdate] to update the voice server as this sets the state of the link to [LinkState.CONNECTING]
     *
     * @return The updated builder, useful for chaining
     */
    fun setVoiceState(state: VoiceState): PlayerUpdateBuilder
}