react-native-shengwang 4.6.2-rc.2

package/src/IAgoraSpatialAudio.ts

@@ -0,0 +1,248 @@
+import './extension/IAgoraSpatialAudioExtension';
+import { RtcConnection } from './IAgoraRtcEngineEx';
+
+/**
+ * 远端用户或媒体播放器的空间位置信息。
+ */
+export class RemoteVoicePositionInfo {
+  /**
+   * 在世界坐标系中的坐标。该参数是长度为 3 的数组，三个值依次表示前、右、上的坐标值。
+   */
+  position?: number[];
+  /**
+   * 在世界坐标系前轴的单位向量。该参数是长度为 3 的数组，三个值依次表示前、右、上的坐标值。
+   */
+  forward?: number[];
+}
+
+/**
+ * 隔声区域的设置。
+ */
+export class SpatialAudioZone {
+  /**
+   * 隔声区域的 ID。
+   */
+  zoneSetId?: number;
+  /**
+   * 隔声区域的空间中心点。该参数是长度为 3 的数组，三个值依次表示前、右、上的坐标值。
+   */
+  position?: number[];
+  /**
+   * 以 position 为起点，向前的单位向量。该参数是长度为 3 的数组，三个值依次表示前、右、上的坐标值。
+   */
+  forward?: number[];
+  /**
+   * 以 position 为起点，向右的单位向量。该参数是长度为 3 的数组，三个值依次表示前、右、上的坐标值。
+   */
+  right?: number[];
+  /**
+   * 以 position 为起点，向上的单位向量。该参数是长度为 3 的数组，三个值依次表示前、右、上的坐标值。
+   */
+  up?: number[];
+  /**
+   * 将整个隔声区域看做一个立方体，表示向前的边长，单位为游戏引擎的单位长度。
+   */
+  forwardLength?: number;
+  /**
+   * 将整个隔声区域看做一个立方体，表示向右的边长，单位为游戏引擎的单位长度。
+   */
+  rightLength?: number;
+  /**
+   * 将整个隔声区域看做一个立方体，表示向上的边长，单位为游戏引擎的单位长度。
+   */
+  upLength?: number;
+  /**
+   * 隔声区域以内的用户和外部用户互通时的声音衰减系数，取值范围为 [0,1]。其中：
+   *  0：广播模式，即音量和音色均不随距离衰减，无论距离远近，本地用户听到的音量和音色都无变化。
+   *  (0,0.5)：弱衰减模式，即音量和音色在传播过程中仅发生微弱衰减，跟真实环境相比，声音可以传播得更远。
+   *  0.5：模拟音量在真实环境下的衰减，效果等同于不设置 audioAttenuation 参数。
+   *  (0.5,1]：强衰减模式 (默认值为 1) ，即音量和音色在传播过程中发生迅速衰减。
+   */
+  audioAttenuation?: number;
+}
+
+/**
+ * 该类通过 SDK 计算用户坐标，实现空间音频。
+ *
+ * 该类继承自 IBaseSpatialAudioEngine 。调用该类下其他 API 前，你需要调用 initialize 方法初始化该类。
+ */
+export abstract class ILocalSpatialAudioEngine {
+  /**
+   * @ignore
+   */
+  abstract release(): void;
+
+  /**
+   * 初始化 ILocalSpatialAudioEngine 。
+   *
+   * 在调用 ILocalSpatialAudioEngine 类的其他方法前，你需要先调用该方法初始化 ILocalSpatialAudioEngine 。
+   *  SDK 只支持每个 App 创建一个 ILocalSpatialAudioEngine 实例。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract initialize(): number;
+
+  /**
+   * 更新远端用户的空间位置信息。
+   *
+   * 成功调用该方法后，SDK 会根据本地和远端用户的相对位置计算空间音频参数。 该方法需要在 joinChannel 后调用。
+   *
+   * @param uid 用户 ID。需与用户加入频道时填写的用户 ID 一致。
+   * @param posInfo 远端用户的空间位置信息。详见 RemoteVoicePositionInfo 。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract updateRemotePosition(
+    uid: number,
+    posInfo: RemoteVoicePositionInfo
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract updateRemotePositionEx(
+    uid: number,
+    posInfo: RemoteVoicePositionInfo,
+    connection: RtcConnection
+  ): number;
+
+  /**
+   * 删除指定远端用户的空间位置信息。
+   *
+   * 成功调用该方法后，本地用户将听不到指定的远端用户。
+   * 离开频道后，为避免计算资源的浪费，你需要调用该方法删除指定远端用户的空间位置信息。否则，该用户的空间位置信息会一直被保存。当远端用户人数大于 setMaxAudioRecvCount 中设定的可接收音频流数时，会按照相对距离依次自动取消订阅距离最远的用户的音频流。
+   *
+   * @param uid 用户 ID。需与用户加入频道时填写的用户 ID 一致。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract removeRemotePosition(uid: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract removeRemotePositionEx(
+    uid: number,
+    connection: RtcConnection
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract clearRemotePositionsEx(connection: RtcConnection): number;
+
+  /**
+   * @ignore
+   */
+  abstract updateSelfPositionEx(
+    position: number[],
+    axisForward: number[],
+    axisRight: number[],
+    axisUp: number[],
+    connection: RtcConnection
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract setMaxAudioRecvCount(maxCount: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract setAudioRecvRange(range: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract setDistanceUnit(unit: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract updateSelfPosition(
+    position: number[],
+    axisForward: number[],
+    axisRight: number[],
+    axisUp: number[]
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract updatePlayerPositionInfo(
+    playerId: number,
+    positionInfo: RemoteVoicePositionInfo
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract setParameters(params: string): number;
+
+  /**
+   * @ignore
+   */
+  abstract muteLocalAudioStream(mute: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract muteAllRemoteAudioStreams(mute: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract muteRemoteAudioStream(uid: number, mute: boolean): number;
+
+  /**
+   * 设置指定用户的声音衰减效果。
+   *
+   * @param uid 用户 ID。需与用户加入频道时填写的用户 ID 一致。
+   * @param attenuation 针对该用户的声音衰减系数，取值范围为[0,1]。其中：
+   * @param forceSet 是否强制设定该用户的声音衰减效果： true ：强制使用 attenuation 设置该用户的声音衰减效果，此时 SpatialAudioZone 中的 audioAttenuation 中设置的隔声区域衰减系数对该用户不生效。 false ：不强制使用 attenuation 设置用户的声音衰减效果，分为以下两种情况。
+   *  如果音源和听声者分属于隔声区域内部和外部，则声音衰减效果由 SpatialAudioZone 中的 audioAttenuation 决定。
+   *  如果音源和听声者在同一个隔声区域内或同在隔声区域外，则声音衰减效果由该方法中的 attenuation 决定。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract setRemoteAudioAttenuation(
+    uid: number,
+    attenuation: number,
+    forceSet: boolean
+  ): number;
+
+  /**
+   * @ignore
+   */
+  abstract setZones(zones: SpatialAudioZone[], zoneCount: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract setPlayerAttenuation(
+    playerId: number,
+    attenuation: number,
+    forceSet: boolean
+  ): number;
+
+  /**
+   * 删除所有远端用户的空间位置信息。
+   *
+   * 成功调用该方法后，本地用户将听不到所有远端用户。
+   * 离开频道后，为避免计算资源的浪费，你也可以调用该方法删除所有远端用户的空间位置信息。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract clearRemotePositions(): number;
+}

package/src/IAudioDeviceManager.ts

@@ -0,0 +1,185 @@
+import './extension/IAudioDeviceManagerExtension';
+import { AudioDeviceInfo } from './IAgoraRtcEngine';
+
+/**
+ * 设备 ID 的最大长度。
+ */
+export enum MaxDeviceIdLengthType {
+  /**
+   * 设备 ID 的最大长度为 512 个字符。
+   */
+  MaxDeviceIdLength = 512,
+}
+
+/**
+ * 音频设备管理方法。
+ */
+export abstract class IAudioDeviceManager {
+  /**
+   * @ignore
+   */
+  abstract enumeratePlaybackDevices(): AudioDeviceInfo[];
+
+  /**
+   * @ignore
+   */
+  abstract enumerateRecordingDevices(): AudioDeviceInfo[];
+
+  /**
+   * @ignore
+   */
+  abstract setPlaybackDevice(deviceId: string): number;
+
+  /**
+   * @ignore
+   */
+  abstract getPlaybackDevice(): string;
+
+  /**
+   * @ignore
+   */
+  abstract getPlaybackDeviceInfo(): AudioDeviceInfo;
+
+  /**
+   * @ignore
+   */
+  abstract setPlaybackDeviceVolume(volume: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract getPlaybackDeviceVolume(): number;
+
+  /**
+   * @ignore
+   */
+  abstract setRecordingDevice(deviceId: string): number;
+
+  /**
+   * @ignore
+   */
+  abstract getRecordingDevice(): string;
+
+  /**
+   * @ignore
+   */
+  abstract getRecordingDeviceInfo(): AudioDeviceInfo;
+
+  /**
+   * @ignore
+   */
+  abstract setRecordingDeviceVolume(volume: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract getRecordingDeviceVolume(): number;
+
+  /**
+   * @ignore
+   */
+  abstract setLoopbackDevice(deviceId: string): number;
+
+  /**
+   * @ignore
+   */
+  abstract getLoopbackDevice(): string;
+
+  /**
+   * @ignore
+   */
+  abstract setPlaybackDeviceMute(mute: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract getPlaybackDeviceMute(): boolean;
+
+  /**
+   * @ignore
+   */
+  abstract setRecordingDeviceMute(mute: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract getRecordingDeviceMute(): boolean;
+
+  /**
+   * 启动音频播放设备测试。
+   *
+   * 该方法用于测试本地音频播放设备是否能正常工作。启动测试后，SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。
+   * 调用该方法后，SDK 会每隔 100 毫秒触发一次 onAudioVolumeIndication 回调，报告 uid = 1 及播放设备的音量信息。
+   * 该方法和 startEchoTest 的区别在于该方法检测本地的音频播放设备能否正常工作，后者可以检测音视频设备及网络是否正常。 该方法需要在加入频道前调用。测试完成后，如需加入频道，请确保先调用 stopPlaybackDeviceTest 停止设备测试。
+   *
+   * @param testAudioFilePath 音频文件的绝对路径，路径字符串使用 UTF-8 编码格式。
+   *  支持文件格式: wav、mp3、m4a、aac。
+   *  支持文件采样率: 8000、16000、32000、44100、48000。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract startPlaybackDeviceTest(testAudioFilePath: string): number;
+
+  /**
+   * 停止音频播放设备测试。
+   *
+   * 该方法用于停止音频播放设备测试。调用 startPlaybackDeviceTest 后，必须调用该方法停止测试。 该方法需要在加入频道前调用。
+   *
+   * @returns
+   * 0: 方法调用成功。
+   *  < 0: 方法调用失败。详见[错误码](https://doc.shengwang.cn/api-ref/rtc/rn/error-code)了解详情和解决建议。
+   */
+  abstract stopPlaybackDeviceTest(): number;
+
+  /**
+   * @ignore
+   */
+  abstract startRecordingDeviceTest(indicationInterval: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract stopRecordingDeviceTest(): number;
+
+  /**
+   * @ignore
+   */
+  abstract startAudioDeviceLoopbackTest(indicationInterval: number): number;
+
+  /**
+   * @ignore
+   */
+  abstract stopAudioDeviceLoopbackTest(): number;
+
+  /**
+   * @ignore
+   */
+  abstract followSystemPlaybackDevice(enable: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract followSystemRecordingDevice(enable: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract followSystemLoopbackDevice(enable: boolean): number;
+
+  /**
+   * @ignore
+   */
+  abstract release(): void;
+
+  /**
+   * @ignore
+   */
+  abstract getPlaybackDefaultDevice(): AudioDeviceInfo;
+
+  /**
+   * @ignore
+   */
+  abstract getRecordingDefaultDevice(): AudioDeviceInfo;
+}

package/src/Utils.ts

@@ -0,0 +1,35 @@
+/**
+ * In certain systems or contexts, the maximum value of an unsigned integer can be used to represent a specific value in signed integers.
+ * This is due to the two's complement representation of signed integers in binary.
+ * When interpreted as an unsigned integer, the binary representation of this specific signed integer corresponds to the maximum value of the unsigned integer.
+ * Therefore, when dealing with values from such systems or contexts, we need to convert this maximum value to the corresponding signed integer value for correct interpretation.
+ * for example, 18446744073709551615 can be -1.
+ * @ignore
+ */
+export function parseIntPtr2Number(value: number | string): number {
+  try {
+    let bigIntVal = BigInt(value);
+    if (bigIntVal > 2n ** 63n - 1n) {
+      bigIntVal -= 2n ** 64n;
+    }
+    return Number(bigIntVal);
+  } catch (e) {
+    return value as number;
+  }
+}
+
+export let debuggable = false;
+
+/**
+ * @internal
+ */
+export function setDebuggable(flag: boolean) {
+  debuggable = flag;
+}
+
+/**
+ * @internal
+ */
+export function isDebuggable() {
+  return debuggable && __DEV__;
+}

package/src/extension/AgoraBaseExtension.ts

@@ -0,0 +1 @@
+export {};

package/src/extension/AgoraMediaBaseExtension.ts

@@ -0,0 +1 @@
+export {};

package/src/extension/AgoraMediaPlayerTypesExtension.ts

@@ -0,0 +1 @@
+export {};

package/src/extension/IAgoraH265TranscoderExtension.ts

@@ -0,0 +1,39 @@
+import { IH265TranscoderObserver } from '../IAgoraH265Transcoder';
+
+export type IH265TranscoderEvent = IH265TranscoderObserver;
+
+declare module '../IAgoraH265Transcoder' {
+  interface IH265Transcoder {
+    _addListenerPreCheck<EventType extends keyof IH265TranscoderEvent>(
+      eventType: EventType
+    ): boolean;
+
+    /**
+     * @ignore
+     */
+    addListener<EventType extends keyof IH265TranscoderEvent>(
+      eventType: EventType,
+      listener: IH265TranscoderEvent[EventType]
+    ): void;
+
+    /**
+     * @ignore
+     */
+    removeListener<EventType extends keyof IH265TranscoderEvent>(
+      eventType: EventType,
+      listener?: IH265TranscoderEvent[EventType]
+    ): void;
+
+    /**
+     * @ignore
+     */
+    removeAllListeners<EventType extends keyof IH265TranscoderEvent>(
+      eventType?: EventType
+    ): void;
+
+    /**
+     * @ignore
+     */
+    release(): void;
+  }
+}

package/src/extension/IAgoraLogExtension.ts

@@ -0,0 +1 @@
+export {};

package/src/extension/IAgoraMediaEngineExtension.ts

@@ -0,0 +1,62 @@
+import {
+  IAudioFrameObserver,
+  IFaceInfoObserver,
+  IVideoEncodedFrameObserver,
+  IVideoFrameObserver,
+} from '../AgoraMediaBase';
+
+export type IMediaEngineEvent = IAudioFrameObserver &
+  IVideoFrameObserver &
+  IVideoEncodedFrameObserver &
+  IFaceInfoObserver;
+
+declare module '../IAgoraMediaEngine' {
+  interface IMediaEngine {
+    _addListenerPreCheck<EventType extends keyof IMediaEngineEvent>(
+      eventType: EventType
+    ): boolean;
+
+    /**
+     * Adds one IMediaEngineEvent listener.
+     * After calling this method, you can listen for the corresponding events in the IMediaEngine object and obtain data through IMediaEngineEvent. Depending on your project needs, you can add multiple listeners for the same event.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaEngineEvent.
+     *
+     * @param listener The callback function for eventType. Take adding a listener for onPlaybackAudioFrameBeforeMixing as an example: // Create an onPlaybackAudioFrameBeforeMixing object
+     * const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
+     * // Add one onPlaybackAudioFrameBeforeMixing listener
+     * engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
+     */
+    addListener<EventType extends keyof IMediaEngineEvent>(
+      eventType: EventType,
+      listener: IMediaEngineEvent[EventType]
+    ): void;
+
+    /**
+     * Removes the specified IMediaEngineEvent listener.
+     * For listened events, if you no longer need to receive the callback message, you can call this method to remove the corresponding listener.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaEngineEvent.
+     *
+     * @param listener The callback function for eventType. Must pass in the same function object in addListener . Take removing the listener for onJoinChannelSuccess as an example: // Create an onPlaybackAudioFrameBeforeMixing object
+     * const onPlaybackAudioFrameBeforeMixing = (channelId: string, uid: number, audioFrame: AudioFrame) => {};
+     * // Add one onPlaybackAudioFrameBeforeMixing listener
+     * engine.addListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
+     * // Remove the onPlaybackAudioFrameBeforeMixing listener
+     * engine.removeListener('onPlaybackAudioFrameBeforeMixing', onPlaybackAudioFrameBeforeMixing);
+     */
+    removeListener<EventType extends keyof IMediaEngineEvent>(
+      eventType: EventType,
+      listener?: IMediaEngineEvent[EventType]
+    ): void;
+
+    /**
+     * Removes all listeners for the specified event.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaEngineEvent.
+     */
+    removeAllListeners<EventType extends keyof IMediaEngineEvent>(
+      eventType?: EventType
+    ): void;
+  }
+}

package/src/extension/IAgoraMediaPlayerExtension.ts

@@ -0,0 +1,64 @@
+import { IAudioPcmFrameSink, IAudioSpectrumObserver } from '../AgoraMediaBase';
+import { IMediaPlayerVideoFrameObserver } from '../IAgoraMediaPlayer';
+import { IMediaPlayerSourceObserver } from '../IAgoraMediaPlayerSource';
+
+export type IMediaPlayerEvent = IMediaPlayerSourceObserver &
+  IAudioPcmFrameSink &
+  IMediaPlayerVideoFrameObserver &
+  IAudioSpectrumObserver;
+
+declare module '../IAgoraMediaPlayer' {
+  interface IMediaPlayer {
+    _addListenerPreCheck<EventType extends keyof IMediaPlayerEvent>(
+      eventType: EventType
+    ): boolean;
+
+    /**
+     * Adds one IMediaPlayerEvent listener.
+     * After calling this method, you can listen for the corresponding events in the IMediaPlayer object and obtain data through IMediaPlayerEvent. Depending on your project needs, you can add multiple listeners for the same event.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaPlayerEvent.
+     *
+     * @param listener The callback function for eventType. Take adding a listener for onPlayerSourceStateChanged as an example: // Create an onPlayerSourceStateChanged object
+     * const onPlayerSourceStateChanged = (connection: RtcConnection, elapsed: number) => {};
+     * // Add one onPlayerSourceStateChanged listener
+     * engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
+     */
+    addListener<EventType extends keyof IMediaPlayerEvent>(
+      eventType: EventType,
+      listener: IMediaPlayerEvent[EventType]
+    ): void;
+
+    /**
+     * Removes the specified IMediaPlayerEvent listener.
+     * For listened events, if you no longer need to receive the callback message, you can call this method to remove the corresponding listener.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaPlayerEvent.
+     *
+     * @param listener The callback function for eventType. Must pass in the same function object in addListener . Take removing the listener for onPlayerSourceStateChanged as an example: // Create an onPlayerSourceStateChanged object
+     * const onPlayerSourceStateChanged = (state: MediaPlayerState, ec: MediaPlayerError) => {};
+     * // Add one onPlayerSourceStateChanged listener
+     * engine.addListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
+     * // Remove the onPlayerSourceStateChanged listener
+     * engine.removeListener('onPlayerSourceStateChanged', onPlayerSourceStateChanged);
+     */
+    removeListener<EventType extends keyof IMediaPlayerEvent>(
+      eventType: EventType,
+      listener?: IMediaPlayerEvent[EventType]
+    ): void;
+
+    /**
+     * Removes all listeners for the specified event.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaPlayerEvent.
+     */
+    removeAllListeners<EventType extends keyof IMediaPlayerEvent>(
+      eventType?: EventType
+    ): void;
+
+    /**
+     * @ignore
+     */
+    release(): void;
+  }
+}

package/src/extension/IAgoraMediaPlayerSourceExtension.ts

@@ -0,0 +1 @@
+export {};