SoundPool.Play(Int32, Single, Single, Int32, Int32, Single) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Play a sound from a sound ID.
[Android.Runtime.Register("play", "(IFFIIF)I", "")]
public int Play (int soundID, float leftVolume, float rightVolume, int priority, int loop, float rate);[<Android.Runtime.Register("play", "(IFFIIF)I", "")>]
member this.Play : int * single * single * int * int * single -> intParameters
- soundID
- Int32
a soundID returned by the load() function
- leftVolume
- Single
left volume value (range = 0.0 to 1.0)
- rightVolume
- Single
right volume value (range = 0.0 to 1.0)
- priority
- Int32
stream priority (0 = lowest priority)
- loop
- Int32
loop mode (0 = no loop, -1 = loop forever)
- rate
- Single
playback rate (1.0 = normal playback, range 0.5 to 2.0)
Returns
non-zero streamID if successful, zero if failed
- Attributes
Remarks
Play a sound from a sound ID.
Play the sound specified by the soundID. This is the value returned by the load() function. Returns a non-zero streamID if successful, zero if it fails. The streamID can be used to further control playback. Note that calling play() may cause another sound to stop playing if the maximum number of active streams is exceeded. A loop value of -1 means loop forever, a value of 0 means don't loop, other values indicate the number of repeats, e.g. a value of 1 plays the audio twice. The playback rate allows the application to vary the playback rate (pitch) of the sound. A value of 1.0 means play back at the original frequency. A value of 2.0 means play back twice as fast, and a value of 0.5 means playback at half speed.
Java documentation for android.media.SoundPool.play(int, float, float, int, int, float).
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.