PlaybackParams.Builder
class PlaybackParams.Builder
The builder class that makes it easy to chain setters to create a PlaybackParams object.
Summary
Public constructors |
|---|
Builder()Default constructor |
Builder(playbackParams: PlaybackParams)Constructs a new PlaybackParams builder using data from |
Public functions |
|
|---|---|
PlaybackParams |
build()Takes the values of the Builder object and creates a PlaybackParams object. |
PlaybackParams.Builder |
setAudioFallbackMode(audioFallbackMode: Int)Sets the audio fallback mode. |
PlaybackParams.Builder |
setPitch(Sets the pitch factor. |
PlaybackParams.Builder |
setSpeed(Sets the speed factor. |
Public constructors
Builder(playbackParams: PlaybackParams)
Constructs a new PlaybackParams builder using data from playbackParams.
| Parameters | |
|---|---|
playbackParams: PlaybackParams |
the non-null instance to initialize from. |
Public functions
fun build(): PlaybackParams
Takes the values of the Builder object and creates a PlaybackParams object.
| Returns | |
|---|---|
PlaybackParams |
PlaybackParams object with values from the Builder. |
fun setAudioFallbackMode(audioFallbackMode: Int): PlaybackParams.Builder
Sets the audio fallback mode.
| Returns | |
|---|---|
PlaybackParams.Builder |
this |
fun setPitch(
pitch: @FloatRange(from = 0.0, to = Float.MAX_VALUE, fromInclusive = false) Float
): PlaybackParams.Builder
Sets the pitch factor.
| Returns | |
|---|---|
PlaybackParams.Builder |
this |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the pitch is negative or zero. |
fun setSpeed(
speed: @FloatRange(from = 0.0, to = Float.MAX_VALUE, fromInclusive = false) Float
): PlaybackParams.Builder
Sets the speed factor.
| Returns | |
|---|---|
PlaybackParams.Builder |
this |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the speed is negative or zero. |