Music

All Known Implementing Classes:

MemMusic, StreamMusic
```
public interface Music
```
The Music interface is an abstraction for music. Music objects should only be loaded via the TinySound loadMusic() functions. Music can be played, paused, resumed, stopped and looped from specified positions.

Author:

Finn Kuusisto

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`done()` Determine if this Music has reached its end and is done playing.
`int`	`getLoopPositionByFrame()` Get the loop position of this Music by sample frame.
`double`	`getLoopPositionBySeconds()` Get the loop position of this Music by seconds.
`double`	`getPan()` Get the pan of this Music.
`double`	`getVolume()` Get the volume of this Music.
`boolean`	`loop()` Determine if this Music will loop.
`void`	`pause()` Stop playing this Music and keep its current position.
`void`	`play(boolean loop)` Play this Music and loop if specified.
`void`	`play(boolean loop, double volume)` Play this Music at the specified volume and loop if specified.
`void`	`play(boolean loop, double volume, double pan)` Play this Music at the specified volume and pan, and loop if specified.
`boolean`	`playing()` Determine if this Music is playing.
`void`	`resume()` Play this Music from its current position.
`void`	`rewind()` Set this Music's position to the beginning.
`void`	`rewindToLoopPosition()` Set this Music's position to the loop position.
`void`	`setLoop(boolean loop)` Set whether this Music will loop.
`void`	`setLoopPositionByFrame(int frameIndex)` Set the loop position of this Music by sample frame.
`void`	`setLoopPositionBySeconds(double seconds)` Set the loop position of this Music by seconds.
`void`	`setPan(double pan)` Set the pan of this Music.
`void`	`setVolume(double volume)` Set the volume of this Music.
`void`	`stop()` Stop playing this Music and set its position to the beginning.
`void`	`unload()` Unload this Music from the system.

- Method Detail
  - play
```
void play(boolean loop)
```
    Play this Music and loop if specified.
    
    Parameters:
    loop - if this Music should loop
  - play
```
void play(boolean loop,
        double volume)
```
    Play this Music at the specified volume and loop if specified.
    
    Parameters:
    loop - if this Music should loop
    volume - the volume to play the this Music
  - play
```
void play(boolean loop,
        double volume,
        double pan)
```
    Play this Music at the specified volume and pan, and loop if specified.
    
    Parameters:
    loop - if this Music should loop
    volume - the volume to play the this Music
    pan - the pan at which to play this Music [-1.0,1.0], values outside the valid range will be ignored
  - stop
```
void stop()
```
    Stop playing this Music and set its position to the beginning.
  - pause
```
void pause()
```
    Stop playing this Music and keep its current position.
  - resume
```
void resume()
```
    Play this Music from its current position.
  - rewind
```
void rewind()
```
    Set this Music's position to the beginning.
  - rewindToLoopPosition
```
void rewindToLoopPosition()
```
    Set this Music's position to the loop position.
  - playing
```
boolean playing()
```
    Determine if this Music is playing.
    
    Returns:
    true if this Music is playing
  - done
```
boolean done()
```
    Determine if this Music has reached its end and is done playing.
    
    Returns:
    true if this Music is at the end and is done playing
  - loop
```
boolean loop()
```
    Determine if this Music will loop.
    
    Returns:
    true if this Music will loop
  - setLoop
```
void setLoop(boolean loop)
```
    Set whether this Music will loop.
    
    Parameters:
    loop - whether this Music will loop
  - getLoopPositionByFrame
```
int getLoopPositionByFrame()
```
    Get the loop position of this Music by sample frame.
    
    Returns:
    loop position by sample frame
  - getLoopPositionBySeconds
```
double getLoopPositionBySeconds()
```
    Get the loop position of this Music by seconds.
    
    Returns:
    loop position by seconds
  - setLoopPositionByFrame
```
void setLoopPositionByFrame(int frameIndex)
```
    Set the loop position of this Music by sample frame.
    
    Parameters:
    frameIndex - sample frame loop position to set
  - setLoopPositionBySeconds
```
void setLoopPositionBySeconds(double seconds)
```
    Set the loop position of this Music by seconds.
    
    Parameters:
    seconds - loop position to set by seconds
  - getVolume
```
double getVolume()
```
    Get the volume of this Music.
    
    Returns:
    volume of this Music
  - setVolume
```
void setVolume(double volume)
```
    Set the volume of this Music.
    
    Parameters:
    volume - the desired volume of this Music
  - getPan
```
double getPan()
```
    Get the pan of this Music.
    
    Returns:
    pan of this Music
  - setPan
```
void setPan(double pan)
```
    Set the pan of this Music. Must be between -1.0 (full pan left) and 1.0 (full pan right). Values outside the valid range will be ignored.
    
    Parameters:
    pan - the desired pan of this Music
  - unload
```
void unload()
```
    Unload this Music from the system. Attempts to use this Music after unloading will result in error.

Interface Music

Method Summary

Method Detail

play

play

play

stop

pause

resume

rewind

rewindToLoopPosition

playing

done

loop

setLoop

getLoopPositionByFrame

getLoopPositionBySeconds

setLoopPositionByFrame

setLoopPositionBySeconds

getVolume

setVolume

getPan

setPan

unload