Configuration
class Configuration : Parcelable
| kotlin.Any | |
| ↳ | android.media.VolumeShaper.Configuration |
The VolumeShaper.Configuration class contains curve and duration information. It is constructed by the VolumeShaper.Configuration.Builder.
A VolumeShaper.Configuration is used by VolumeAutomation.createVolumeShaper(Configuration) to create a VolumeShaper and by VolumeShaper.replace(Configuration, Operation, boolean) to replace an existing configuration.
The AudioTrack and MediaPlayer classes implement the VolumeAutomation interface.
Summary
| Nested classes | |
|---|---|
|
Builder class for a |
|
| Constants | |
|---|---|
| static Int |
Cubic interpolated volume curve. |
| static Int |
Cubic interpolated volume curve that preserves local monotonicity. |
| static Int |
Linear interpolated volume curve. |
| static Int |
Stepwise volume curve. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Long |
Returns the duration of the volume shape in milliseconds. |
| Int |
Returns the interpolator type. |
| static Int |
Returns the maximum number of curve points allowed for VolumeShaper. |
| FloatArray! |
getTimes()Returns the times (x) coordinate array of the volume curve points. |
| FloatArray! |
Returns the volumes (y) coordinate array of the volume curve points. |
| Int |
hashCode()Returns a hash code value for the object. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<VolumeShaper.Configuration!> | |
| static VolumeShaper.Configuration! |
A one second cubic ramp from silence to full volume. |
| static VolumeShaper.Configuration! |
A one second linear ramp from silence to full volume. |
| static VolumeShaper.Configuration! |
A one second sine-squared s-curve ramp from silence to full volume. |
| static VolumeShaper.Configuration! |
A one second sine curve from silence to full volume for energy preserving cross fades. |
Constants
INTERPOLATOR_TYPE_CUBIC
static val INTERPOLATOR_TYPE_CUBIC: Int
Cubic interpolated volume curve. This is default if unspecified.
Value: 2INTERPOLATOR_TYPE_CUBIC_MONOTONIC
static val INTERPOLATOR_TYPE_CUBIC_MONOTONIC: Int
Cubic interpolated volume curve that preserves local monotonicity. So long as the control points are locally monotonic, the curve interpolation between those points are monotonic. This is useful for cubic spline interpolated volume ramps and ducks.
Value: 3INTERPOLATOR_TYPE_LINEAR
static val INTERPOLATOR_TYPE_LINEAR: Int
Linear interpolated volume curve.
Value: 1INTERPOLATOR_TYPE_STEP
static val INTERPOLATOR_TYPE_STEP: Int
Stepwise volume curve.
Value: 0Public methods
describeContents
fun describeContents(): Int
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
fun equals(other: Any?): Boolean
Indicates whether some other object is "equal to" this one.
The equals method implements an equivalence relation on non-null object references:
- It is reflexive: for any non-null reference value
x,x.equals(x)should returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getDuration
fun getDuration(): Long
Returns the duration of the volume shape in milliseconds.
getInterpolatorType
fun getInterpolatorType(): Int
Returns the interpolator type.
| Return | |
|---|---|
Int |
Value is one of the following: |
getMaximumCurvePoints
static fun getMaximumCurvePoints(): Int
Returns the maximum number of curve points allowed for VolumeShaper.Builder#setCurve(float[], float[]).
getTimes
fun getTimes(): FloatArray!
Returns the times (x) coordinate array of the volume curve points.
getVolumes
fun getVolumes(): FloatArray!
Returns the volumes (y) coordinate array of the volume curve points.
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.
The general contract of hashCode is:
- Whenever it is invoked on the same object more than once during an execution of a Java application, the
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. - If two objects are equal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce the same integer result. - It is not required that if two objects are unequal according to the
equalsmethod, then calling thehashCodemethod on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel: The Parcel in which the object should be written. This value cannot be null. |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|
Properties
CUBIC_RAMP
static val CUBIC_RAMP: VolumeShaper.Configuration!
A one second cubic ramp from silence to full volume. Use VolumeShaper.Builder#reflectTimes() or VolumeShaper.Builder#invertVolumes() to generate the matching cubic duck.
LINEAR_RAMP
static val LINEAR_RAMP: VolumeShaper.Configuration!
A one second linear ramp from silence to full volume. Use VolumeShaper.Builder#reflectTimes() or VolumeShaper.Builder#invertVolumes() to generate the matching linear duck.
SCURVE_RAMP
static val SCURVE_RAMP: VolumeShaper.Configuration!
A one second sine-squared s-curve ramp from silence to full volume. Use VolumeShaper.Builder#reflectTimes() or VolumeShaper.Builder#invertVolumes() to generate the matching sine-squared s-curve duck.
SINE_RAMP
static val SINE_RAMP: VolumeShaper.Configuration!
A one second sine curve from silence to full volume for energy preserving cross fades. Use VolumeShaper.Builder#reflectTimes() to generate the matching cosine duck.