Module qilletni.api

Package dev.qilletni.api.music.play

Class DefaultRoutablePlayActor

java.lang.Object

dev.qilletni.api.music.play.DefaultRoutablePlayActor

All Implemented Interfaces:

PlayActor

public class DefaultRoutablePlayActor
extends Object
implements PlayActor

This is a sample base implementation of a PlayActor that can be routed to different PlayActor. Service providers that use this implementation can use the standard library's play_redirect.ql to switch between what this is routed to.

Nested Class Summary

Nested classes/interfaces inherited from interface dev.qilletni.api.music.play.PlayActor

PlayActor.PlayResult

Constructor Summary

Constructors

Constructor	Description
DefaultRoutablePlayActor(PlayActor defaultPlayActor)

Method Summary

Modifier and Type	Method	Description
PlayActor	getDefaultPlay()	Gets the default PlayActor.
CompletableFuture<PlayActor.PlayResult>	playTrack(Track track)	Plays a track.
void	resetReroutedPlayTrack()	Resets the function that will be used to play a track.
void	setReroutedPlayTrack(Function<Track,CompletableFuture<PlayActor.PlayResult>> playFunction)	Sets the function that will be used to play a track.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultRoutablePlayActor

public DefaultRoutablePlayActor(PlayActor defaultPlayActor)

Method Details

playTrack

public CompletableFuture<PlayActor.PlayResult> playTrack(Track track)

Description copied from interface: PlayActor

Plays a track. This is highly implementation-dependent.

Specified by:

playTrack in interface PlayActor

Parameters:

track - The track to play

Returns:

The result of the play operation. Some implementations may return immediately, while others may wait for the track to finish playing.

setReroutedPlayTrack

public void setReroutedPlayTrack(Function<Track,CompletableFuture<PlayActor.PlayResult>> playFunction)

Sets the function that will be used to play a track.

Parameters:

playFunction - The function to use to play a track

resetReroutedPlayTrack

public void resetReroutedPlayTrack()

Resets the function that will be used to play a track. This will use the default PlayActor.

getDefaultPlay

public PlayActor getDefaultPlay()

Gets the default PlayActor.

Returns:

The default PlayActor