Skip to content

Most visited

Recently visited

navigation
Added in API level 19

AudioTimestamp

public final class AudioTimestamp
extends Object

java.lang.Object
   ↳ 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.

See also:

Summary

Constants

int TIMEBASE_BOOTTIME

Clock monotonic including suspend time or its equivalent on the system, in the same units and timebase as elapsedRealtimeNanos().

int TIMEBASE_MONOTONIC

Clock monotonic or its equivalent on the system, in the same units and timebase as nanoTime().

Fields

public long framePosition

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

public long nanoTime

Time associated with the frame in the audio pipeline.

Public constructors

AudioTimestamp()

Inherited methods

From class java.lang.Object

Constants

TIMEBASE_BOOTTIME

Added in API level 24
int TIMEBASE_BOOTTIME

Clock monotonic including suspend time or its equivalent on the system, in the same units and timebase as elapsedRealtimeNanos().

Constant Value: 1 (0x00000001)

TIMEBASE_MONOTONIC

Added in API level 24
int TIMEBASE_MONOTONIC

Clock monotonic or its equivalent on the system, in the same units and timebase as nanoTime().

Constant Value: 0 (0x00000000)

Fields

framePosition

Added in API level 19
long framePosition

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
long nanoTime

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.

Public constructors

AudioTimestamp

Added in API level 19
AudioTimestamp ()

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.