Rename rtvi-client-android to pipecat-client-android

.github/workflows/ci.yaml

@@ -37,13 +37,13 @@ jobs:
           java-version: '17'
 
       - name: Build core SDK
-        run: ./gradlew :rtvi-client-android:assembleRelease
+        run: ./gradlew :pipecat-client-android:assembleRelease
 
       - name: Generate Maven repo
-        run: ./gradlew :rtvi-client-android:publishAllPublicationsToRTVILocalRepoRepository
+        run: ./gradlew :pipecat-client-android:publishAllPublicationsToPipecatLocalRepoRepository
 
       - name: Upload Maven repo
         uses: actions/upload-artifact@v4
         with:
-          name: RTVIClientAndroid-Repo
-          path: build/RTVILocalRepo
+          name: PipecatClientAndroid-Repo
+          path: build/PipecatLocalRepo

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.3.0
+
+- Project renamed to `pipecat-client-android`
+- `RTVIClient` renamed to `PipecatClient`
+
 # 0.2.1
 
 - Added callbacks:
@@ -30,4 +35,4 @@
 - Added callbacks
   - `onBotLLMText()`
   - `onBotTTSText()`
-  - `onStorageItemStored()`
+  - `onStorageItemStored()`

README.md

@@ -1,25 +1,25 @@
-# Real-Time Voice Inference Android Client SDK
+# Pipecat Android Client SDK
 
 [RTVI](https://github.com/rtvi-ai/) is an open standard for Real-Time Voice (and Video) Inference.
 
 This Android library contains the core components and types needed to set up an RTVI session.
 
 When building an RTVI application, you should use the transport-specific client library (see
 [here](https://rtvi.mintlify.app/api-reference/transports/introduction) for available first-party
-packages.) The base `VoiceClient` has no transport included.
+packages.) The base `PipecatClient` has no transport included.
 
 ## Usage
 
 Add the following dependency to your `build.gradle` file:
 
 ```
-implementation "ai.rtvi:client:0.2.1"
+implementation "ai.pipecat:client:0.3.0"
 ```
 
-Then instantiate the `VoiceClient` from your code, specifying the backend `baseUrl` and transport.
+Then instantiate the `PipecatClient` from your code, specifying the backend `baseUrl` and transport.
 
 ```kotlin
-val callbacks = object : VoiceEventCallbacks() {
+val callbacks = object : RTVIEventCallbacks() {
 
     override fun onBackendError(message: String) {
         Log.e(TAG, "Error from backend: $message")
@@ -28,7 +28,7 @@ val callbacks = object : VoiceEventCallbacks() {
     // ...
 }
 
-val client = VoiceClient(baseUrl, transport, callbacks)
+val client = PipecatClient(transport, callbacks, options)
 
 client.start().withCallback {
     // ...

rtvi-client-android/build.gradle.kts → pipecat-client-android/build.gradle.kts

@@ -8,7 +8,7 @@ plugins {
 }
 
 android {
-    namespace = "ai.rtvi.client"
+    namespace = "ai.pipecat.client"
     compileSdk = 34
 
     defaultConfig {
@@ -51,40 +51,40 @@ dependencies {
 publishing {
     repositories {
         maven {
-            url = rootProject.layout.buildDirectory.dir("RTVILocalRepo").get().asFile.toURI()
-            name = "RTVILocalRepo"
+            url = rootProject.layout.buildDirectory.dir("PipecatLocalRepo").get().asFile.toURI()
+            name = "PipecatLocalRepo"
         }
     }
 
     publications {
         register<MavenPublication>("release") {
-            groupId = "ai.rtvi"
+            groupId = "ai.pipecat"
             artifactId = "client"
-            version = "0.2.1"
+            version = "0.3.0"
 
             pom {
-                name.set("RTVI Client")
-                description.set("Core RTVI client library for Android")
-                url.set("https://github.com/rtvi-ai/rtvi-client-android")
+                name.set("Pipecat Client")
+                description.set("Core Pipecat client library for Android")
+                url.set("https://github.com/pipecat-ai/pipecat-client-android")
 
                 developers {
                     developer {
-                        id.set("rtvi.ai")
-                        name.set("rtvi.ai")
+                        id.set("pipecat.ai")
+                        name.set("pipecat.ai")
                     }
                 }
 
                 licenses {
                     license {
                         name.set("BSD 2-Clause License")
-                        url.set("https://github.com/rtvi-ai/rtvi-client-android/blob/main/LICENSE")
+                        url.set("https://github.com/pipecat-ai/pipecat-client-android/blob/main/LICENSE")
                     }
                 }
 
                 scm {
-                    connection.set("scm:git:git://github.com/rtvi-ai/rtvi-client-android.git")
-                    developerConnection.set("scm:git:ssh://github.com:rtvi-ai/rtvi-client-android.git")
-                    url.set("https://github.com/rtvi-ai/rtvi-client-android")
+                    connection.set("scm:git:git://github.com/pipecat-ai/pipecat-client-android.git")
+                    developerConnection.set("scm:git:ssh://github.com:pipecat-ai/pipecat-client-android.git")
+                    url.set("https://github.com/pipecat-ai/pipecat-client-android")
                 }
             }
 
@@ -103,4 +103,4 @@ signing {
         useInMemoryPgpKeys(signingKey, signingPassphrase)
         sign(publishing.publications)
     }
-}
+}

rtvi-client-android/src/main/java/ai/rtvi/client/RTVIClient.kt → pipecat-client-android/src/main/java/ai/pipecat/client/PipecatClient.kt

@@ -1,37 +1,37 @@
-package ai.rtvi.client
-
-import ai.rtvi.client.helper.RTVIClientHelper
-import ai.rtvi.client.helper.RegisteredRTVIClient
-import ai.rtvi.client.result.Future
-import ai.rtvi.client.result.Promise
-import ai.rtvi.client.result.RTVIError
-import ai.rtvi.client.result.RTVIException
-import ai.rtvi.client.result.Result
-import ai.rtvi.client.result.resolvedPromiseErr
-import ai.rtvi.client.result.withPromise
-import ai.rtvi.client.result.withTimeout
-import ai.rtvi.client.transport.AuthBundle
-import ai.rtvi.client.transport.MsgClientToServer
-import ai.rtvi.client.transport.MsgServerToClient
-import ai.rtvi.client.transport.Transport
-import ai.rtvi.client.transport.TransportContext
-import ai.rtvi.client.transport.TransportFactory
-import ai.rtvi.client.types.ActionDescription
-import ai.rtvi.client.types.Config
-import ai.rtvi.client.types.MediaDeviceId
-import ai.rtvi.client.types.Option
-import ai.rtvi.client.types.RegisteredHelper
-import ai.rtvi.client.types.ServiceConfig
-import ai.rtvi.client.types.ServiceConfigDescription
-import ai.rtvi.client.types.Transcript
-import ai.rtvi.client.types.TransportState
-import ai.rtvi.client.types.Value
-import ai.rtvi.client.utils.ConnectionBundle
-import ai.rtvi.client.utils.JSON_INSTANCE
-import ai.rtvi.client.utils.ThreadRef
-import ai.rtvi.client.utils.parseServerSentEvents
-import ai.rtvi.client.utils.post
-import ai.rtvi.client.utils.valueFrom
+package ai.pipecat.client
+
+import ai.pipecat.client.helper.RTVIClientHelper
+import ai.pipecat.client.helper.RegisteredPipecatClient
+import ai.pipecat.client.result.Future
+import ai.pipecat.client.result.Promise
+import ai.pipecat.client.result.RTVIError
+import ai.pipecat.client.result.RTVIException
+import ai.pipecat.client.result.Result
+import ai.pipecat.client.result.resolvedPromiseErr
+import ai.pipecat.client.result.withPromise
+import ai.pipecat.client.result.withTimeout
+import ai.pipecat.client.transport.AuthBundle
+import ai.pipecat.client.transport.MsgClientToServer
+import ai.pipecat.client.transport.MsgServerToClient
+import ai.pipecat.client.transport.Transport
+import ai.pipecat.client.transport.TransportContext
+import ai.pipecat.client.transport.TransportFactory
+import ai.pipecat.client.types.ActionDescription
+import ai.pipecat.client.types.Config
+import ai.pipecat.client.types.MediaDeviceId
+import ai.pipecat.client.types.Option
+import ai.pipecat.client.types.RegisteredHelper
+import ai.pipecat.client.types.ServiceConfig
+import ai.pipecat.client.types.ServiceConfigDescription
+import ai.pipecat.client.types.Transcript
+import ai.pipecat.client.types.TransportState
+import ai.pipecat.client.types.Value
+import ai.pipecat.client.utils.ConnectionBundle
+import ai.pipecat.client.utils.JSON_INSTANCE
+import ai.pipecat.client.utils.ThreadRef
+import ai.pipecat.client.utils.parseServerSentEvents
+import ai.pipecat.client.utils.post
+import ai.pipecat.client.utils.valueFrom
 import android.util.Log
 import kotlinx.serialization.json.JsonElement
 import kotlinx.serialization.json.JsonPrimitive
@@ -40,7 +40,7 @@ import kotlinx.serialization.json.jsonObject
 import okhttp3.MediaType.Companion.toMediaType
 import okhttp3.RequestBody.Companion.toRequestBody
 
-private const val RTVI_PROTOCOL_VERSION = "0.2.0"
+private const val RTVI_PROTOCOL_VERSION = "0.3.0"
 
 /**
  * An RTVI client. Connects to an RTVI backend and handles bidirectional audio and video
@@ -53,7 +53,7 @@ private const val RTVI_PROTOCOL_VERSION = "0.2.0"
  * @param options Additional options for configuring the client and backend.
  */
 @Suppress("unused")
-open class RTVIClient(
+open class PipecatClient(
     transport: TransportFactory,
     callbacks: RTVIEventCallbacks,
     private var options: RTVIClientOptions,
@@ -101,12 +101,12 @@ open class RTVIClient(
     private val transportCtx = object : TransportContext {
 
         override val options
-            get() = this@RTVIClient.options
+            get() = this@PipecatClient.options
 
         override val callbacks
-            get() = this@RTVIClient.callbacks
+            get() = this@PipecatClient.callbacks
 
-        override val thread = this@RTVIClient.thread
+        override val thread = this@PipecatClient.thread
 
         override fun onMessage(msg: MsgServerToClient) = thread.runOnThread {
 
@@ -117,7 +117,7 @@ open class RTVIClient(
                         val data =
                             JSON_INSTANCE.decodeFromJsonElement<MsgServerToClient.Data.BotReady>(msg.data)
 
-                        this@RTVIClient.transport.setState(TransportState.Ready)
+                        this@PipecatClient.transport.setState(TransportState.Ready)
 
                         connection?.ready?.resolveOk(Unit)
 
@@ -345,7 +345,7 @@ open class RTVIClient(
             throw RTVIException(RTVIError.OtherError("Helper targeting service '$service' already registered"))
         }
 
-        helper.registerVoiceClient(RegisteredRTVIClient(this, service))
+        helper.registerVoiceClient(RegisteredPipecatClient(this, service))
 
         val entry = RegisteredHelper(
             helper = helper,

rtvi-client-android/src/main/java/ai/rtvi/client/RTVIClientOptions.kt → pipecat-client-android/src/main/java/ai/pipecat/client/RTVIClientOptions.kt

@@ -1,8 +1,8 @@
-package ai.rtvi.client
+package ai.pipecat.client
 
-import ai.rtvi.client.types.ServiceConfig
-import ai.rtvi.client.types.ServiceRegistration
-import ai.rtvi.client.types.Value
+import ai.pipecat.client.types.ServiceConfig
+import ai.pipecat.client.types.ServiceRegistration
+import ai.pipecat.client.types.Value
 
 /**
  * Configuration options when instantiating a [RTVIClient].

rtvi-client-android/src/main/java/ai/rtvi/client/RTVIClientParams.kt → pipecat-client-android/src/main/java/ai/pipecat/client/RTVIClientParams.kt

@@ -1,8 +1,8 @@
-package ai.rtvi.client
+package ai.pipecat.client
 
-import ai.rtvi.client.types.RTVIURLEndpoints
-import ai.rtvi.client.types.ServiceConfig
-import ai.rtvi.client.types.Value
+import ai.pipecat.client.types.RTVIURLEndpoints
+import ai.pipecat.client.types.ServiceConfig
+import ai.pipecat.client.types.Value
 
 /**
  * Connection options when instantiating a [RTVIClient].

rtvi-client-android/src/main/java/ai/rtvi/client/RTVIEventCallbacks.kt → pipecat-client-android/src/main/java/ai/pipecat/client/RTVIEventCallbacks.kt

@@ -1,13 +1,13 @@
-package ai.rtvi.client
-
-import ai.rtvi.client.transport.MsgServerToClient
-import ai.rtvi.client.types.MediaDeviceInfo
-import ai.rtvi.client.types.Participant
-import ai.rtvi.client.types.PipecatMetrics
-import ai.rtvi.client.types.ServiceConfig
-import ai.rtvi.client.types.Tracks
-import ai.rtvi.client.types.Transcript
-import ai.rtvi.client.types.TransportState
+package ai.pipecat.client
+
+import ai.pipecat.client.transport.MsgServerToClient
+import ai.pipecat.client.types.MediaDeviceInfo
+import ai.pipecat.client.types.Participant
+import ai.pipecat.client.types.PipecatMetrics
+import ai.pipecat.client.types.ServiceConfig
+import ai.pipecat.client.types.Tracks
+import ai.pipecat.client.types.Transcript
+import ai.pipecat.client.types.TransportState
 
 /**
  * Callbacks invoked when changes occur in the RTVI session.

rtvi-client-android/src/main/java/ai/rtvi/client/helper/LLMHelper.kt → pipecat-client-android/src/main/java/ai/pipecat/client/helper/LLMHelper.kt

@@ -1,14 +1,14 @@
-package ai.rtvi.client.helper
-
-import ai.rtvi.client.result.Future
-import ai.rtvi.client.result.RTVIError
-import ai.rtvi.client.result.resolvedPromiseErr
-import ai.rtvi.client.transport.MsgClientToServer
-import ai.rtvi.client.transport.MsgServerToClient
-import ai.rtvi.client.types.Option
-import ai.rtvi.client.types.TransportState
-import ai.rtvi.client.types.Value
-import ai.rtvi.client.utils.JSON_INSTANCE
+package ai.pipecat.client.helper
+
+import ai.pipecat.client.result.Future
+import ai.pipecat.client.result.RTVIError
+import ai.pipecat.client.result.resolvedPromiseErr
+import ai.pipecat.client.transport.MsgClientToServer
+import ai.pipecat.client.transport.MsgServerToClient
+import ai.pipecat.client.types.Option
+import ai.pipecat.client.types.TransportState
+import ai.pipecat.client.types.Value
+import ai.pipecat.client.utils.JSON_INSTANCE
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.JsonArray
@@ -205,7 +205,7 @@ private fun Value.asJsonElement(): JsonElement = when (this) {
     Value.Null -> JsonNull
 }
 
-private fun <V> RegisteredRTVIClient.ensureReady(action: () -> Future<V, RTVIError>): Future<V, RTVIError> =
+private fun <V> RegisteredPipecatClient.ensureReady(action: () -> Future<V, RTVIError>): Future<V, RTVIError> =
     if (client.state == TransportState.Ready) {
         action()
     } else {

rtvi-client-android/src/main/java/ai/rtvi/client/helper/Legacy.kt → pipecat-client-android/src/main/java/ai/pipecat/client/helper/Legacy.kt

@@ -1,7 +1,7 @@
-package ai.rtvi.client.helper
+package ai.pipecat.client.helper
 
 @Deprecated("VoiceClientHelper renamed to RTVIClientHelper")
 typealias VoiceClientHelper = RTVIClientHelper
 
 @Deprecated("RegisteredVoiceClient renamed to RegisteredRTVIClient")
-typealias RegisteredVoiceClient = RegisteredRTVIClient
+typealias RegisteredVoiceClient = RegisteredPipecatClient