use voice instead of voices

Author: VinayGuthal

firebase-ai/CHANGELOG.md

@@ -2,8 +2,11 @@
 
 * [fixed] Fixed `FirebaseAI.getInstance` StackOverflowException (#6971)
 * [fixed] Fixed an issue that was causing the SDK to send empty `FunctionDeclaration` descriptions to the API.
-* [changed] **Breaking Change**: Updated `Voices` to accept a voice name as an attribute
+* [changed] Introduced the `Voice` class, which accepts a voice name, and deprecated the `Voices` class.
+* [changed] **Breaking Change**: Updated `SpeechConfig` to take in `Voice` class instead of `Voices` class.
+    * **Action Required:** Update all references of `SpeechConfig` initialization to use `Voice` class.
 
+ 
 # 16.0.0
 * [feature] Initial release of the Firebase AI SDK (`firebase-ai`). This SDK *replaces* the previous
  Vertex AI in Firebase SDK (`firebase-vertexai`) to accommodate the evolving set of supported

firebase-ai/api.txt

@@ -863,9 +863,9 @@ package com.google.firebase.ai.type {
   }
 
   @com.google.firebase.ai.type.PublicPreviewAPI public final class SpeechConfig {
-    ctor public SpeechConfig(com.google.firebase.ai.type.Voices voice);
-    method public com.google.firebase.ai.type.Voices getVoice();
-    property public final com.google.firebase.ai.type.Voices voice;
+    ctor public SpeechConfig(com.google.firebase.ai.type.Voice voice);
+    method public com.google.firebase.ai.type.Voice getVoice();
+    property public final com.google.firebase.ai.type.Voice voice;
   }
 
   public abstract class StringFormat {
@@ -914,20 +914,25 @@ package com.google.firebase.ai.type {
     property public final int totalTokenCount;
   }
 
-  @com.google.firebase.ai.type.PublicPreviewAPI public final class Voices {
-    ctor public Voices(String voiceName);
+  @com.google.firebase.ai.type.PublicPreviewAPI public final class Voice {
+    ctor public Voice(String voiceName);
     method public String getVoiceName();
     property public final String voiceName;
-    field public static final com.google.firebase.ai.type.Voices AOEDE;
-    field public static final com.google.firebase.ai.type.Voices CHARON;
-    field public static final com.google.firebase.ai.type.Voices.Companion Companion;
-    field public static final com.google.firebase.ai.type.Voices FENRIR;
-    field public static final com.google.firebase.ai.type.Voices KORE;
-    field public static final com.google.firebase.ai.type.Voices PUCK;
-    field public static final com.google.firebase.ai.type.Voices UNSPECIFIED;
   }
 
-  public static final class Voices.Companion {
+  @Deprecated @com.google.firebase.ai.type.PublicPreviewAPI public final class Voices {
+    method @Deprecated public int getOrdinal();
+    property @Deprecated public final int ordinal;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices AOEDE;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices CHARON;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices.Companion Companion;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices FENRIR;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices KORE;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices PUCK;
+    field @Deprecated public static final com.google.firebase.ai.type.Voices UNSPECIFIED;
+  }
+
+  @Deprecated public static final class Voices.Companion {
   }
 
 }

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/SpeechConfig.kt

@@ -23,14 +23,14 @@ import kotlinx.serialization.Serializable
 @PublicPreviewAPI
 public class SpeechConfig(
   /** The voice to be used for the server's speech response. */
-  public val voice: Voices
+  public val voice: Voice
 ) {
 
   @Serializable
   internal data class Internal(@SerialName("voice_config") val voiceConfig: VoiceConfigInternal) {
     @Serializable
     internal data class VoiceConfigInternal(
-      @SerialName("prebuilt_voice_config") val prebuiltVoiceConfig: Voices.Internal,
+      @SerialName("prebuilt_voice_config") val prebuiltVoiceConfig: Voice.Internal,
     )
   }
 

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Voice.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * 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 com.google.firebase.ai.type
+
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+/**
+ * Various voices supported by the server. The list of all voices can be found
+ * [here](https://cloud.google.com/text-to-speech/docs/chirp3-hd)
+ */
+@PublicPreviewAPI
+public class Voice public constructor(public val voiceName: String) {
+
+  @Serializable internal data class Internal(@SerialName("voice_name") val voiceName: String)
+
+  internal fun toInternal(): Internal {
+    return Internal(this.voiceName)
+  }
+}

firebase-ai/src/main/kotlin/com/google/firebase/ai/type/Voices.kt

@@ -19,17 +19,38 @@ package com.google.firebase.ai.type
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 
-/**
- * Various voices supported by the server. The list of all voices can be found
- * [here](https://cloud.google.com/text-to-speech/docs/chirp3-hd)
- */
+/** Various voices supported by the server */
+@Deprecated("Please use the Voice class instead.")
 @PublicPreviewAPI
-public class Voices public constructor(public val voiceName: String) {
+public class Voices private constructor(public val ordinal: Int) {
 
   @Serializable internal data class Internal(@SerialName("voice_name") val voiceName: String)
 
+  @Serializable
+  internal enum class InternalEnum {
+    CHARON,
+    AOEDE,
+    FENRIR,
+    KORE,
+    PUCK;
+    internal fun toPublic() =
+      when (this) {
+        CHARON -> Voices.CHARON
+        AOEDE -> Voices.AOEDE
+        FENRIR -> Voices.FENRIR
+        KORE -> Voices.KORE
+        else -> Voices.PUCK
+      }
+  }
+
   internal fun toInternal(): Internal {
-    return Internal(this.voiceName)
+    return when (this) {
+      CHARON -> Internal(InternalEnum.CHARON.name)
+      AOEDE -> Internal(InternalEnum.AOEDE.name)
+      FENRIR -> Internal(InternalEnum.FENRIR.name)
+      KORE -> Internal(InternalEnum.KORE.name)
+      else -> Internal(InternalEnum.PUCK.name)
+    }
   }
 
   public companion object {
@@ -38,21 +59,21 @@ public class Voices public constructor(public val voiceName: String) {
      *
      * Will use the default voice of the model.
      */
-    @JvmField public val UNSPECIFIED: Voices = Voices("Puck")
+    @JvmField public val UNSPECIFIED: Voices = Voices(0)
 
     /** Represents the Charon voice. */
-    @JvmField public val CHARON: Voices = Voices("Charon")
+    @JvmField public val CHARON: Voices = Voices(1)
 
     /** Represents the Aoede voice. */
-    @JvmField public val AOEDE: Voices = Voices("Aoede")
+    @JvmField public val AOEDE: Voices = Voices(2)
 
     /** Represents the Fenrir voice. */
-    @JvmField public val FENRIR: Voices = Voices("Fenrir")
+    @JvmField public val FENRIR: Voices = Voices(3)
 
     /** Represents the Kore voice. */
-    @JvmField public val KORE: Voices = Voices("Kore")
+    @JvmField public val KORE: Voices = Voices(4)
 
     /** Represents the Puck voice. */
-    @JvmField public val PUCK: Voices = Voices("Puck")
+    @JvmField public val PUCK: Voices = Voices(5)
   }
 }