SoundEffectPoolComponentTester
class SoundEffectPoolComponentTester
A test-only accessor for SoundEffectPoolComponent that enables direct manipulation and inspection of its internal state.
Summary
Public functions |
|
|---|---|
open operator Boolean |
|
@IntRange(from = 0) Int |
getPriority(stream: Stream)Retrieves the playback priority of the specified |
SoundEffect |
getSoundEffect(stream: Stream)Retrieves the |
@FloatRange(from = 0.0, to = 1.0) Float |
Retrieves the current volume of the specified |
open Int |
hashCode() |
Boolean |
Returns whether the specified |
Public properties |
|
|---|---|
Stream? |
The |
PointSourceParams? |
Retrieves the |
Stream? |
The |
Stream? |
The |
Stream? |
The |
Public functions
getPriority
fun getPriority(stream: Stream): @IntRange(from = 0) Int
Retrieves the playback priority of the specified stream.
Priority is represented by a non-negative integer, where 0 is the lowest priority and greater values indicate higher priorities.
| Parameters | |
|---|---|
stream: Stream |
a |
| Throws | |
|---|---|
IllegalArgumentException |
if the stream is no longer active or is invalid |
getSoundEffect
fun getSoundEffect(stream: Stream): SoundEffect
Retrieves the SoundEffect associated with the specified stream.
| Parameters | |
|---|---|
stream: Stream |
a |
| Returns | |
|---|---|
SoundEffect |
the |
| Throws | |
|---|---|
IllegalArgumentException |
if the stream is no longer active or is invalid |
getVolume
fun getVolume(stream: Stream): @FloatRange(from = 0.0, to = 1.0) Float
Retrieves the current volume of the specified stream.
| Parameters | |
|---|---|
stream: Stream |
a |
| Returns | |
|---|---|
@FloatRange(from = 0.0, to = 1.0) Float |
the volume of the stream in the range 0.0 to 1.0 |
| Throws | |
|---|---|
IllegalArgumentException |
if the stream is no longer active or is invalid |
isLooping
fun isLooping(stream: Stream): Boolean
Returns whether the specified stream is configured to loop indefinitely.
| Parameters | |
|---|---|
stream: Stream |
a |
| Returns | |
|---|---|
Boolean |
true if the stream is looping, false otherwise |
| Throws | |
|---|---|
IllegalArgumentException |
if the stream is no longer active or is invalid |
Public properties
lastPausedStream
val lastPausedStream: Stream?
The Stream of the most recently paused sound, or null if no stream has been paused yet.
lastPlayedPointSourceParams
val lastPlayedPointSourceParams: PointSourceParams?
Retrieves the PointSourceParams used in the most recent call to SoundEffectPoolComponent.play, or null if play has not been called yet.
lastPlayedStream
val lastPlayedStream: Stream?
The Stream of the most recently played sound, or null if no stream has been played yet.
lastResumedStream
val lastResumedStream: Stream?
The Stream of the most recently resumed sound, or null if no stream has been resumed yet.
lastStoppedStream
val lastStoppedStream: Stream?
The Stream of the most recently stopped sound, or null if no stream has been stopped yet.