agora-electron-sdk 0.0.0-dev.1

package/ts/Private/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/ts/Private/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/ts/Private/extension/IAgoraMediaPlayerSourceExtension.ts

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

package/ts/Private/extension/IAgoraMediaRecorderExtension.ts

@@ -0,0 +1,59 @@
+import { IMediaRecorderObserver } from '../AgoraMediaBase';
+
+export type IMediaRecorderEvent = IMediaRecorderObserver;
+
+declare module '../IAgoraMediaRecorder' {
+  interface IMediaRecorder {
+    _addListenerPreCheck<EventType extends keyof IMediaRecorderEvent>(
+      eventType: EventType
+    ): boolean;
+
+    /**
+     * Adds one IMediaRecorderEvent listener.
+     * After calling this method, you can listen for the corresponding events in the IMediaRecorder object and obtain data through IMediaRecorderEvent. 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 IMediaRecorderEvent.
+     *
+     * @param listener The callback function for eventType. Take adding a listener for onRecorderStateChanged as an example: // Create an onRecorderStateChanged object
+     * const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {};
+     * // Add one onRecorderStateChanged listener
+     * engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
+     */
+    addListener<EventType extends keyof IMediaRecorderEvent>(
+      eventType: EventType,
+      listener: IMediaRecorderEvent[EventType]
+    ): void;
+
+    /**
+     * Removes the specified IMediaRecorderEvent 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 IMediaRecorderEvent.
+     *
+     * @param listener The callback function for eventType. Must pass in the same function object in addListener . Take removing the listener for onRecorderStateChanged as an example: // Create an onRecorderStateChanged object
+     * const onRecorderStateChanged = (state: RecorderState, error: RecorderErrorCode) => {};
+     * // Add one onRecorderStateChanged listener
+     * engine.addListener('onRecorderStateChanged', onRecorderStateChanged);
+     * // Remove the onRecorderStateChanged listener
+     * engine.removeListener('onRecorderStateChanged', onRecorderStateChanged);
+     */
+    removeListener<EventType extends keyof IMediaRecorderEvent>(
+      eventType: EventType,
+      listener?: IMediaRecorderEvent[EventType]
+    ): void;
+
+    /**
+     * Removes all listeners for the specified event.
+     *
+     * @param eventType The name of the target event to listen for. See IMediaRecorderEvent.
+     */
+    removeAllListeners<EventType extends keyof IMediaRecorderEvent>(
+      eventType?: EventType
+    ): void;
+
+    /**
+     * @ignore
+     */
+    release(): void;
+  }
+}

package/ts/Private/extension/IAgoraMusicContentCenterExtension.ts

@@ -0,0 +1,34 @@
+import { IMusicContentCenterEventHandler } from '../IAgoraMusicContentCenter';
+
+export type IMusicContentCenterEvent = IMusicContentCenterEventHandler;
+
+declare module '../IAgoraMusicContentCenter' {
+  interface IMusicContentCenter {
+    _addListenerPreCheck<EventType extends keyof IMusicContentCenterEvent>(
+      eventType: EventType
+    ): boolean;
+
+    /**
+     * @ignore
+     */
+    addListener<EventType extends keyof IMusicContentCenterEvent>(
+      eventType: EventType,
+      listener: IMusicContentCenterEvent[EventType]
+    ): void;
+
+    /**
+     * @ignore
+     */
+    removeListener<EventType extends keyof IMusicContentCenterEvent>(
+      eventType: EventType,
+      listener?: IMusicContentCenterEvent[EventType]
+    ): void;
+
+    /**
+     * @ignore
+     */
+    removeAllListeners<EventType extends keyof IMusicContentCenterEvent>(
+      eventType?: EventType
+    ): void;
+  }
+}

package/ts/Private/extension/IAgoraRhythmPlayerExtension.ts

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

package/ts/Private/extension/IAgoraRtcEngineExExtension.ts

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

package/ts/Private/extension/IAgoraRtcEngineExtension.ts

@@ -0,0 +1,64 @@
+import { IAudioEncodedFrameObserver } from '../AgoraBase';
+import { IAudioSpectrumObserver } from '../AgoraMediaBase';
+import {
+  IDirectCdnStreamingEventHandler,
+  IMetadataObserver,
+  IRtcEngineEventHandler,
+} from '../IAgoraRtcEngine';
+
+export type IRtcEngineEvent = IRtcEngineEventHandler &
+  IDirectCdnStreamingEventHandler &
+  IMetadataObserver &
+  IAudioEncodedFrameObserver &
+  IAudioSpectrumObserver;
+
+declare module '../IAgoraRtcEngine' {
+  interface IRtcEngine {
+    _addListenerPreCheck<EventType extends keyof IRtcEngineEvent>(
+      eventType: EventType
+    ): boolean;
+
+    /**
+     * Adds one IRtcEngineEvent listener.
+     * After calling this method, you can listen for the corresponding events in the IRtcEngine object and obtain data through IRtcEngineEvent. 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 IRtcEngineEvent.
+     *
+     * @param listener The callback function for eventType. Take adding a listener for onJoinChannelSuccess as an example: // Create an onJoinChannelSuccess object
+     * const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
+     * // Add one onJoinChannelSuccess listener
+     * engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
+     */
+    addListener<EventType extends keyof IRtcEngineEvent>(
+      eventType: EventType,
+      listener: IRtcEngineEvent[EventType]
+    ): void;
+
+    /**
+     * Removes the specified IRtcEngineEvent 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 IRtcEngineEvent.
+     *
+     * @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 onJoinChannelSuccess object
+     * const onJoinChannelSuccess = (connection: RtcConnection, elapsed: number) => {};
+     * // Add one onJoinChannelSuccess listener
+     * engine.addListener('onJoinChannelSuccess', onJoinChannelSuccess);
+     * // Remove the onJoinChannelSuccess listener
+     * engine.removeListener('onJoinChannelSuccess', onJoinChannelSuccess);
+     */
+    removeListener<EventType extends keyof IRtcEngineEvent>(
+      eventType: EventType,
+      listener?: IRtcEngineEvent[EventType]
+    ): void;
+
+    /**
+     * Removes all listeners for the specified event.
+     *
+     * @param eventType The name of the target event to listen for. See IRtcEngineEvent.
+     */
+    removeAllListeners<EventType extends keyof IRtcEngineEvent>(
+      eventType?: EventType
+    ): void;
+  }
+}

package/ts/Private/extension/IAgoraSpatialAudioExtension.ts

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

package/ts/Private/extension/IAudioDeviceManagerExtension.ts

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

package/ts/Private/impl/AgoraBaseImpl.ts

@@ -0,0 +1,39 @@
+import { IAudioEncodedFrameObserver } from '../AgoraBase';
+
+export function processIAudioEncodedFrameObserver(
+  handler: IAudioEncodedFrameObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onRecordAudioEncodedFrame':
+      if (handler.onRecordAudioEncodedFrame !== undefined) {
+        handler.onRecordAudioEncodedFrame(
+          jsonParams.frameBuffer,
+          jsonParams.length,
+          jsonParams.audioEncodedFrameInfo
+        );
+      }
+      break;
+
+    case 'onPlaybackAudioEncodedFrame':
+      if (handler.onPlaybackAudioEncodedFrame !== undefined) {
+        handler.onPlaybackAudioEncodedFrame(
+          jsonParams.frameBuffer,
+          jsonParams.length,
+          jsonParams.audioEncodedFrameInfo
+        );
+      }
+      break;
+
+    case 'onMixedAudioEncodedFrame':
+      if (handler.onMixedAudioEncodedFrame !== undefined) {
+        handler.onMixedAudioEncodedFrame(
+          jsonParams.frameBuffer,
+          jsonParams.length,
+          jsonParams.audioEncodedFrameInfo
+        );
+      }
+      break;
+  }
+}

package/ts/Private/impl/AgoraMediaBaseImpl.ts

@@ -0,0 +1,237 @@
+import {
+  IAudioFrameObserver,
+  IAudioFrameObserverBase,
+  IAudioPcmFrameSink,
+  IAudioSpectrumObserver,
+  IFaceInfoObserver,
+  IMediaRecorderObserver,
+  IVideoEncodedFrameObserver,
+  IVideoFrameMetaInfo,
+  IVideoFrameObserver,
+  MetaInfoKey,
+} from '../AgoraMediaBase';
+// @ts-ignore
+export class IVideoFrameMetaInfoImpl implements IVideoFrameMetaInfo {
+  getMetaInfoStr(key: MetaInfoKey): string {
+    const apiType = this.getApiTypeFromGetMetaInfoStr(key);
+    const jsonParams = {
+      key: key,
+      toJSON: () => {
+        return {
+          key: key,
+        };
+      },
+    };
+    const jsonResults = callIrisApi.call(this, apiType, jsonParams);
+    return jsonResults.result;
+  }
+
+  protected getApiTypeFromGetMetaInfoStr(key: MetaInfoKey): string {
+    return 'VideoFrameMetaInfo_getMetaInfoStr_c81192f';
+  }
+}
+
+export function processIAudioPcmFrameSink(
+  handler: IAudioPcmFrameSink,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onFrame':
+      if (handler.onFrame !== undefined) {
+        handler.onFrame(jsonParams.frame);
+      }
+      break;
+  }
+}
+
+export function processIAudioFrameObserverBase(
+  handler: IAudioFrameObserverBase,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onRecordAudioFrame':
+      if (handler.onRecordAudioFrame !== undefined) {
+        handler.onRecordAudioFrame(jsonParams.channelId, jsonParams.audioFrame);
+      }
+      break;
+
+    case 'onPlaybackAudioFrame':
+      if (handler.onPlaybackAudioFrame !== undefined) {
+        handler.onPlaybackAudioFrame(
+          jsonParams.channelId,
+          jsonParams.audioFrame
+        );
+      }
+      break;
+
+    case 'onMixedAudioFrame':
+      if (handler.onMixedAudioFrame !== undefined) {
+        handler.onMixedAudioFrame(jsonParams.channelId, jsonParams.audioFrame);
+      }
+      break;
+
+    case 'onEarMonitoringAudioFrame':
+      if (handler.onEarMonitoringAudioFrame !== undefined) {
+        handler.onEarMonitoringAudioFrame(jsonParams.audioFrame);
+      }
+      break;
+  }
+}
+
+export function processIAudioFrameObserver(
+  handler: IAudioFrameObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onPlaybackAudioFrameBeforeMixing':
+      if (handler.onPlaybackAudioFrameBeforeMixing !== undefined) {
+        handler.onPlaybackAudioFrameBeforeMixing(
+          jsonParams.channelId,
+          jsonParams.uid,
+          jsonParams.audioFrame
+        );
+      }
+      break;
+  }
+}
+
+export function processIAudioSpectrumObserver(
+  handler: IAudioSpectrumObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onLocalAudioSpectrum':
+      if (handler.onLocalAudioSpectrum !== undefined) {
+        handler.onLocalAudioSpectrum(jsonParams.data);
+      }
+      break;
+
+    case 'onRemoteAudioSpectrum':
+      if (handler.onRemoteAudioSpectrum !== undefined) {
+        handler.onRemoteAudioSpectrum(
+          jsonParams.spectrums,
+          jsonParams.spectrumNumber
+        );
+      }
+      break;
+  }
+}
+
+export function processIVideoEncodedFrameObserver(
+  handler: IVideoEncodedFrameObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onEncodedVideoFrameReceived':
+      if (handler.onEncodedVideoFrameReceived !== undefined) {
+        handler.onEncodedVideoFrameReceived(
+          jsonParams.uid,
+          jsonParams.imageBuffer,
+          jsonParams.length,
+          jsonParams.videoEncodedFrameInfo
+        );
+      }
+      break;
+  }
+}
+
+export function processIVideoFrameObserver(
+  handler: IVideoFrameObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onCaptureVideoFrame':
+      if (handler.onCaptureVideoFrame !== undefined) {
+        handler.onCaptureVideoFrame(
+          jsonParams.sourceType,
+          jsonParams.videoFrame
+        );
+      }
+      break;
+
+    case 'onPreEncodeVideoFrame':
+      if (handler.onPreEncodeVideoFrame !== undefined) {
+        handler.onPreEncodeVideoFrame(
+          jsonParams.sourceType,
+          jsonParams.videoFrame
+        );
+      }
+      break;
+
+    case 'onMediaPlayerVideoFrame':
+      if (handler.onMediaPlayerVideoFrame !== undefined) {
+        handler.onMediaPlayerVideoFrame(
+          jsonParams.videoFrame,
+          jsonParams.mediaPlayerId
+        );
+      }
+      break;
+
+    case 'onRenderVideoFrame':
+      if (handler.onRenderVideoFrame !== undefined) {
+        handler.onRenderVideoFrame(
+          jsonParams.channelId,
+          jsonParams.remoteUid,
+          jsonParams.videoFrame
+        );
+      }
+      break;
+
+    case 'onTranscodedVideoFrame':
+      if (handler.onTranscodedVideoFrame !== undefined) {
+        handler.onTranscodedVideoFrame(jsonParams.videoFrame);
+      }
+      break;
+  }
+}
+
+export function processIFaceInfoObserver(
+  handler: IFaceInfoObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onFaceInfo':
+      if (handler.onFaceInfo !== undefined) {
+        handler.onFaceInfo(jsonParams.outFaceInfo);
+      }
+      break;
+  }
+}
+
+export function processIMediaRecorderObserver(
+  handler: IMediaRecorderObserver,
+  event: string,
+  jsonParams: any
+) {
+  switch (event) {
+    case 'onRecorderStateChanged':
+      if (handler.onRecorderStateChanged !== undefined) {
+        handler.onRecorderStateChanged(
+          jsonParams.channelId,
+          jsonParams.uid,
+          jsonParams.state,
+          jsonParams.reason
+        );
+      }
+      break;
+
+    case 'onRecorderInfoUpdated':
+      if (handler.onRecorderInfoUpdated !== undefined) {
+        handler.onRecorderInfoUpdated(
+          jsonParams.channelId,
+          jsonParams.uid,
+          jsonParams.info
+        );
+      }
+      break;
+  }
+}
+
+import { callIrisApi } from '../internal/IrisApiEngine';