# AudioTimestamp

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Summary:[Constants](https://developer.android.com/reference/android/media/AudioTimestamp#constants)\|[Inherited Constants](https://developer.android.com/reference/android/media/AudioTimestamp#inhconstants)\|[Fields](https://developer.android.com/reference/android/media/AudioTimestamp#lfields)\|[Ctors](https://developer.android.com/reference/android/media/AudioTimestamp#pubctors)\|[Methods](https://developer.android.com/reference/android/media/AudioTimestamp#pubmethods)\|[Inherited Methods](https://developer.android.com/reference/android/media/AudioTimestamp#inhmethods)  

# AudioTimestamp

*** ** * ** ***

[Kotlin](https://developer.android.com/reference/kotlin/android/media/AudioTimestamp "View this page in Kotlin")\|Java

`
public

final

class
AudioTimestamp
`  
`

extends `[Object](https://developer.android.com/reference/java/lang/Object)`


``


implements

`[Parcelable](https://developer.android.com/reference/android/os/Parcelable)`


`

|---|------------------------------|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.AudioTimestamp |

<br />

*** ** * ** ***

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.  
**See also:**

- [AudioTrack.getTimestamp(AudioTimestamp)](https://developer.android.com/reference/android/media/AudioTrack#getTimestamp(android.media.AudioTimestamp))
- [AudioRecord.getTimestamp(AudioTimestamp, int)](https://developer.android.com/reference/android/media/AudioRecord#getTimestamp(android.media.AudioTimestamp,%20int))

## Summary

|                                                                                                                                                                      ### Constants                                                                                                                                                                       ||
|-------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | [TIMEBASE_BOOTTIME](https://developer.android.com/reference/android/media/AudioTimestamp#TIMEBASE_BOOTTIME) Clock monotonic including suspend time or its equivalent on the system, in the same units and timebase as[SystemClock.elapsedRealtimeNanos()](https://developer.android.com/reference/android/os/SystemClock#elapsedRealtimeNanos()). |
| `int` | [TIMEBASE_MONOTONIC](https://developer.android.com/reference/android/media/AudioTimestamp#TIMEBASE_MONOTONIC) Clock monotonic or its equivalent on the system, in the same units and timebase as[System.nanoTime()](https://developer.android.com/reference/java/lang/System#nanoTime()).                                                         |

|                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ### Inherited constants                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| From interface[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable) |-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `int` | [CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) Descriptor bit used with[describeContents()](https://developer.android.com/reference/android/os/Parcelable#describeContents()): indicates that the Parcelable object's flattened representation includes a file descriptor.                                                                                                                                            | | `int` | [PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE) Flag for use with[writeToParcel(Parcel, int)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)): 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)`". | |

|                                                                                                                                                                                         ### Fields                                                                                                                                                                                          ||
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` public static final `[Creator](https://developer.android.com/reference/android/os/Parcelable.Creator)`<`[AudioTimestamp](https://developer.android.com/reference/android/media/AudioTimestamp)`>` | [CREATOR](https://developer.android.com/reference/android/media/AudioTimestamp#CREATOR) Creates an instance from a[Parcel](https://developer.android.com/reference/android/os/Parcel). |
| ` public long`                                                                                                                                                                                      | [framePosition](https://developer.android.com/reference/android/media/AudioTimestamp#framePosition) Position in frames relative to start of an assumed audio stream.                   |
| ` public long`                                                                                                                                                                                      | [nanoTime](https://developer.android.com/reference/android/media/AudioTimestamp#nanoTime) Time associated with the frame in the audio pipeline.                                        |

|                                              ### Public constructors                                               ||
|-----------------------------------------------------------------------------------------------------------------|---|
| ` `[AudioTimestamp](https://developer.android.com/reference/android/media/AudioTimestamp#AudioTimestamp())`() ` |

|                                                                                                                                                          ### Public methods                                                                                                                                                           ||
|-----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ` int`                                                                | ` `[describeContents](https://developer.android.com/reference/android/media/AudioTimestamp#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    |
| ` `[String](https://developer.android.com/reference/java/lang/String) | ` `[toString](https://developer.android.com/reference/android/media/AudioTimestamp#toString())`() ` Returns a string representation of the object.                                                                                                             |
| ` void`                                                               | ` `[writeToParcel](https://developer.android.com/reference/android/media/AudioTimestamp#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. |

| ### Inherited methods |
|-----------------------|---|
| From class` `[java.lang.Object](https://developer.android.com/reference/java/lang/Object)` ` |--------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](https://developer.android.com/reference/java/lang/Object)          | ` `[clone](https://developer.android.com/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object.                                                                                                                                                      | | ` boolean`                                                                     | ` `[equals](https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](https://developer.android.com/reference/java/lang/Object)` obj) ` Indicates whether some other object is "equal to" this one.                                           | | ` void`                                                                        | ` `[finalize](https://developer.android.com/reference/java/lang/Object#finalize())`() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.                                                          | | ` final `[Class](https://developer.android.com/reference/java/lang/Class)`<?>` | ` `[getClass](https://developer.android.com/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this`Object`.                                                                                                                                                | | ` int`                                                                         | ` `[hashCode](https://developer.android.com/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object.                                                                                                                                                 | | ` final void`                                                                  | ` `[notify](https://developer.android.com/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor.                                                                                                                            | | ` final void`                                                                  | ` `[notifyAll](https://developer.android.com/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor.                                                                                                                         | | ` `[String](https://developer.android.com/reference/java/lang/String)          | ` `[toString](https://developer.android.com/reference/java/lang/Object#toString())`() ` Returns a string representation of the object.                                                                                                                                            | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long,%20int))`(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed. | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait(long))`(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*, or until a certain amount of real time has elapsed.                   | | ` final void`                                                                  | ` `[wait](https://developer.android.com/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being*notified* or*interrupted*.                                                                                             | ||
| From interface` `[android.os.Parcelable](https://developer.android.com/reference/android/os/Parcelable)` ` |------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` abstract int`  | ` `[describeContents](https://developer.android.com/reference/android/os/Parcelable#describeContents())`() ` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.                                    | | ` abstract void` | ` `[writeToParcel](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int))`(`[Parcel](https://developer.android.com/reference/android/os/Parcel)` dest, int flags) ` Flatten this object in to a Parcel. | ||

## Constants

### TIMEBASE_BOOTTIME

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final int TIMEBASE_BOOTTIME
```

Clock monotonic including suspend time or its equivalent on the system, in the same units and timebase as[SystemClock.elapsedRealtimeNanos()](https://developer.android.com/reference/android/os/SystemClock#elapsedRealtimeNanos()).

<br />

Constant Value: 1 (0x00000001)  

### TIMEBASE_MONOTONIC

Added in[API level 24](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final int TIMEBASE_MONOTONIC
```

Clock monotonic or its equivalent on the system, in the same units and timebase as[System.nanoTime()](https://developer.android.com/reference/java/lang/System#nanoTime()).

<br />

Constant Value: 0 (0x00000000)

## Fields

### CREATOR

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public static final Creator<AudioTimestamp> CREATOR
```

Creates an instance from a[Parcel](https://developer.android.com/reference/android/os/Parcel).

<br />

### framePosition

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long framePosition
```

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

When obtained through[AudioRecord.getTimestamp(AudioTimestamp, int)](https://developer.android.com/reference/android/media/AudioRecord#getTimestamp(android.media.AudioTimestamp,%20int)), all 64 bits of position are valid.

When obtained through[AudioTrack.getTimestamp(AudioTimestamp)](https://developer.android.com/reference/android/media/AudioTrack#getTimestamp(android.media.AudioTimestamp)), the low-order 32 bits of position is in wrapping frame units similar to[AudioTrack.getPlaybackHeadPosition()](https://developer.android.com/reference/android/media/AudioTrack#getPlaybackHeadPosition()).

<br />

### nanoTime

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public long nanoTime
```

Time associated with the frame in the audio pipeline.

When obtained through[AudioRecord.getTimestamp(AudioTimestamp, int)](https://developer.android.com/reference/android/media/AudioRecord#getTimestamp(android.media.AudioTimestamp,%20int)), this is the estimated time in nanoseconds when the frame referred to by[framePosition](https://developer.android.com/reference/android/media/AudioTimestamp#framePosition)was captured. The timebase is either[TIMEBASE_MONOTONIC](https://developer.android.com/reference/android/media/AudioTimestamp#TIMEBASE_MONOTONIC)or[TIMEBASE_BOOTTIME](https://developer.android.com/reference/android/media/AudioTimestamp#TIMEBASE_BOOTTIME), depending on the timebase parameter used in[AudioRecord.getTimestamp(AudioTimestamp, int)](https://developer.android.com/reference/android/media/AudioRecord#getTimestamp(android.media.AudioTimestamp,%20int)).

When obtained through[AudioTrack.getTimestamp(AudioTimestamp)](https://developer.android.com/reference/android/media/AudioTrack#getTimestamp(android.media.AudioTimestamp)), this is the estimated time when the frame was presented or is committed to be presented, with a timebase of[TIMEBASE_MONOTONIC](https://developer.android.com/reference/android/media/AudioTimestamp#TIMEBASE_MONOTONIC).

<br />

## Public constructors

### AudioTimestamp

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public AudioTimestamp ()
```

<br />

<br />

## Public methods

### describeContents

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public int describeContents ()
```

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)](https://developer.android.com/reference/android/os/Parcelable#writeToParcel(android.os.Parcel,%20int)), the return value of this method must include the[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR)bit.

<br />

|                                                                                                                         Returns                                                                                                                         ||
|-------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `int` | a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either`0`or[CONTENTS_FILE_DESCRIPTOR](https://developer.android.com/reference/android/os/Parcelable#CONTENTS_FILE_DESCRIPTOR) <br /> |

### toString

Added in[API level 19](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public String toString ()
```

Returns a string representation of the object.

<br />

|                                                      Returns                                                      ||
|--------------------------------------------------------------------|-----------------------------------------------|
| [String](https://developer.android.com/reference/java/lang/String) | a string representation of the object. <br /> |

### writeToParcel

Added in[API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  

```
public void writeToParcel (Parcel dest, 
                int flags)
```

Flatten this object in to a Parcel.

<br />

|                                                                                                                                                                                                                               Parameters                                                                                                                                                                                                                                ||
|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `dest`  | `Parcel`: This value cannot be`null`. <br />                                                                                                                                                                                                                                                                                                                                                                                                                   |
| `flags` | `int`: Additional flags about how the object should be written. May be 0 or[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE). Value is either`0`or a combination of[Parcelable.PARCELABLE_WRITE_RETURN_VALUE](https://developer.android.com/reference/android/os/Parcelable#PARCELABLE_WRITE_RETURN_VALUE), and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES <br /> |