Hotword: Add HotwordAudioStream list in HotwordDetectedResult (63935a3f) · Commits · e / os / android_frameworks_base

core/api/system-current.txt

+21 −0

Original line number	Diff line number	Diff line
		@@ -11982,9 +11982,29 @@ package android.service.voice {
		method public int getStart();
		}

		public final class HotwordAudioStream implements android.os.Parcelable {
		method public int describeContents();
		method @NonNull public android.media.AudioFormat getAudioFormat();
		method @NonNull public android.os.ParcelFileDescriptor getAudioStream();
		method @NonNull public android.os.PersistableBundle getMetadata();
		method @Nullable public android.media.AudioTimestamp getTimestamp();
		method public void writeToParcel(@NonNull android.os.Parcel, int);
		field @NonNull public static final android.os.Parcelable.Creator<android.service.voice.HotwordAudioStream> CREATOR;
		}

		public static final class HotwordAudioStream.Builder {
		ctor public HotwordAudioStream.Builder(@NonNull android.media.AudioFormat, @NonNull android.os.ParcelFileDescriptor);
		method @NonNull public android.service.voice.HotwordAudioStream build();
		method @NonNull public android.service.voice.HotwordAudioStream.Builder setAudioFormat(@NonNull android.media.AudioFormat);
		method @NonNull public android.service.voice.HotwordAudioStream.Builder setAudioStream(@NonNull android.os.ParcelFileDescriptor);
		method @NonNull public android.service.voice.HotwordAudioStream.Builder setMetadata(@NonNull android.os.PersistableBundle);
		method @NonNull public android.service.voice.HotwordAudioStream.Builder setTimestamp(@NonNull android.media.AudioTimestamp);
		}

		public final class HotwordDetectedResult implements android.os.Parcelable {
		method public int describeContents();
		method public int getAudioChannel();
		method @NonNull public java.util.List<android.service.voice.HotwordAudioStream> getAudioStreams();
		method public int getConfidenceLevel();
		method @NonNull public android.os.PersistableBundle getExtras();
		method public int getHotwordDurationMillis();
		@@ -12014,6 +12034,7 @@ package android.service.voice {
		ctor public HotwordDetectedResult.Builder();
		method @NonNull public android.service.voice.HotwordDetectedResult build();
		method @NonNull public android.service.voice.HotwordDetectedResult.Builder setAudioChannel(int);
		method @NonNull public android.service.voice.HotwordDetectedResult.Builder setAudioStreams(@NonNull java.util.List<android.service.voice.HotwordAudioStream>);
		method @NonNull public android.service.voice.HotwordDetectedResult.Builder setConfidenceLevel(int);
		method @NonNull public android.service.voice.HotwordDetectedResult.Builder setExtras(@NonNull android.os.PersistableBundle);
		method @NonNull public android.service.voice.HotwordDetectedResult.Builder setHotwordDetectionPersonalized(boolean);

core/java/android/service/voice/HotwordAudioStream.aidl

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		/*
		* 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;

		parcelable HotwordAudioStream;

core/java/android/service/voice/HotwordAudioStream.java

0 → 100644

+447 −0

Original line number	Diff line number	Diff line
		/*
		* 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.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 {

		/**
		* The {@link AudioFormat} of the audio stream.
		*/
		@NonNull
		private final AudioFormat mAudioFormat;

		/**
		* This stream starts with the audio bytes used for hotword detection, but continues streaming
		* the audio until the stream is shutdown by the {@link HotwordDetectionService}.
		*/
		@NonNull
		private final ParcelFileDescriptor mAudioStream;

		/**
		* The timestamp when the {@link #getAudioStream()} 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>
		*/
		@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();
		}

		private String timestampToString() {
		if (mTimestamp == null) {
		return "";
		}
		return "TimeStamp:"
		+ " framePos=" + mTimestamp.framePosition
		+ " nanoTime=" + mTimestamp.nanoTime;
		}

		private void parcelTimestamp(Parcel dest, int flags) {
		if (mTimestamp != null) {
		// mTimestamp is not null, we write it to the parcel, set true.
		dest.writeBoolean(true);
		dest.writeLong(mTimestamp.framePosition);
		dest.writeLong(mTimestamp.nanoTime);
		} else {
		// mTimestamp is null, we don't write any value out, set false.
		dest.writeBoolean(false);
		}
		}

		@Nullable
		private static AudioTimestamp unparcelTimestamp(Parcel in) {
		// If it is true, it means we wrote the value to the parcel before, parse it.
		// Otherwise, return null.
		if (in.readBoolean()) {
		final AudioTimestamp timeStamp = new AudioTimestamp();
		timeStamp.framePosition = in.readLong();
		timeStamp.nanoTime = in.readLong();
		return timeStamp;
		} else {
		return null;
		}
		}



		// 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 audioStream,
		@Nullable AudioTimestamp timestamp,
		@NonNull PersistableBundle metadata) {
		this.mAudioFormat = audioFormat;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mAudioFormat);
		this.mAudioStream = audioStream;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mAudioStream);
		this.mTimestamp = timestamp;
		this.mMetadata = metadata;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mMetadata);

		// 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 starts with the audio bytes used for hotword detection, but continues streaming
		* the audio until the stream is shutdown by the {@link HotwordDetectionService}.
		*/
		@DataClass.Generated.Member
		public @NonNull ParcelFileDescriptor getAudioStream() {
		return mAudioStream;
		}

		/**
		* The timestamp when the {@link #getAudioStream()} 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>
		*/
		@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;
		}

		@Override
		@DataClass.Generated.Member
		public String toString() {
		// You can override field toString logic by defining methods like:
		// String fieldNameToString() { ... }

		return "HotwordAudioStream { " +
		"audioFormat = " + mAudioFormat + ", " +
		"audioStream = " + mAudioStream + ", " +
		"timestamp = " + timestampToString() + ", " +
		"metadata = " + mMetadata +
		" }";
		}

		@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(mAudioStream, that.mAudioStream)
		&& Objects.equals(mTimestamp, that.mTimestamp)
		&& Objects.equals(mMetadata, that.mMetadata);
		}

		@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(mAudioStream);
		_hash = 31 * _hash + Objects.hashCode(mTimestamp);
		_hash = 31 * _hash + Objects.hashCode(mMetadata);
		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(mAudioStream, flags);
		parcelTimestamp(dest, flags);
		dest.writeTypedObject(mMetadata, flags);
		}

		@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 audioStream = (ParcelFileDescriptor) in.readTypedObject(ParcelFileDescriptor.CREATOR);
		AudioTimestamp timestamp = unparcelTimestamp(in);
		PersistableBundle metadata = (PersistableBundle) in.readTypedObject(PersistableBundle.CREATOR);

		this.mAudioFormat = audioFormat;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mAudioFormat);
		this.mAudioStream = audioStream;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mAudioStream);
		this.mTimestamp = timestamp;
		this.mMetadata = metadata;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mMetadata);

		// 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 {

		private @NonNull AudioFormat mAudioFormat;
		private @NonNull ParcelFileDescriptor mAudioStream;
		private @Nullable AudioTimestamp mTimestamp;
		private @NonNull PersistableBundle mMetadata;

		private long mBuilderFieldsSet = 0L;

		/**
		* Creates a new Builder.
		*
		* @param audioFormat
		* The {@link AudioFormat} of the audio stream.
		* @param audioStream
		* This stream starts with the audio bytes used for hotword detection, but continues streaming
		* the audio until the stream is shutdown by the {@link HotwordDetectionService}.
		*/
		public Builder(
		@NonNull AudioFormat audioFormat,
		@NonNull ParcelFileDescriptor audioStream) {
		mAudioFormat = audioFormat;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mAudioFormat);
		mAudioStream = audioStream;
		com.android.internal.util.AnnotationValidations.validate(
		NonNull.class, null, mAudioStream);
		}

		/**
		* 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 starts with the audio bytes used for hotword detection, but continues streaming
		* the audio until the stream is shutdown by the {@link HotwordDetectionService}.
		*/
		@DataClass.Generated.Member
		public @NonNull Builder setAudioStream(@NonNull ParcelFileDescriptor value) {
		checkNotUsed();
		mBuilderFieldsSet \|= 0x2;
		mAudioStream = value;
		return this;
		}

		/**
		* The timestamp when the {@link #getAudioStream()} 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>
		*/
		@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 \|= 0x10; // Mark builder used

		if ((mBuilderFieldsSet & 0x4) == 0) {
		mTimestamp = defaultTimestamp();
		}
		if ((mBuilderFieldsSet & 0x8) == 0) {
		mMetadata = defaultMetadata();
		}
		HotwordAudioStream o = new HotwordAudioStream(
		mAudioFormat,
		mAudioStream,
		mTimestamp,
		mMetadata);
		return o;
		}

		private void checkNotUsed() {
		if ((mBuilderFieldsSet & 0x10) != 0) {
		throw new IllegalStateException(
		"This Builder should not be reused. Use a new Builder instance instead");
		}
		}
		}

		@DataClass.Generated(
		time = 1665463434564L,
		codegenVersion = "1.0.23",
		sourceFile = "frameworks/base/core/java/android/service/voice/HotwordAudioStream.java",
		inputSignatures = "private final @android.annotation.NonNull android.media.AudioFormat mAudioFormat\nprivate final @android.annotation.NonNull android.os.ParcelFileDescriptor mAudioStream\nprivate final @android.annotation.Nullable android.media.AudioTimestamp mTimestamp\nprivate final @android.annotation.NonNull android.os.PersistableBundle mMetadata\nprivate static android.media.AudioTimestamp defaultTimestamp()\nprivate static android.os.PersistableBundle defaultMetadata()\nprivate java.lang.String timestampToString()\nprivate void parcelTimestamp(android.os.Parcel,int)\nprivate static @android.annotation.Nullable android.media.AudioTimestamp unparcelTimestamp(android.os.Parcel)\nclass HotwordAudioStream extends java.lang.Object implements [android.os.Parcelable]\n@com.android.internal.util.DataClass(genConstructor=false, genBuilder=true, genEqualsHashCode=true, genParcelable=true, genToString=true)")
		@Deprecated
		private void __metadata() {}


		//@formatter:on
		// End of generated code

		}

core/java/android/service/voice/HotwordDetectedResult.java

+59 −6

File changed.

Preview size limit exceeded, changes collapsed.