Module qilletni.api

Package dev.qilletni.api.music.orchestration

Interface TrackOrchestrator

public interface TrackOrchestrator

A class to handle the way tracks are selected. This should ideally take in a PlayActor to handle playing.

Method Summary

Modifier and Type	Method	Description
Track	getTrackFromCollection(CollectionState collectionState)	Gets a single track from a collection state.
Track	getTrackFromWeight(WeightsType weightsType)	Selects a single track from a weight.
void	playCollection(CollectionType collectionType, boolean loop)	Plays a collection of tracks.
void	playCollection(CollectionType collectionType, CollectionLimit collectionLimit)	Plays a collection of tracks, with a limit on the number of tracks to play.
void	playTrack(Track track)	Plays a single track.

Method Details

playTrack

void playTrack(Track track)

Plays a single track.

Parameters:

track - The track to play

playCollection

void playCollection(CollectionType collectionType,
 boolean loop)

Plays a collection of tracks. If looping, it will continue until the program exits.

Parameters:

collectionType - The type of collection to play

loop - Whether to loop the collection. If `false`, the collection will play each song once

playCollection

void playCollection(CollectionType collectionType,
 CollectionLimit collectionLimit)

Plays a collection of tracks, with a limit on the number of tracks to play.

Parameters:

collectionType - The type of collection to play

collectionLimit - The limit of tracks to play

getTrackFromCollection

Track getTrackFromCollection(CollectionState collectionState)

Gets a single track from a collection state. If the collection is sequential, it will return the next unplayed track in the collection.

Parameters:

collectionState - The collection state to get the track from

Returns:

The track to play

getTrackFromWeight

Track getTrackFromWeight(WeightsType weightsType)

Selects a single track from a weight.

Parameters:

weightsType - The type of weight to get the track from

Returns:

The track to play