tirtc-react-native 2.2.0

package/LICENSE

@@ -0,0 +1,11 @@
+BSD 3-Clause License
+
+Copyright (c) 2024 Tange AI
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+3. Neither the name of Tange AI nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,140 @@
+# TiRTC React Native SDK
+
+`tirtc-react-native` is the TiRTC React Native New Architecture package for Android and iOS.
+
+```sh
+npm install tirtc-react-native
+```
+
+The package ships ESM JavaScript, TypeScript declarations, Codegen specs, Android native wrapper code and iOS native wrapper code. It requires React Native `>=0.80.0`, Android `com.tange.ai:tirtc:2.2.9`, and iOS `TiRTC` `2.2.9` with iOS minimum `15.1`.
+
+Version `2.2.0` is a stable React Native release focused on client media output, client voice talkback and client video uplink primitives.
+
+## Imports
+
+```ts
+import {
+  TiRtc,
+  TiRtcConn,
+  TiRtcAudioInput,
+  TiRtcVideoInput,
+  TiRtcAudioOutput,
+  TiRtcVideoOutput,
+  TiRtcVideoOutputView,
+  TiRtcVideoInputPreview,
+  TiRtcAudioCodec,
+  TiRtcVideoCodec,
+} from 'tirtc-react-native';
+
+import * as TiRtc from 'tirtc-react-native';
+```
+
+The root export is the public API. Deep imports are not supported.
+
+## Semantic Values
+
+String values are exported as stable `as const` objects and matching TypeScript union types:
+
+`TiRtcOutputBufferStrategy`, `TiRtcConnState`, `TiRtcInputState`, `TiRtcAudioCodec`, `TiRtcAudioSampleRate`, `TiRtcAudioChannelCount`, `TiRtcAudioAecMode`, `TiRtcAudioAgcLevel`, `TiRtcAudioAnsLevel`, `TiRtcVideoCodec`, `TiRtcVideoEncoderCodec`, `TiRtcVideoFrameRate`, `TiRtcCameraFacing`, `TiRtcVideoDecoderPreference`, `TiRtcVideoDecoderBackend`, `TiRtcVideoBitstreamFormat`, `TiRtcAudioOutputState`, `TiRtcVideoOutputState`.
+
+Use the exported values instead of hard-coded strings in app code.
+
+## Permissions
+
+Applications own runtime permissions and platform entitlement setup before starting capture or output:
+
+- Android: camera, microphone, network and foreground execution policy required by the host app.
+- iOS: camera and microphone usage descriptions, user permission prompts and background behavior required by the host app.
+
+The SDK reports platform failures through numeric TiRTC return codes and callbacks; it does not request permissions on the app's behalf.
+
+## Minimal Client
+
+```tsx
+import React from 'react';
+import {TiRtc, TiRtcConn, TiRtcVideoOutput, TiRtcVideoOutputView} from 'tirtc-react-native';
+
+await TiRtc.initialize({appId, endpoint});
+
+const conn = new TiRtcConn();
+const videoOutput = new TiRtcVideoOutput();
+videoOutput.attach(conn, streamId);
+
+conn.onStateChanged = (state, errorCode) => {
+  if (errorCode !== 0) {
+    console.warn(TiRtc.formatError(errorCode));
+  }
+};
+
+conn.connect(remoteDeviceId, token);
+
+export function RemoteVideo() {
+  return <TiRtcVideoOutputView output={videoOutput} resizeMode="contain" />;
+}
+```
+
+Dispose in reverse ownership order:
+
+```ts
+videoOutput.detach();
+videoOutput.dispose();
+conn.disconnect();
+conn.dispose();
+TiRtc.shutdown();
+```
+
+## Client Voice Talkback
+
+```tsx
+import {TiRtcAudioCodec, TiRtcAudioInput} from 'tirtc-react-native';
+
+const audioInput = new TiRtcAudioInput();
+
+await audioInput.setOptions({
+  codec: TiRtcAudioCodec.g711a,
+});
+await audioInput.attach(conn, talkbackStreamId);
+await audioInput.start();
+
+await audioInput.stop();
+await audioInput.detach(conn);
+await audioInput.dispose();
+```
+
+## Client Video Uplink Primitives
+
+`TiRtcVideoInput`, `TiRtcVideoInputPreview` and the video input option values are exported for client-side video uplink integration.
+
+```tsx
+import {TiRtcVideoInput, TiRtcVideoInputPreview} from 'tirtc-react-native';
+
+const videoInput = new TiRtcVideoInput();
+
+export function LocalPreview() {
+  return <TiRtcVideoInputPreview input={videoInput} resizeMode="contain" />;
+}
+```
+
+## Errors And Lifecycle
+
+Public methods return numeric TiRTC codes instead of throwing for SDK failures. `0` means success. Use `TiRtc.errorToString(code)` or `TiRtc.formatError(code)` for display and logs.
+
+Constructors create native owner identities, so outputs and inputs can attach to a `TiRtcConn` before `connect(...)`. `dispose()` releases the native object only after the underlying stop/destroy call returns success. Calling `dispose()` again after success is valid and returns success; methods called after a successful dispose return the object released code. Input/output/view ownership is tracked by native object id plus generation so stale callbacks or recycled ids do not attach to a newer object.
+
+## Release
+
+Version `2.2.0` is the current React Native package for TiRTC client media output and talkback. It supports React Native New Architecture apps on Android and iOS and pins Android `com.tange.ai:tirtc:2.2.9` and iOS `TiRTC` `2.2.9`.
+
+## License
+
+This npm package is licensed as BSD-3-Clause. The BSD-3-Clause license covers the React Native wrapper/source distributed in this package. Native TiRTC runtime binaries consumed by the Android and iOS dependencies are governed by their own distributed terms.
+
+## Package Validation
+
+```sh
+npm run lint
+npm test
+npm run typecheck
+npm run build
+npm run codegen:check
+```

package/TiRtcReactNative.podspec

@@ -0,0 +1,35 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'TiRtcReactNative'
+  s.version = package['version']
+  s.summary = package['description']
+  s.homepage = 'https://tange.ai/'
+  s.license = { :type => 'BSD-3-Clause', :file => 'LICENSE' }
+  s.author = 'Tange AI'
+  s.platforms = { :ios => '15.1' }
+  s.source = { :git => 'https://gitlab.tange-ai.com/tirtc-nexus/tirtc.git', :tag => s.version.to_s }
+  s.source_files = 'ios/**/*.{h,m,mm,swift}'
+  s.dependency 'React-Core'
+  s.dependency 'TiRTC', '2.2.9'
+
+  if respond_to?(:install_modules_dependencies, true)
+    install_modules_dependencies(s)
+  else
+    s.dependency 'React-RCTFabric'
+    s.dependency 'React-Codegen'
+    s.dependency 'RCTRequired'
+    s.dependency 'RCTTypeSafety'
+    s.dependency 'ReactCommon/turbomodule/bridging'
+    s.dependency 'ReactCommon/turbomodule/core'
+    s.dependency 'React-NativeModulesApple'
+    s.dependency 'Yoga'
+    s.dependency 'React-Fabric'
+    s.dependency 'React-graphics'
+    s.dependency 'React-utils'
+    s.dependency 'React-featureflags'
+    s.dependency 'React-debug'
+  end
+end

package/android/build.gradle

@@ -0,0 +1,37 @@
+buildscript {
+  repositories {
+    google()
+    mavenCentral()
+  }
+  dependencies {
+    classpath("com.android.tools.build:gradle:8.8.2")
+    classpath("org.jetbrains.kotlin:kotlin-gradle-plugin:2.0.21")
+  }
+}
+
+apply plugin: "com.android.library"
+apply plugin: "com.facebook.react"
+apply plugin: "org.jetbrains.kotlin.android"
+
+android {
+  namespace "com.tange.ai.tirtc.reactnative"
+  compileSdk 35
+
+  defaultConfig {
+    minSdk 23
+  }
+}
+
+repositories {
+  google()
+  mavenCentral()
+}
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "com.tange.ai:tirtc:${safeExtGet("tirtcAndroidVersion", "2.2.9")}"
+}
+
+def safeExtGet(prop, fallback) {
+  return rootProject.ext.has(prop) ? rootProject.ext.get(prop) : fallback
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android" />