SoundPlayer

java.lang.Object
- com.qualcomm.ftccommon.SoundPlayer

```
public class SoundPlayer
extends java.lang.Object
```
SoundPlayer is a simple utility class that plays sounds on the phone. The class is typically used through its singleton instance.

See Also:
play(Context, int)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`SoundPlayer.LoadedSoundCache` `SoundPlayer.LoadedSoundCache` keeps track of loaded sounds, mapping sound resource id to loaded sound id.
`protected class`	`SoundPlayer.SoundInfo`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Context`	`context`
`protected int`	`currentlyLoading`
`static boolean`	`DEBUG`
`protected java.util.concurrent.ExecutorService`	`executorService`
`protected SoundPlayer.LoadedSoundCache`	`loadedSounds`
`protected Looper`	`looper`
`protected long`	`msFinishPlaying`
`protected SharedPreferences`	`sharedPreferences`
`protected float`	`soundOffLevel`
`protected float`	`soundOnLevel`
`protected SoundPool`	`soundPool`
`static java.lang.String`	`TAG`
`protected static SoundPlayer`	`theInstance`

Constructor Summary

Constructors
Constructor and Description

SoundPlayer(int simultaneousStreams, int cacheSize)
Instantiates a new sound player.

Constructors
Constructor and Description
`SoundPlayer(int simultaneousStreams, int cacheSize)` Instantiates a new sound player.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()`
`protected long`	`getCurrentMilliseconds()`
`static SoundPlayer`	`getInstance()`
`protected int`	`getMsDuration(Context context, int resourceId)`
`protected void`	`loadAndPlay(Context context, int resourceId, boolean waitForCompletion)` Loads the requested sound if necessary, then (eventually) plays it.
`void`	`onLoadComplete(SoundPool soundPool, int sampleId, int status)` Called when a sound has completed loading.
`void`	`play(Context context, int resId)` Asynchronously loads the indicated sound from its resource (if not already loaded), then initiates its play once any current sound is finished playing.
`void`	`play(Context context, int resId, boolean waitForCompletion)` Asynchronously loads the indicated sound from its resource (if not already loaded), then initiates its play, optionally waiting for any currently playing sound to finish first.
`protected void`	`playLoadedSound(SoundPlayer.SoundInfo soundInfo, boolean waitForCompletion)`
`protected void`	`shutdown()`
`protected void`	`startup()`
`protected void`	`waitForLoadCompletion()`

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

- Field Detail
  - TAG
```
public static final java.lang.String TAG
```
    See Also:
    Constant Field Values
  - DEBUG
```
public static final boolean DEBUG
```
    See Also:
    Constant Field Values
  - theInstance
```
protected static SoundPlayer theInstance
```
  - soundPool
```
protected SoundPool soundPool
```
  - currentlyLoading
```
protected volatile int currentlyLoading
```
  - msFinishPlaying
```
protected long msFinishPlaying
```
  - loadedSounds
```
protected SoundPlayer.LoadedSoundCache loadedSounds
```
  - executorService
```
protected java.util.concurrent.ExecutorService executorService
```
  - looper
```
protected Looper looper
```
  - context
```
protected Context context
```
  - sharedPreferences
```
protected SharedPreferences sharedPreferences
```
  - soundOnLevel
```
protected float soundOnLevel
```
  - soundOffLevel
```
protected float soundOffLevel
```
- Constructor Detail
  - SoundPlayer
```
public SoundPlayer(int simultaneousStreams,
           int cacheSize)
```
    Instantiates a new sound player.
    
    Parameters:
    simultaneousStreams - the number of sounds that can simultaneously play from this player. If one, then playing any new sound interrupts the playing of a a previous sound
    cacheSize - the maximum size of the cache of loaded sounds.
- Method Detail
  - getInstance
```
public static SoundPlayer getInstance()
```
  - close
```
public void close()
```
  - startup
```
protected void startup()
```
  - shutdown
```
protected void shutdown()
```
  - play
```
public void play(Context context,
        int resId)
```
    Asynchronously loads the indicated sound from its resource (if not already loaded), then initiates its play once any current sound is finished playing.
    
    Parameters:
    context - the context in which resId is to be interpreted
    resId - the resource id of the raw resource containing the sound.
  - play
```
public void play(Context context,
        int resId,
        boolean waitForCompletion)
```
    Asynchronously loads the indicated sound from its resource (if not already loaded), then initiates its play, optionally waiting for any currently playing sound to finish first.
    
    Parameters:
    context - the context in which resId is to be interpreted
    resId - the resource id of the raw resource containing the sound.
    waitForCompletion - whether to wait for any current sound to finish playing first or not
  - loadAndPlay
```
protected void loadAndPlay(Context context,
               int resourceId,
               boolean waitForCompletion)
```
    Loads the requested sound if necessary, then (eventually) plays it. Note: this always runs on our dedicate executor thread. We do that because that allows us to have a looper that *only* sees load completions, which will prevent us from accepting new play requests while we're waiting for loads to complete.
  - getMsDuration
```
protected int getMsDuration(Context context,
                int resourceId)
```
  - waitForLoadCompletion
```
protected void waitForLoadCompletion()
```
  - playLoadedSound
```
protected void playLoadedSound(SoundPlayer.SoundInfo soundInfo,
                   boolean waitForCompletion)
```
  - getCurrentMilliseconds
```
protected long getCurrentMilliseconds()
```
  - onLoadComplete
```
public void onLoadComplete(SoundPool soundPool,
                  int sampleId,
                  int status)
```
    Called when a sound has completed loading.
    
    Parameters:
    soundPool - SoundPool object from the load() method
    sampleId - the sample ID of the sound loaded.
    status - the status of the load operation (0 = success)

Class SoundPlayer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG

DEBUG

theInstance

soundPool

currentlyLoading

msFinishPlaying

loadedSounds

executorService

looper

context

sharedPreferences

soundOnLevel

soundOffLevel

Constructor Detail

SoundPlayer

Method Detail

getInstance

close

startup

shutdown

play

play

loadAndPlay

getMsDuration

waitForLoadCompletion

playLoadedSound

getCurrentMilliseconds

onLoadComplete