SongPlayer (NoteBlockLib 3.1.1 API)

java.lang.Object
- net.raphimc.noteblocklib.player.SongPlayer

public abstract class SongPlayer
extends java.lang.Object

Constructor Summary

Constructors
Constructor Description

SongPlayer(Song song)

Constructors
Constructor	Description
`SongPlayer(Song song)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`protected void`	`createTickTask(long initialDelay)`	Create the internal tick task.
`float`	`getCurrentTicksPerSecond()`
`int`	`getMillisecondPosition()`
`Song`	`getSong()`
`int`	`getTick()`
`boolean`	`isPaused()`
`boolean`	`isRunning()`
`protected void`	`onFinished()`	Deprecated.
`protected void`	`onSongFinished()`	Called when the song has finished playing.
`protected void`	`onTickException(java.lang.Throwable e)`	Called when an exception occurs during playback.
`protected abstract void`	`playNotes(java.util.List<Note> notes)`	Called each tick to play the notes for the current tick.
`protected void`	`postTick()`	Called after each tick (Even when paused).
`protected boolean`	`preTick()`	Deprecated.
`protected void`	`setCustomScheduler(java.util.concurrent.ScheduledExecutorService scheduler)`	Disables the internal scheduler and uses the provided one instead.
`void`	`setMillisecondPosition(int milliseconds)`	Sets the current playback position in milliseconds.
`void`	`setPaused(boolean paused)`	Pauses or resumes the player.
`protected void`	`setSong(Song song)`	Sets the song that should be played.
`void`	`setTick(int tick)`	Sets the current tick.
`protected boolean`	`shouldTick()`	Called before each tick (Even when paused).
`void`	`start()`	Starts playing the song from the beginning.
`void`	`start(int delay)`	Starts playing the song from the beginning.
`void`	`start(int delay, int tick)`	Starts playing the song from the given tick.
`void`	`stop()`	Stops playing the song.
`protected void`	`tick()`	Called every tick to play the notes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SongPlayer
```
public SongPlayer(Song song)
```
- Method Detail
  - start
```
public void start()
```
    Starts playing the song from the beginning.
  - start
```
public void start(int delay)
```
    Starts playing the song from the beginning.
    
    Parameters:
    
    delay - The delay in milliseconds before starting the song.
  - start
```
public void start(int delay,
                  int tick)
```
    Starts playing the song from the given tick.
    
    Parameters:
    
    delay - The delay in milliseconds before starting the song.
    
    tick - The tick to start playing from.
  - stop
```
public void stop()
```
    Stops playing the song.
  - isRunning
```
public boolean isRunning()
```
    Returns:
    
    Whether the player is in the running state (playing or paused).
  - getSong
```
public Song getSong()
```
    Returns:
    
    The song that is being played.
  - setSong
```
protected void setSong(Song song)
```
    Sets the song that should be played.
    Can be called in onSongFinished().
    
    Parameters:
    
    song - The song to play.
  - getCurrentTicksPerSecond
```
public float getCurrentTicksPerSecond()
```
    Returns:
    
    The current tempo in ticks per second.
  - getTick
```
public int getTick()
```
    Returns:
    
    The current tick.
  - setTick
```
public void setTick(int tick)
```
    Sets the current tick.
    
    Parameters:
    
    tick - The tick to set.
  - getMillisecondPosition
```
public int getMillisecondPosition()
```
    Returns:
    
    The current playback position in milliseconds.
  - setMillisecondPosition
```
public void setMillisecondPosition(int milliseconds)
```
    Sets the current playback position in milliseconds.
    
    Parameters:
    
    milliseconds - The time to set the playback position to.
  - isPaused
```
public boolean isPaused()
```
    Returns:
    
    Whether the player is paused.
  - setPaused
```
public void setPaused(boolean paused)
```
    Pauses or resumes the player.
    
    Parameters:
    
    paused - Whether the player should be paused.
  - setCustomScheduler
```
protected void setCustomScheduler(java.util.concurrent.ScheduledExecutorService scheduler)
```
    Disables the internal scheduler and uses the provided one instead.
    The provided scheduler won't be shut down when the player is stopped.
    Set to null to disable builtin scheduling (The tick method has to be called manually then).
    
    Parameters:
    
    scheduler - The scheduler to use for playing the song or null to disable builtin scheduling
  - createTickTask
```
protected void createTickTask(long initialDelay)
```
    Create the internal tick task.
    
    Parameters:
    
    initialDelay - The initial delay in nanoseconds.
  - tick
```
protected void tick()
```
    Called every tick to play the notes.
  - shouldTick
```
protected boolean shouldTick()
```
    Called before each tick (Even when paused).
    
    Returns:
    
    Whether the tick should be executed.
  - playNotes
```
protected abstract void playNotes(java.util.List<Note> notes)
```
    Called each tick to play the notes for the current tick.
    
    Parameters:
    
    notes - The notes to play.
  - onSongFinished
```
protected void onSongFinished()
```
    Called when the song has finished playing. Stops the song player by default.
  - postTick
```
protected void postTick()
```
    Called after each tick (Even when paused).
  - onTickException
```
protected void onTickException(java.lang.Throwable e)
```
    Called when an exception occurs during playback. Stops the song player by default. Override this method to handle exceptions differently.
    
    Parameters:
    
    e - The exception that occurred.
  - preTick
```
@Deprecated
protected boolean preTick()
```
    Deprecated.
    
    Called before each tick (Even when paused).
    
    Returns:
    
    Whether the tick should be executed.
    
    See Also:
    
    shouldTick()
  - onFinished
```
@Deprecated
protected void onFinished()
```
    Deprecated.
    
    Called when the song has finished playing.
    
    See Also:
    
    onSongFinished()

Class SongPlayer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SongPlayer

Method Detail

start

start

start

stop

isRunning

getSong

setSong

getCurrentTicksPerSecond

getTick

setTick

getMillisecondPosition

setMillisecondPosition

isPaused

setPaused

setCustomScheduler

createTickTask

tick

shouldTick

playNotes

onSongFinished

postTick

onTickException

preTick

onFinished