564 lines
23 KiB
Java
564 lines
23 KiB
Java
|
/*
|
||
|
|
* Copyright (C) 2022 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.service.voice;
|
||
|
|
|
||
|
|
import android.annotation.NonNull;
|
||
|
|
import android.annotation.Nullable;
|
||
|
|
import android.annotation.SystemApi;
|
||
|
|
import android.media.AudioFormat;
|
||
|
|
import android.media.AudioRecord;
|
||
|
|
import android.media.AudioTimestamp;
|
||
|
|
import android.os.Parcel;
|
||
|
|
import android.os.ParcelFileDescriptor;
|
||
|
|
import android.os.Parcelable;
|
||
|
|
import android.os.PersistableBundle;
|
||
|
|
|
||
|
|
import com.android.internal.util.DataClass;
|
||
|
|
|
||
|
|
import java.util.Arrays;
|
||
|
|
import java.util.Objects;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Represents an audio stream supporting the hotword detection.
|
||
|
|
*
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
@DataClass(
|
||
|
|
genConstructor = false,
|
||
|
|
genBuilder = true,
|
||
|
|
genEqualsHashCode = true,
|
||
|
|
genParcelable = true,
|
||
|
|
genToString = true
|
||
|
|
)
|
||
|
|
@SystemApi
|
||
|
|
public final class HotwordAudioStream implements Parcelable {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Key for int value to be read from {@link #getMetadata()}. The value is read by the system and
|
||
|
|
* is the length (in bytes) of the byte buffers created to copy bytes in the
|
||
|
|
* {@link #getAudioStreamParcelFileDescriptor()} written by the {@link HotwordDetectionService}.
|
||
|
|
* The buffer length should be chosen such that no additional latency is introduced. Typically,
|
||
|
|
* this should be <em>at least</em> the size of byte chunks written by the
|
||
|
|
* {@link HotwordDetectionService}.
|
||
|
|
*
|
||
|
|
* <p>If no value specified in the metadata for the buffer length, or if the value is less than
|
||
|
|
* 1, or if it is greater than 65,536, or if it is not an int, the default value of 2,560 will
|
||
|
|
* be used.</p>
|
||
|
|
*/
|
||
|
|
public static final String KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES =
|
||
|
|
"android.service.voice.key.AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link AudioFormat} of the audio stream.
|
||
|
|
*/
|
||
|
|
@NonNull
|
||
|
|
private final AudioFormat mAudioFormat;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This stream typically starts with the audio bytes used for hotword detection, but continues
|
||
|
|
* streaming the audio (e.g., with the query) until the stream is shutdown by the
|
||
|
|
* {@link HotwordDetectionService}. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* Alternatively, the {@link HotwordDetectionService} may use {@link #getInitialAudio()}
|
||
|
|
* to pass the start of the audio instead of streaming it here. This may prevent added latency
|
||
|
|
* caused by the streaming buffer (see {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not
|
||
|
|
* being large enough to handle this initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
@NonNull
|
||
|
|
private final ParcelFileDescriptor mAudioStreamParcelFileDescriptor;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The timestamp when the audio stream was captured by the Audio platform.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* The {@link HotwordDetectionService} egressing the audio is the owner of the underlying
|
||
|
|
* AudioRecord. The {@link HotwordDetectionService} is expected to optionally populate this
|
||
|
|
* field by {@link AudioRecord#getTimestamp}.
|
||
|
|
* </p>
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* This timestamp can be used in conjunction with the
|
||
|
|
* {@link HotwordDetectedResult#getHotwordOffsetMillis()} and
|
||
|
|
* {@link HotwordDetectedResult#getHotwordDurationMillis()} to translate these durations to
|
||
|
|
* timestamps.
|
||
|
|
* </p>
|
||
|
|
*
|
||
|
|
* @see #getAudioStreamParcelFileDescriptor()
|
||
|
|
*/
|
||
|
|
@Nullable
|
||
|
|
private final AudioTimestamp mTimestamp;
|
||
|
|
private static AudioTimestamp defaultTimestamp() {
|
||
|
|
return null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The metadata associated with the audio stream.
|
||
|
|
*/
|
||
|
|
@NonNull
|
||
|
|
private final PersistableBundle mMetadata;
|
||
|
|
private static PersistableBundle defaultMetadata() {
|
||
|
|
return new PersistableBundle();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The start of the audio used for hotword detection. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* The {@link HotwordDetectionService} may use this instead of using
|
||
|
|
* {@link #getAudioStreamParcelFileDescriptor()} to stream these initial bytes of audio. This
|
||
|
|
* may prevent added latency caused by the streaming buffer (see
|
||
|
|
* {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not being large enough to handle this
|
||
|
|
* initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
@NonNull
|
||
|
|
private final byte[] mInitialAudio;
|
||
|
|
private static final byte[] DEFAULT_INITIAL_EMPTY_AUDIO = {};
|
||
|
|
private static byte[] defaultInitialAudio() {
|
||
|
|
return DEFAULT_INITIAL_EMPTY_AUDIO;
|
||
|
|
}
|
||
|
|
|
||
|
|
private String initialAudioToString() {
|
||
|
|
return "length=" + mInitialAudio.length;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Provides an instance of {@link Builder} with state corresponding to this instance.
|
||
|
|
* @hide
|
||
|
|
*/
|
||
|
|
public Builder buildUpon() {
|
||
|
|
return new Builder(mAudioFormat, mAudioStreamParcelFileDescriptor)
|
||
|
|
.setTimestamp(mTimestamp)
|
||
|
|
.setMetadata(mMetadata)
|
||
|
|
.setInitialAudio(mInitialAudio);
|
||
|
|
}
|
||
|
|
|
||
|
|
@DataClass.Suppress("setInitialAudio")
|
||
|
|
abstract static class BaseBuilder {
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The start of the audio used for hotword detection. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* The {@link HotwordDetectionService} may use this instead of using
|
||
|
|
* {@link #getAudioStreamParcelFileDescriptor()} to stream these initial bytes of audio.
|
||
|
|
* This may prevent added latency caused by the streaming buffer (see
|
||
|
|
* {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not being large enough to handle this
|
||
|
|
* initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
public @NonNull Builder setInitialAudio(@NonNull byte[] value) {
|
||
|
|
Objects.requireNonNull(value, "value should not be null");
|
||
|
|
final Builder builder = (Builder) this;
|
||
|
|
// If the code gen flag in build() is changed, we must update the flag e.g. 0x10 here.
|
||
|
|
builder.mBuilderFieldsSet |= 0x10;
|
||
|
|
builder.mInitialAudio = value;
|
||
|
|
return builder;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// Code below generated by codegen v1.0.23.
|
||
|
|
//
|
||
|
|
// DO NOT MODIFY!
|
||
|
|
// CHECKSTYLE:OFF Generated code
|
||
|
|
//
|
||
|
|
// To regenerate run:
|
||
|
|
// $ codegen $ANDROID_BUILD_TOP/frameworks/base/core/java/android/service/voice/HotwordAudioStream.java
|
||
|
|
//
|
||
|
|
// To exclude the generated code from IntelliJ auto-formatting enable (one-time):
|
||
|
|
// Settings > Editor > Code Style > Formatter Control
|
||
|
|
//@formatter:off
|
||
|
|
|
||
|
|
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
/* package-private */ HotwordAudioStream(
|
||
|
|
@NonNull AudioFormat audioFormat,
|
||
|
|
@NonNull ParcelFileDescriptor audioStreamParcelFileDescriptor,
|
||
|
|
@Nullable AudioTimestamp timestamp,
|
||
|
|
@NonNull PersistableBundle metadata,
|
||
|
|
@NonNull byte[] initialAudio) {
|
||
|
|
this.mAudioFormat = audioFormat;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mAudioFormat);
|
||
|
|
this.mAudioStreamParcelFileDescriptor = audioStreamParcelFileDescriptor;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mAudioStreamParcelFileDescriptor);
|
||
|
|
this.mTimestamp = timestamp;
|
||
|
|
this.mMetadata = metadata;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mMetadata);
|
||
|
|
this.mInitialAudio = initialAudio;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mInitialAudio);
|
||
|
|
|
||
|
|
// onConstructed(); // You can define this method to get a callback
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link AudioFormat} of the audio stream.
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull AudioFormat getAudioFormat() {
|
||
|
|
return mAudioFormat;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This stream typically starts with the audio bytes used for hotword detection, but continues
|
||
|
|
* streaming the audio (e.g., with the query) until the stream is shutdown by the
|
||
|
|
* {@link HotwordDetectionService}. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* Alternatively, the {@link HotwordDetectionService} may use {@link #getInitialAudio()}
|
||
|
|
* to pass the start of the audio instead of streaming it here. This may prevent added latency
|
||
|
|
* caused by the streaming buffer (see {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not
|
||
|
|
* being large enough to handle this initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull ParcelFileDescriptor getAudioStreamParcelFileDescriptor() {
|
||
|
|
return mAudioStreamParcelFileDescriptor;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The timestamp when the audio stream was captured by the Audio platform.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* The {@link HotwordDetectionService} egressing the audio is the owner of the underlying
|
||
|
|
* AudioRecord. The {@link HotwordDetectionService} is expected to optionally populate this
|
||
|
|
* field by {@link AudioRecord#getTimestamp}.
|
||
|
|
* </p>
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* This timestamp can be used in conjunction with the
|
||
|
|
* {@link HotwordDetectedResult#getHotwordOffsetMillis()} and
|
||
|
|
* {@link HotwordDetectedResult#getHotwordDurationMillis()} to translate these durations to
|
||
|
|
* timestamps.
|
||
|
|
* </p>
|
||
|
|
*
|
||
|
|
* @see #getAudioStreamParcelFileDescriptor()
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @Nullable AudioTimestamp getTimestamp() {
|
||
|
|
return mTimestamp;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The metadata associated with the audio stream.
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull PersistableBundle getMetadata() {
|
||
|
|
return mMetadata;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The start of the audio used for hotword detection. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* The {@link HotwordDetectionService} may use this instead of using
|
||
|
|
* {@link #getAudioStreamParcelFileDescriptor()} to stream these initial bytes of audio. This
|
||
|
|
* may prevent added latency caused by the streaming buffer (see
|
||
|
|
* {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not being large enough to handle this
|
||
|
|
* initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull byte[] getInitialAudio() {
|
||
|
|
return mInitialAudio;
|
||
|
|
}
|
||
|
|
|
||
|
|
@Override
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public String toString() {
|
||
|
|
// You can override field toString logic by defining methods like:
|
||
|
|
// String fieldNameToString() { ... }
|
||
|
|
|
||
|
|
return "HotwordAudioStream { " +
|
||
|
|
"audioFormat = " + mAudioFormat + ", " +
|
||
|
|
"audioStreamParcelFileDescriptor = " + mAudioStreamParcelFileDescriptor + ", " +
|
||
|
|
"timestamp = " + mTimestamp + ", " +
|
||
|
|
"metadata = " + mMetadata + ", " +
|
||
|
|
"initialAudio = " + initialAudioToString() +
|
||
|
|
" }";
|
||
|
|
}
|
||
|
|
|
||
|
|
@Override
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public boolean equals(@Nullable Object o) {
|
||
|
|
// You can override field equality logic by defining either of the methods like:
|
||
|
|
// boolean fieldNameEquals(HotwordAudioStream other) { ... }
|
||
|
|
// boolean fieldNameEquals(FieldType otherValue) { ... }
|
||
|
|
|
||
|
|
if (this == o) return true;
|
||
|
|
if (o == null || getClass() != o.getClass()) return false;
|
||
|
|
@SuppressWarnings("unchecked")
|
||
|
|
HotwordAudioStream that = (HotwordAudioStream) o;
|
||
|
|
//noinspection PointlessBooleanExpression
|
||
|
|
return true
|
||
|
|
&& Objects.equals(mAudioFormat, that.mAudioFormat)
|
||
|
|
&& Objects.equals(mAudioStreamParcelFileDescriptor, that.mAudioStreamParcelFileDescriptor)
|
||
|
|
&& Objects.equals(mTimestamp, that.mTimestamp)
|
||
|
|
&& Objects.equals(mMetadata, that.mMetadata)
|
||
|
|
&& Arrays.equals(mInitialAudio, that.mInitialAudio);
|
||
|
|
}
|
||
|
|
|
||
|
|
@Override
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public int hashCode() {
|
||
|
|
// You can override field hashCode logic by defining methods like:
|
||
|
|
// int fieldNameHashCode() { ... }
|
||
|
|
|
||
|
|
int _hash = 1;
|
||
|
|
_hash = 31 * _hash + Objects.hashCode(mAudioFormat);
|
||
|
|
_hash = 31 * _hash + Objects.hashCode(mAudioStreamParcelFileDescriptor);
|
||
|
|
_hash = 31 * _hash + Objects.hashCode(mTimestamp);
|
||
|
|
_hash = 31 * _hash + Objects.hashCode(mMetadata);
|
||
|
|
_hash = 31 * _hash + Arrays.hashCode(mInitialAudio);
|
||
|
|
return _hash;
|
||
|
|
}
|
||
|
|
|
||
|
|
@Override
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public void writeToParcel(@NonNull Parcel dest, int flags) {
|
||
|
|
// You can override field parcelling by defining methods like:
|
||
|
|
// void parcelFieldName(Parcel dest, int flags) { ... }
|
||
|
|
|
||
|
|
byte flg = 0;
|
||
|
|
if (mTimestamp != null) flg |= 0x4;
|
||
|
|
dest.writeByte(flg);
|
||
|
|
dest.writeTypedObject(mAudioFormat, flags);
|
||
|
|
dest.writeTypedObject(mAudioStreamParcelFileDescriptor, flags);
|
||
|
|
if (mTimestamp != null) dest.writeTypedObject(mTimestamp, flags);
|
||
|
|
dest.writeTypedObject(mMetadata, flags);
|
||
|
|
dest.writeByteArray(mInitialAudio);
|
||
|
|
}
|
||
|
|
|
||
|
|
@Override
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public int describeContents() { return 0; }
|
||
|
|
|
||
|
|
/** @hide */
|
||
|
|
@SuppressWarnings({"unchecked", "RedundantCast"})
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
/* package-private */ HotwordAudioStream(@NonNull Parcel in) {
|
||
|
|
// You can override field unparcelling by defining methods like:
|
||
|
|
// static FieldType unparcelFieldName(Parcel in) { ... }
|
||
|
|
|
||
|
|
byte flg = in.readByte();
|
||
|
|
AudioFormat audioFormat = (AudioFormat) in.readTypedObject(AudioFormat.CREATOR);
|
||
|
|
ParcelFileDescriptor audioStreamParcelFileDescriptor = (ParcelFileDescriptor) in.readTypedObject(ParcelFileDescriptor.CREATOR);
|
||
|
|
AudioTimestamp timestamp = (flg & 0x4) == 0 ? null : (AudioTimestamp) in.readTypedObject(AudioTimestamp.CREATOR);
|
||
|
|
PersistableBundle metadata = (PersistableBundle) in.readTypedObject(PersistableBundle.CREATOR);
|
||
|
|
byte[] initialAudio = in.createByteArray();
|
||
|
|
|
||
|
|
this.mAudioFormat = audioFormat;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mAudioFormat);
|
||
|
|
this.mAudioStreamParcelFileDescriptor = audioStreamParcelFileDescriptor;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mAudioStreamParcelFileDescriptor);
|
||
|
|
this.mTimestamp = timestamp;
|
||
|
|
this.mMetadata = metadata;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mMetadata);
|
||
|
|
this.mInitialAudio = initialAudio;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mInitialAudio);
|
||
|
|
|
||
|
|
// onConstructed(); // You can define this method to get a callback
|
||
|
|
}
|
||
|
|
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public static final @NonNull Parcelable.Creator<HotwordAudioStream> CREATOR
|
||
|
|
= new Parcelable.Creator<HotwordAudioStream>() {
|
||
|
|
@Override
|
||
|
|
public HotwordAudioStream[] newArray(int size) {
|
||
|
|
return new HotwordAudioStream[size];
|
||
|
|
}
|
||
|
|
|
||
|
|
@Override
|
||
|
|
public HotwordAudioStream createFromParcel(@NonNull Parcel in) {
|
||
|
|
return new HotwordAudioStream(in);
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
/**
|
||
|
|
* A builder for {@link HotwordAudioStream}
|
||
|
|
*/
|
||
|
|
@SuppressWarnings("WeakerAccess")
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public static final class Builder extends BaseBuilder {
|
||
|
|
|
||
|
|
private @NonNull AudioFormat mAudioFormat;
|
||
|
|
private @NonNull ParcelFileDescriptor mAudioStreamParcelFileDescriptor;
|
||
|
|
private @Nullable AudioTimestamp mTimestamp;
|
||
|
|
private @NonNull PersistableBundle mMetadata;
|
||
|
|
private @NonNull byte[] mInitialAudio;
|
||
|
|
|
||
|
|
private long mBuilderFieldsSet = 0L;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates a new Builder.
|
||
|
|
*
|
||
|
|
* @param audioFormat
|
||
|
|
* The {@link AudioFormat} of the audio stream.
|
||
|
|
* @param audioStreamParcelFileDescriptor
|
||
|
|
* This stream typically starts with the audio bytes used for hotword detection, but continues
|
||
|
|
* streaming the audio (e.g., with the query) until the stream is shutdown by the
|
||
|
|
* {@link HotwordDetectionService}. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* Alternatively, the {@link HotwordDetectionService} may use {@link #getInitialAudio()}
|
||
|
|
* to pass the start of the audio instead of streaming it here. This may prevent added latency
|
||
|
|
* caused by the streaming buffer (see {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not
|
||
|
|
* being large enough to handle this initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
public Builder(
|
||
|
|
@NonNull AudioFormat audioFormat,
|
||
|
|
@NonNull ParcelFileDescriptor audioStreamParcelFileDescriptor) {
|
||
|
|
mAudioFormat = audioFormat;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mAudioFormat);
|
||
|
|
mAudioStreamParcelFileDescriptor = audioStreamParcelFileDescriptor;
|
||
|
|
com.android.internal.util.AnnotationValidations.validate(
|
||
|
|
NonNull.class, null, mAudioStreamParcelFileDescriptor);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link AudioFormat} of the audio stream.
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull Builder setAudioFormat(@NonNull AudioFormat value) {
|
||
|
|
checkNotUsed();
|
||
|
|
mBuilderFieldsSet |= 0x1;
|
||
|
|
mAudioFormat = value;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This stream typically starts with the audio bytes used for hotword detection, but continues
|
||
|
|
* streaming the audio (e.g., with the query) until the stream is shutdown by the
|
||
|
|
* {@link HotwordDetectionService}. The data format is expected to match
|
||
|
|
* {@link #getAudioFormat()}.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* Alternatively, the {@link HotwordDetectionService} may use {@link #getInitialAudio()}
|
||
|
|
* to pass the start of the audio instead of streaming it here. This may prevent added latency
|
||
|
|
* caused by the streaming buffer (see {@link #KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES}) not
|
||
|
|
* being large enough to handle this initial chunk of audio.
|
||
|
|
* </p>
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull Builder setAudioStreamParcelFileDescriptor(@NonNull ParcelFileDescriptor value) {
|
||
|
|
checkNotUsed();
|
||
|
|
mBuilderFieldsSet |= 0x2;
|
||
|
|
mAudioStreamParcelFileDescriptor = value;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The timestamp when the audio stream was captured by the Audio platform.
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* The {@link HotwordDetectionService} egressing the audio is the owner of the underlying
|
||
|
|
* AudioRecord. The {@link HotwordDetectionService} is expected to optionally populate this
|
||
|
|
* field by {@link AudioRecord#getTimestamp}.
|
||
|
|
* </p>
|
||
|
|
*
|
||
|
|
* <p>
|
||
|
|
* This timestamp can be used in conjunction with the
|
||
|
|
* {@link HotwordDetectedResult#getHotwordOffsetMillis()} and
|
||
|
|
* {@link HotwordDetectedResult#getHotwordDurationMillis()} to translate these durations to
|
||
|
|
* timestamps.
|
||
|
|
* </p>
|
||
|
|
*
|
||
|
|
* @see #getAudioStreamParcelFileDescriptor()
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull Builder setTimestamp(@NonNull AudioTimestamp value) {
|
||
|
|
checkNotUsed();
|
||
|
|
mBuilderFieldsSet |= 0x4;
|
||
|
|
mTimestamp = value;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The metadata associated with the audio stream.
|
||
|
|
*/
|
||
|
|
@DataClass.Generated.Member
|
||
|
|
public @NonNull Builder setMetadata(@NonNull PersistableBundle value) {
|
||
|
|
checkNotUsed();
|
||
|
|
mBuilderFieldsSet |= 0x8;
|
||
|
|
mMetadata = value;
|
||
|
|
return this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Builds the instance. This builder should not be touched after calling this! */
|
||
|
|
public @NonNull HotwordAudioStream build() {
|
||
|
|
checkNotUsed();
|
||
|
|
mBuilderFieldsSet |= 0x20; // Mark builder used
|
||
|
|
|
||
|
|
if ((mBuilderFieldsSet & 0x4) == 0) {
|
||
|
|
mTimestamp = defaultTimestamp();
|
||
|
|
}
|
||
|
|
if ((mBuilderFieldsSet & 0x8) == 0) {
|
||
|
|
mMetadata = defaultMetadata();
|
||
|
|
}
|
||
|
|
if ((mBuilderFieldsSet & 0x10) == 0) {
|
||
|
|
mInitialAudio = defaultInitialAudio();
|
||
|
|
}
|
||
|
|
HotwordAudioStream o = new HotwordAudioStream(
|
||
|
|
mAudioFormat,
|
||
|
|
mAudioStreamParcelFileDescriptor,
|
||
|
|
mTimestamp,
|
||
|
|
mMetadata,
|
||
|
|
mInitialAudio);
|
||
|
|
return o;
|
||
|
|
}
|
||
|
|
|
||
|
|
private void checkNotUsed() {
|
||
|
|
if ((mBuilderFieldsSet & 0x20) != 0) {
|
||
|
|
throw new IllegalStateException(
|
||
|
|
"This Builder should not be reused. Use a new Builder instance instead");
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
@DataClass.Generated(
|
||
|
|
time = 1671232056270L,
|
||
|
|
codegenVersion = "1.0.23",
|
||
|
|
sourceFile = "frameworks/base/core/java/android/service/voice/HotwordAudioStream.java",
|
||
|
|
inputSignatures = "public static final java.lang.String KEY_AUDIO_STREAM_COPY_BUFFER_LENGTH_BYTES\nprivate final @android.annotation.NonNull android.media.AudioFormat mAudioFormat\nprivate final @android.annotation.NonNull android.os.ParcelFileDescriptor mAudioStreamParcelFileDescriptor\nprivate final @android.annotation.Nullable android.media.AudioTimestamp mTimestamp\nprivate final @android.annotation.NonNull android.os.PersistableBundle mMetadata\nprivate final @android.annotation.NonNull byte[] mInitialAudio\nprivate static final byte[] DEFAULT_INITIAL_EMPTY_AUDIO\nprivate static android.media.AudioTimestamp defaultTimestamp()\nprivate static android.os.PersistableBundle defaultMetadata()\nprivate static byte[] defaultInitialAudio()\nprivate java.lang.String initialAudioToString()\npublic android.service.voice.HotwordAudioStream.Builder buildUpon()\nclass HotwordAudioStream extends java.lang.Object implements [android.os.Parcelable]\npublic @android.annotation.NonNull android.service.voice.HotwordAudioStream.Builder setInitialAudio(byte[])\nclass BaseBuilder extends java.lang.Object implements []\n@com.android.internal.util.DataClass(genConstructor=false, genBuilder=true, genEqualsHashCode=true, genParcelable=true, genToString=true)\npublic @android.annotation.NonNull android.service.voice.HotwordAudioStream.Builder setInitialAudio(byte[])\nclass BaseBuilder extends java.lang.Object implements []")
|
||
|
|
@Deprecated
|
||
|
|
private void __metadata() {}
|
||
|
|
|
||
|
|
|
||
|
|
//@formatter:on
|
||
|
|
// End of generated code
|
||
|
|
|
||
|
|
}
|