Builder
open class Builder
| kotlin.Any | |
| ↳ | android.media.SoundPool.Builder |
Builder class for SoundPool objects.
Summary
| Public constructors | |
|---|---|
Builder()Constructs a new Builder with the defaults format values. |
|
| Public methods | |
|---|---|
| open SoundPool! |
build() |
| open SoundPool.Builder! |
setAudioAttributes(attributes: AudioAttributes!)Sets the |
| open SoundPool.Builder |
setAudioSessionId(sessionId: Int)Sets the session ID the |
| open SoundPool.Builder |
setContext(context: Context)Sets the context the SoundPool belongs to. |
| open SoundPool.Builder! |
setMaxStreams(maxStreams: Int)Sets the maximum of number of simultaneous streams that can be played simultaneously. |
Public constructors
Builder
Builder()
Constructs a new Builder with the defaults format values. If not provided, the maximum number of streams is 1 (see setMaxStreams(int) to change it), and the audio attributes have a usage value of AudioAttributes.USAGE_MEDIA (see setAudioAttributes(android.media.AudioAttributes) to change them).
Public methods
setAudioAttributes
open fun setAudioAttributes(attributes: AudioAttributes!): SoundPool.Builder!
Sets the AudioAttributes. For examples, game applications will use attributes built with usage information set to AudioAttributes.USAGE_GAME.
| Parameters | |
|---|---|
attributes |
AudioAttributes!: a non-null |
| Return | |
|---|---|
SoundPool.Builder! |
|
setAudioSessionId
open fun setAudioSessionId(sessionId: Int): SoundPool.Builder
Sets the session ID the SoundPool will be attached to. Note, that if there's a device specific session id associated with the context (see Builder.setContext(Context)), explicitly setting a session id using this method will override it.
| Parameters | |
|---|---|
sessionId |
Int: a strictly positive ID number retrieved from another player or allocated by AudioManager via AudioManager.generateAudioSessionId(), or AudioManager.AUDIO_SESSION_ID_GENERATE. |
| Return | |
|---|---|
SoundPool.Builder |
the same Builder instance This value cannot be null. |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
when sessionId is invalid. |
setContext
open fun setContext(context: Context): SoundPool.Builder
Sets the context the SoundPool belongs to. The context will be used to pull information, such as android.content.AttributionSource and device specific audio session ids, which will be associated with the SoundPool. However, the context itself will not be retained by the SoundPool instance after initialization.
| Parameters | |
|---|---|
context |
Context: a non-null Context instance |
| Return | |
|---|---|
SoundPool.Builder |
the same Builder instance. This value cannot be null. |
setMaxStreams
open fun setMaxStreams(maxStreams: Int): SoundPool.Builder!
Sets the maximum of number of simultaneous streams that can be played simultaneously.
| Parameters | |
|---|---|
maxStreams |
Int: a value equal to 1 or greater. |
| Return | |
|---|---|
SoundPool.Builder! |
the same Builder instance |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
|