diff options
author | Justin Klaassen <justinklaassen@google.com> | 2017-09-15 17:58:39 -0400 |
---|---|---|
committer | Justin Klaassen <justinklaassen@google.com> | 2017-09-15 17:58:39 -0400 |
commit | 10d07c88d69cc64f73a069163e7ea5ba2519a099 (patch) | |
tree | 8dbd149eb350320a29c3d10e7ad3201de1c5cbee /android/media/AudioTimestamp.java | |
parent | 677516fb6b6f207d373984757d3d9450474b6b00 (diff) | |
download | android-28-10d07c88d69cc64f73a069163e7ea5ba2519a099.tar.gz |
Import Android SDK Platform PI [4335822]
/google/data/ro/projects/android/fetch_artifact \
--bid 4335822 \
--target sdk_phone_armv7-win_sdk \
sdk-repo-linux-sources-4335822.zip
AndroidVersion.ApiLevel has been modified to appear as 28
Change-Id: Ic8f04be005a71c2b9abeaac754d8da8d6f9a2c32
Diffstat (limited to 'android/media/AudioTimestamp.java')
-rw-r--r-- | android/media/AudioTimestamp.java | 89 |
1 files changed, 89 insertions, 0 deletions
diff --git a/android/media/AudioTimestamp.java b/android/media/AudioTimestamp.java new file mode 100644 index 00000000..be8ca151 --- /dev/null +++ b/android/media/AudioTimestamp.java @@ -0,0 +1,89 @@ +/* + * Copyright (C) 2013 The Android Open Source Project + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package android.media; + +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; + +import android.annotation.IntDef; + +/** + * 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. + * <p> + * 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 AudioTrack#getTimestamp AudioTrack.getTimestamp(AudioTimestamp) + * @see AudioRecord#getTimestamp AudioRecord.getTimestamp(AudioTimestamp, int) + */ +public final class AudioTimestamp +{ + /** + * Clock monotonic or its equivalent on the system, + * in the same units and timebase as {@link java.lang.System#nanoTime}. + */ + public static final int TIMEBASE_MONOTONIC = 0; + + /** + * Clock monotonic including suspend time or its equivalent on the system, + * in the same units and timebase as {@link android.os.SystemClock#elapsedRealtimeNanos}. + */ + public static final int TIMEBASE_BOOTTIME = 1; + + /** @hide */ + @IntDef({ + TIMEBASE_MONOTONIC, + TIMEBASE_BOOTTIME, + }) + @Retention(RetentionPolicy.SOURCE) + public @interface Timebase {} + + /** + * Position in frames relative to start of an assumed audio stream. + * <p> + * When obtained through + * {@link AudioRecord#getTimestamp AudioRecord.getTimestamp(AudioTimestamp, int)}, + * all 64 bits of position are valid. + * <p> + * When obtained through + * {@link AudioTrack#getTimestamp AudioTrack.getTimestamp(AudioTimestamp)}, + * the low-order 32 bits of position is in wrapping frame units similar to + * {@link AudioTrack#getPlaybackHeadPosition AudioTrack.getPlaybackHeadPosition()}. + */ + public long framePosition; + + /** + * Time associated with the frame in the audio pipeline. + * <p> + * When obtained through + * {@link AudioRecord#getTimestamp AudioRecord.getTimestamp(AudioTimestamp, int)}, + * this is the estimated time in nanoseconds when the frame referred to by + * {@link #framePosition} was captured. The timebase is either + * {@link #TIMEBASE_MONOTONIC} or {@link #TIMEBASE_BOOTTIME}, depending + * on the timebase parameter used in + * {@link AudioRecord#getTimestamp AudioRecord.getTimestamp(AudioTimestamp, int)}. + * <p> + * When obtained through + * {@link AudioTrack#getTimestamp AudioTrack.getTimestamp(AudioTimestamp)}, + * this is the estimated time when the frame was presented or is committed to be presented, + * with a timebase of {@link #TIMEBASE_MONOTONIC}. + */ + public long nanoTime; +} |