AudioTimestamp

Kotlin |Java

class AudioTimestamp : Parcelable

kotlin.Any
↳	android.media.AudioTimestamp

Structure that groups a position in frame units relative to an assumed audio stream, together with the estimated time when that frame enters or leaves the audio processing pipeline on that device. This can be used to coordinate events and interactions with the external environment.

The time is based on the implementation's best effort, using whatever knowledge is available to the system, but cannot account for any delay unknown to the implementation.

Summary

Constants
static Int	`TIMEBASE_BOOTTIME` Clock monotonic including suspend time or its equivalent on the system, in the same units and timebase as `android.os.SystemClock#elapsedRealtimeNanos`.
static Int	`TIMEBASE_MONOTONIC` Clock monotonic or its equivalent on the system, in the same units and timebase as `java.lang.System#nanoTime`.

Inherited constants

From class Parcelable

Int

CONTENTS_FILE_DESCRIPTOR

Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor.

Int

PARCELABLE_WRITE_RETURN_VALUE

Flag for use with writeToParcel: the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)". Some implementations may want to release resources at this point.

Public constructors
`AudioTimestamp()`

Public methods
Int	`describeContents()`
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AudioTimestamp!>	`CREATOR` Creates an instance from a `Parcel`.
Long	`framePosition` Position in frames relative to start of an assumed audio stream.
Long	`nanoTime` Time associated with the frame in the audio pipeline.

Constants

TIMEBASE_BOOTTIME

Added in API level 24

static val TIMEBASE_BOOTTIME: Int

Clock monotonic including suspend time or its equivalent on the system, in the same units and timebase as android.os.SystemClock#elapsedRealtimeNanos.

Value: 1

TIMEBASE_MONOTONIC

Added in API level 24

static val TIMEBASE_MONOTONIC: Int

Clock monotonic or its equivalent on the system, in the same units and timebase as java.lang.System#nanoTime.

Value: 0

Public constructors

AudioTimestamp

Added in API level 19

AudioTimestamp()

Public methods

describeContents

Added in API level 34

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

toString

Added in API level 19

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 34

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
`dest`	Parcel: 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 `android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE`, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 34

static val CREATOR: Parcelable.Creator<AudioTimestamp!>

Creates an instance from a Parcel.

framePosition

Added in API level 19

var framePosition: Long

Position in frames relative to start of an assumed audio stream.

When obtained through AudioRecord.getTimestamp(AudioTimestamp, int), all 64 bits of position are valid.

When obtained through AudioTrack.getTimestamp(AudioTimestamp), the low-order 32 bits of position is in wrapping frame units similar to AudioTrack.getPlaybackHeadPosition().

nanoTime

Added in API level 19

var nanoTime: Long

Time associated with the frame in the audio pipeline.

When obtained through AudioRecord.getTimestamp(AudioTimestamp, int), this is the estimated time in nanoseconds when the frame referred to by framePosition was captured. The timebase is either TIMEBASE_MONOTONIC or TIMEBASE_BOOTTIME, depending on the timebase parameter used in AudioRecord.getTimestamp(AudioTimestamp, int).

When obtained through AudioTrack.getTimestamp(AudioTimestamp), this is the estimated time when the frame was presented or is committed to be presented, with a timebase of TIMEBASE_MONOTONIC.