agora-electron-sdk 4.1.1-rc.1 → 4.2.0-dev.13

package/types/Private/AgoraMediaPlayerTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AgoraMediaPlayerTypes.d.ts","sourceRoot":"","sources":["../../ts/Private/AgoraMediaPlayerTypes.ts"],"names":[],"mappings":"AAAA,OAAO,4CAA4C,CAAC;AACpD;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,eAAe,IAAI;IACnB;;OAEG;IACH,kBAAkB,IAAI;IACtB;;OAEG;IACH,wBAAwB,IAAI;IAC5B;;OAEG;IACH,kBAAkB,IAAI;IACtB;;OAEG;IACH,iBAAiB,IAAI;IACrB;;OAEG;IACH,4BAA4B,IAAI;IAChC;;OAEG;IACH,oCAAoC,IAAI;IACxC;;OAEG;IACH,kBAAkB,IAAI;IACtB;;OAEG;IACH,0BAA0B,KAAK;IAC/B;;OAEG;IACH,2BAA2B,KAAK;IAChC;;OAEG;IACH,0BAA0B,KAAK;IAC/B;;OAEG;IACH,0BAA0B,KAAK;IAC/B;;OAEG;IACH,uBAAuB,KAAK;IAC5B;;OAEG;IACH,4BAA4B,KAAK;IACjC;;OAEG;IACH,2BAA2B,KAAK;IAChC;;OAEG;IACH,iBAAiB,MAAM;CACxB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,eAAe,IAAI;IACnB;;OAEG;IACH,2BAA2B,KAAK;IAChC;;OAEG;IACH,mBAAmB,KAAK;IACxB;;OAEG;IACH,qBAAqB,KAAK;IAC1B;;OAEG;IACH,6BAA6B,KAAK;IAClC;;OAEG;IACH,4BAA4B,KAAK;IACjC;;OAEG;IACH,4BAA4B,KAAK;IACjC;;OAEG;IACH,4BAA4B,KAAK;IACjC;;OAEG;IACH,4BAA4B,KAAK;IACjC;;OAEG;IACH,uBAAuB,KAAK;IAC5B;;OAEG;IACH,sBAAsB,MAAM;IAC5B;;OAEG;IACH,iCAAiC,MAAM;IACvC;;OAEG;IACH,6BAA6B,MAAM;IACnC;;OAEG;IACH,sBAAsB,MAAM;IAC5B;;OAEG;IACH,uBAAuB,MAAM;IAC7B;;OAEG;IACH,uBAAuB,MAAM;IAC7B;;OAEG;IACH,oBAAoB,MAAM;IAC1B;;OAEG;IACH,kBAAkB,MAAM;CACzB;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB;;OAEG;IACH,iBAAiB,IAAI;IACrB;;OAEG;IACH,eAAe,IAAI;IACnB;;OAEG;IACH,eAAe,IAAI;IACnB;;OAEG;IACH,kBAAkB,IAAI;CACvB;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,uBAAuB,IAAI;IAC3B;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,4BAA4B,IAAI;IAChC;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,wBAAwB,IAAI;IAC5B;;OAEG;IACH,sBAAsB,IAAI;IAC1B;;OAEG;IACH,qBAAqB,IAAI;IACzB;;OAEG;IACH,sBAAsB,KAAK;IAC3B;;OAEG;IACH,yBAAyB,KAAK;IAC9B;;OAEG;IACH,sBAAsB,KAAK;IAC3B;;OAEG;IACH,yBAAyB,KAAK;IAC9B;;OAEG;IACH,iCAAiC,KAAK;IACtC;;OAEG;IACH,gCAAgC,KAAK;IACrC;;OAEG;IACH,uBAAuB,KAAK;IAC5B;;OAEG;IACH,yBAAyB,KAAK;IAC9B;;OAEG;IACH,wBAAwB,KAAK;CAC9B;AAED;;GAEG;AACH,oBAAY,kBAAkB;IAC5B;;OAEG;IACH,uBAAuB,IAAI;IAC3B;;OAEG;IACH,0BAA0B,IAAI;IAC9B;;OAEG;IACH,uBAAuB,IAAI;CAC5B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,OAAO;IAClB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,oBAAY,uBAAuB;IACjC;;OAEG;IACH,yBAAyB,IAAI;IAC7B;;OAEG;IACH,qBAAqB,IAAI;CAC1B;AAED;;GAEG;AACH,qBAAa,eAAe;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,qBAAa,iBAAiB;IAC5B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB"}

package/types/Private/IAgoraLog.d.ts

@@ -1,80 +1,81 @@
-import './extension/IAgoraLogExtension';
-/**
- * The output log level of the SDK.
- */
-export declare enum LogLevel {
-    /**
-     * 0: Do not output any log information.
-     */
-    LogLevelNone = 0,
-    /**
-     * 0x0001: (Default) Output FATAL, ERROR, WARN, and INFO level log information. We recommend setting your log filter to this level.
-     */
-    LogLevelInfo = 1,
-    /**
-     * 0x0002: Output FATAL, ERROR, and WARN level log information.
-     */
-    LogLevelWarn = 2,
-    /**
-     * 0x0004: Output FATAL and ERROR level log information.
-     */
-    LogLevelError = 4,
-    /**
-     * 0x0008: Output FATAL level log information.
-     */
-    LogLevelFatal = 8,
-    /**
-     * @ignore
-     */
-    LogLevelApiCall = 16
-}
-/**
- * The output log level of the SDK.
- */
-export declare enum LogFilterType {
-    /**
-     * 0: Do not output any log information.
-     */
-    LogFilterOff = 0,
-    /**
-     * 0x080f: Output all log information. Set your log filter to this level if you want to get the most complete log file.
-     */
-    LogFilterDebug = 2063,
-    /**
-     * 0x000f: Output LogFilterCritical, LogFilterError, LogFilterWarn, and LogFilterInfo level log information. We recommend setting your log filter to this level.
-     */
-    LogFilterInfo = 15,
-    /**
-     * 0x000e: Output LogFilterCritical, LogFilterError, and LogFilterWarn level log information.
-     */
-    LogFilterWarn = 14,
-    /**
-     * 0x000c: Output LogFilterCritical and LogFilterError level log information.
-     */
-    LogFilterError = 12,
-    /**
-     * 0x0008: Output LogFilterCritical level log information.
-     */
-    LogFilterCritical = 8,
-    /**
-     * @ignore
-     */
-    LogFilterMask = 2063
-}
-/**
- * Configuration of Agora SDK log files.
- */
-export declare class LogConfig {
-    /**
-     * The complete path of the log files. Ensure that the path for the log file exists and is writable. You can use this parameter to rename the log files.The default file path is:macOSIf Sandbox is enabled: App~/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.If Sandbox is disabled: ~/Library/Logs/agorasdk.log.Windows：C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log。
-     */
-    filePath?: string;
-    /**
-     * The size (KB) of an agorasdk.log file. The value range is [128,1024]. The default value is 1,024 KB. If you set fileSizeInKByte to a value lower than 128 KB, the SDK adjusts it to 128 KB. If you set fileSizeInKBytes to a value higher than 1,024 KB, the SDK adjusts it to 1,024 KB.
-     */
-    fileSizeInKB?: number;
-    /**
-     * The output level of the SDK log file. See LogLevel .For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN.
-     */
-    level?: LogLevel;
-}
+import './extension/IAgoraLogExtension';
+/**
+ * The output log level of the SDK.
+ */
+export declare enum LogLevel {
+    /**
+     * 0: Do not output any log information.
+     */
+    LogLevelNone = 0,
+    /**
+     * 0x0001: (Default) Output FATAL, ERROR, WARN, and INFO level log information. We recommend setting your log filter to this level.
+     */
+    LogLevelInfo = 1,
+    /**
+     * 0x0002: Output FATAL, ERROR, and WARN level log information.
+     */
+    LogLevelWarn = 2,
+    /**
+     * 0x0004: Output FATAL and ERROR level log information.
+     */
+    LogLevelError = 4,
+    /**
+     * 0x0008: Output FATAL level log information.
+     */
+    LogLevelFatal = 8,
+    /**
+     * @ignore
+     */
+    LogLevelApiCall = 16
+}
+/**
+ * The output log level of the SDK.
+ */
+export declare enum LogFilterType {
+    /**
+     * 0: Do not output any log information.
+     */
+    LogFilterOff = 0,
+    /**
+     * 0x080f: Output all log information. Set your log filter to this level if you want to get the most complete log file.
+     */
+    LogFilterDebug = 2063,
+    /**
+     * 0x000f: Output LogFilterCritical, LogFilterError, LogFilterWarn, and LogFilterInfo level log information. We recommend setting your log filter to this level.
+     */
+    LogFilterInfo = 15,
+    /**
+     * 0x000e: Output LogFilterCritical, LogFilterError, and LogFilterWarn level log information.
+     */
+    LogFilterWarn = 14,
+    /**
+     * 0x000c: Output LogFilterCritical and LogFilterError level log information.
+     */
+    LogFilterError = 12,
+    /**
+     * 0x0008: Output LogFilterCritical level log information.
+     */
+    LogFilterCritical = 8,
+    /**
+     * @ignore
+     */
+    LogFilterMask = 2063
+}
+/**
+ * Configuration of Agora SDK log files.
+ */
+export declare class LogConfig {
+    /**
+     * The complete path of the log files. Ensure that the path for the log file exists and is writable. You can use this parameter to rename the log files.The default file path is:macOSIf Sandbox is enabled: App~/Library/Logs/agorasdk.log. For example, /Users/<username>/Library/Containers/<AppBundleIdentifier>/Data/Library/Logs/agorasdk.log.If Sandbox is disabled: ~/Library/Logs/agorasdk.log.Windows：C:\Users\<user_name>\AppData\Local\Agora\<process_name>\agorasdk.log。
+     */
+    filePath?: string;
+    /**
+     * The size (KB) of an agorasdk.log file. The value range is [128,1024]. The default value is 1,024 KB. If you set fileSizeInKByte to a value lower than 128 KB, the SDK adjusts it to 128 KB. If you set fileSizeInKBytes to a value higher than 1,024 KB, the SDK adjusts it to 1,024 KB.
+     */
+    fileSizeInKB?: number;
+    /**
+     * The output level of the SDK log file. See LogLevel .For example, if you set the log level to WARN, the SDK outputs the logs within levels FATAL, ERROR, and WARN.
+     */
+    level?: LogLevel;
+}
+//# sourceMappingURL=IAgoraLog.d.ts.map

package/types/Private/IAgoraLog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAgoraLog.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraLog.ts"],"names":[],"mappings":"AAAA,OAAO,gCAAgC,CAAC;AACxC;;GAEG;AACH,oBAAY,QAAQ;IAClB;;OAEG;IACH,YAAY,IAAS;IACrB;;OAEG;IACH,YAAY,IAAS;IACrB;;OAEG;IACH,YAAY,IAAS;IACrB;;OAEG;IACH,aAAa,IAAS;IACtB;;OAEG;IACH,aAAa,IAAS;IACtB;;OAEG;IACH,eAAe,KAAS;CACzB;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB;;OAEG;IACH,YAAY,IAAI;IAChB;;OAEG;IACH,cAAc,OAAS;IACvB;;OAEG;IACH,aAAa,KAAS;IACtB;;OAEG;IACH,aAAa,KAAS;IACtB;;OAEG;IACH,cAAc,KAAS;IACvB;;OAEG;IACH,iBAAiB,IAAS;IAC1B;;OAEG;IACH,aAAa,OAAQ;CACtB;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB"}

package/types/Private/IAgoraMediaEngine.d.ts

@@ -1,193 +1,184 @@
-import './extension/IAgoraMediaEngineExtension';
-import { IAudioFrameObserver, IVideoFrameObserver, IVideoEncodedFrameObserver, MediaSourceType, AudioFrame, ExternalVideoSourceType, ExternalVideoFrame } from './AgoraMediaBase';
-import { SenderOptions, EncodedVideoFrameInfo } from './AgoraBase';
-/**
- * The channel mode.
- */
-export declare enum AudioMixingDualMonoMode {
-    /**
-     * @ignore
-     */
-    AudioMixingDualMonoAuto = 0,
-    /**
-     * 1: Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.
-     */
-    AudioMixingDualMonoL = 1,
-    /**
-     * 2: Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.
-     */
-    AudioMixingDualMonoR = 2,
-    /**
-     * 3: Mixed channel mode. This mode mixes the audio of the left channel and the right channel, which means the user can hear the audio of the left channel and the right channel at the same time.
-     */
-    AudioMixingDualMonoMix = 3
-}
-/**
- * The IMediaEngine class.
- */
-export declare abstract class IMediaEngine {
-    /**
-     * Registers an audio frame observer object.
-     * Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger onMixedAudioFrame , onRecordAudioFrame , onPlaybackAudioFrame or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks.Ensure that you call this method before joining a channel.
-     *
-     * @param observer The observer object instance. See IAudioFrameObserver . Agora recommends calling this method after receiving onLeaveChannel to release the audio observer object.
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;
-    /**
-     * Registers a raw video frame observer object.
-     * If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:Call registerVideoFrameObserver to register the raw video frame observer before joining the channel.Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel.After joining the channel, get the user IDs of group B users through onUserJoined , and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true.Call muteAllRemoteVideoStreams (false) to start receiving the video streams of all remote users. Then:The raw video data of group A users can be obtained through the callback in IVideoFrameObserver , and the SDK renders the data by default.The encoded video data of group B users can be obtained through the callback in IVideoEncodedFrameObserver .If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one IVideoFrameObserver class with this method.When calling this method to register a video observer, you can register callbacks in the IVideoFrameObserver class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.Ensure that you call this method before joining a channel.When handling the video data returned in the callbacks, pay attention to the changes in the width and height parameters, which may be adapted under the following circumstances:When network conditions deteriorate, the video resolution decreases incrementally.If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
-     *
-     * @param observer The observer object instance. See IVideoFrameObserver .
-     */
-    abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;
-    /**
-     * Registers a receiver object for the encoded video image.
-     * If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one IVideoEncodedFrameObserver class through this method.If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:Call registerVideoFrameObserver to register the raw video frame observer before joining the channel.Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel.After joining the channel, get the user IDs of group B users through onUserJoined , and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true.Call muteAllRemoteVideoStreams (false) to start receiving the video streams of all remote users. Then:The raw video data of group A users can be obtained through the callback in IVideoFrameObserver , and the SDK renders the data by default.The encoded video data of group B users can be obtained through the callback in IVideoEncodedFrameObserver .Call this method before joining a channel.
-     *
-     * @param observer The video frame observer object. See IVideoEncodedFrameObserver .
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract registerVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number;
-    /**
-     * Pushes the external audio frame.
-     *
-     * @param type The type of the audio recording device. See MediaSourceType .
-     *
-     * @param frame The external audio frame. See AudioFrame .
-     *
-     * @param wrap Whether to use the placeholder. Agora recommends using the default value.true: Use the placeholder.false: (Default) Do not use the placeholder.
-     *
-     * @param sourceId The ID of external audio source. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract pushAudioFrame(type: MediaSourceType, frame: AudioFrame, wrap?: boolean, sourceId?: number): number;
-    /**
-     * @ignore
-     */
-    abstract pushCaptureAudioFrame(frame: AudioFrame): number;
-    /**
-     * @ignore
-     */
-    abstract pushReverseAudioFrame(frame: AudioFrame): number;
-    /**
-     * @ignore
-     */
-    abstract pushDirectAudioFrame(frame: AudioFrame): number;
-    /**
-     * Pulls the remote audio data.
-     * Before calling this method, you need to call setExternalAudioSink to notify the app to enable and set the external rendering.After a successful method call, the app pulls the decoded and mixed audio data for playback.This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.Call this method after joining a channel.Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.The difference between this method and the onPlaybackAudioFrame callback is as follows:The SDK sends the audio data to the app through the onPlaybackAudioFrame callback. Any delay in processing the audio frames may result in audio jitter.After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
-     */
-    abstract pullAudioFrame(): AudioFrame;
-    /**
-     * Configures the external video source.
-     * Call this method before joining a channel.
-     *
-     * @param enabled Whether to use the external video source:true: Use the external video source. The SDK prepares to accept the external video frame.false: (Default) Do not use the external video source.
-     *
-     * @param useTexture Whether to use the external video frame in the Texture format.true: Use the external video frame in the Texture format.false: (Default) Do not use the external video frame in the Texture format.
-     *
-     * @param sourceType Whether to encode the external video frame, see ExternalVideoSourceType .
-     *
-     * @param encodedVideoOption Video encoding options. This parameter needs to be set if sourceType is EncodedVideoFrame. To set this parameter, contact .
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract setExternalVideoSource(enabled: boolean, useTexture: boolean, sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions): number;
-    /**
-     * Sets the external captured audio parameters and chooses whether to publish the audio to the remote user.
-     * Call this method before joining a channel.
-     *
-     * @param enabled Whether to enable the external audio source:true: Enable the external audio source.false: (Default) Disable the external audio source.
-     *
-     * @param sampleRate The sample rate (Hz) of the external audio source, which can be set as 8000, 16000, 32000, 44100, or 48000.
-     *
-     * @param channels The number of channels of the external audio source, which can be set as 1 (Mono) or 2 (Stereo).
-     *
-     * @param sourceNumber The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In ChannelMediaOptions , you can set publishCustomAudioSourceId to the audio track ID you want to publish.
-     *
-     * @param localPlayback Whether to play the external audio source:true: Play the external audio source.false: (Default) Do not play the external source.
-     *
-     * @param publish Whether to publish audio to the remote users:true: (Default) Publish audio to the remote users.false: Do not publish audio to the remote users.
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract setExternalAudioSource(enabled: boolean, sampleRate: number, channels: number, sourceNumber?: number, localPlayback?: boolean, publish?: boolean): number;
-    /**
-     * Sets the external audio sink.
-     * This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
-     *
-     * @param enabled Whether to enable or disable the external audio sink:true: Enables the external audio sink.false: (Default) Disables the external audio sink.
-     *
-     * @param sampleRate The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
-     *
-     * @param channels The number of audio channels of the external audio sink:1: Mono.2: Stereo.
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract setExternalAudioSink(enabled: boolean, sampleRate: number, channels: number): number;
-    /**
-     * @ignore
-     */
-    abstract enableCustomAudioLocalPlayback(sourceId: number, enabled: boolean): number;
-    /**
-     * @ignore
-     */
-    abstract setDirectExternalAudioSource(enable: boolean, localPlayback?: boolean): number;
-    /**
-     * Pushes the external raw video frame to the SDK.
-     * To push the unencoded external raw video frame to the SDK, call createCustomVideoTrack to get the video track ID, set customVideoTrackId as the video track ID you want to publish in the ChannelMediaOptions of each channel, and set publishCustomVideoTrack as true.
-     *
-     * @param frame The external raw video frame to be pushed. See ExternalVideoFrame .
-     *
-     * @param videoTrackId The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract pushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: number): number;
-    /**
-     * @ignore
-     */
-    abstract pushEncodedVideoImage(imageBuffer: Uint8Array, length: number, videoEncodedFrameInfo: EncodedVideoFrameInfo, videoTrackId?: number): number;
-    /**
-     * @ignore
-     */
-    abstract release(): void;
-    /**
-     * Unregisters an audio frame observer.
-     *
-     * @param observer The audio frame observer, reporting the reception of each audio frame. See IAudioFrameObserver .
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number;
-    /**
-     * Unregisters the video frame observer.
-     *
-     * @param observer The video observer, reporting the reception of each video frame. See IVideoFrameObserver .
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number;
-    /**
-     * Unregisters a receiver object for the encoded video image.
-     *
-     * @param observer The video observer, reporting the reception of each video frame. See IVideoEncodedFrameObserver .
-     *
-     * @returns
-     * 0: Success.< 0: Failure.
-     */
-    abstract unregisterVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number;
-}
+import './extension/IAgoraMediaEngineExtension';
+import { AudioTrackConfig, AudioTrackType, EncodedVideoFrameInfo, SenderOptions } from './AgoraBase';
+import { AudioFrame, ExternalVideoFrame, ExternalVideoSourceType, IAudioFrameObserver, IVideoEncodedFrameObserver, IVideoFrameObserver } from './AgoraMediaBase';
+/**
+ * The channel mode.
+ */
+export declare enum AudioMixingDualMonoMode {
+    /**
+     * @ignore
+     */
+    AudioMixingDualMonoAuto = 0,
+    /**
+     * 1: Left channel mode. This mode replaces the audio of the right channel with the audio of the left channel, which means the user can only hear the audio of the left channel.
+     */
+    AudioMixingDualMonoL = 1,
+    /**
+     * 2: Right channel mode. This mode replaces the audio of the left channel with the audio of the right channel, which means the user can only hear the audio of the right channel.
+     */
+    AudioMixingDualMonoR = 2,
+    /**
+     * 3: Mixed channel mode. This mode mixes the audio of the left channel and the right channel, which means the user can hear the audio of the left channel and the right channel at the same time.
+     */
+    AudioMixingDualMonoMix = 3
+}
+/**
+ * The IMediaEngine class.
+ */
+export declare abstract class IMediaEngine {
+    /**
+     * Registers an audio frame observer object.
+     * Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger onMixedAudioFrame , onRecordAudioFrame , onPlaybackAudioFrame or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks.Ensure that you call this method before joining a channel.
+     *
+     * @param observer The observer object instance. See IAudioFrameObserver . Agora recommends calling this method after receiving onLeaveChannel to release the audio observer object.
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract registerAudioFrameObserver(observer: IAudioFrameObserver): number;
+    /**
+     * Registers a raw video frame observer object.
+     * If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:
+     *  Call registerVideoFrameObserver to register the raw video frame observer before joining the channel.
+     *  Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel.
+     *  After joining the channel, get the user IDs of group B users through onUserJoined , and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true.
+     *  Call muteAllRemoteVideoStreams (false) to start receiving the video streams of all remote users. Then:
+     *  The raw video data of group A users can be obtained through the callback in IVideoFrameObserver , and the SDK renders the data by default.
+     *  The encoded video data of group B users can be obtained through the callback in IVideoEncodedFrameObserver . If you want to observe raw video frames (such as YUV or RGBA format), Agora recommends that you implement one IVideoFrameObserver class with this method.When calling this method to register a video observer, you can register callbacks in the IVideoFrameObserver class as needed. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.Ensure that you call this method before joining a channel.When handling the video data returned in the callbacks, pay attention to the changes in the width and height parameters, which may be adapted under the following circumstances:When network conditions deteriorate, the video resolution decreases incrementally.If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
+     *
+     * @param observer The observer object instance. See IVideoFrameObserver .
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract registerVideoFrameObserver(observer: IVideoFrameObserver): number;
+    /**
+     * Registers a receiver object for the encoded video image.
+     * If you only want to observe encoded video frames (such as h.264 format) without decoding and rendering the video, Agora recommends that you implement one IVideoEncodedFrameObserver class through this method.If you want to obtain the original video data of some remote users (referred to as group A) and the encoded video data of other remote users (referred to as group B), you can refer to the following steps:Call registerVideoFrameObserver to register the raw video frame observer before joining the channel.Call registerVideoEncodedFrameObserver to register the encoded video frame observer before joining the channel.After joining the channel, get the user IDs of group B users through onUserJoined , and then call setRemoteVideoSubscriptionOptions to set the encodedFrameOnly of this group of users to true.Call muteAllRemoteVideoStreams (false) to start receiving the video streams of all remote users. Then:The raw video data of group A users can be obtained through the callback in IVideoFrameObserver , and the SDK renders the data by default.The encoded video data of group B users can be obtained through the callback in IVideoEncodedFrameObserver .Call this method before joining a channel.
+     *
+     * @param observer The video frame observer object. See IVideoEncodedFrameObserver .
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract registerVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number;
+    /**
+     * Pushes the external audio frame.
+     *
+     * @param type The type of the audio recording device. See MediaSourceType .
+     * @param frame The external audio frame. See AudioFrame .
+     * @param wrap Whether to use the placeholder. Agora recommends using the default value.true: Use the placeholder.false: (Default) Do not use the placeholder.
+     * @param sourceId The ID of external audio source. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract pushAudioFrame(frame: AudioFrame, trackId?: number): number;
+    /**
+     * Pulls the remote audio data.
+     * Before calling this method, you need to call setExternalAudioSink to notify the app to enable and set the external rendering.After a successful method call, the app pulls the decoded and mixed audio data for playback.This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.Call this method after joining a channel.Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.The difference between this method and the onPlaybackAudioFrame callback is as follows:The SDK sends the audio data to the app through the onPlaybackAudioFrame callback. Any delay in processing the audio frames may result in audio jitter.After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
+     *
+     * @returns
+     * The AudioFrame instance, if the method call succeeds.An error code, if the call fails,.
+     */
+    abstract pullAudioFrame(): AudioFrame;
+    /**
+     * Configures the external video source.
+     * Call this method before joining a channel.
+     *
+     * @param enabled Whether to use the external video source:true: Use the external video source. The SDK prepares to accept the external video frame.false: (Default) Do not use the external video source.
+     * @param useTexture Whether to use the external video frame in the Texture format.true: Use the external video frame in the Texture format.false: (Default) Do not use the external video frame in the Texture format.
+     * @param sourceType Whether the external video frame is encoded. See ExternalVideoSourceType .
+     * @param encodedVideoOption Video encoding options. This parameter needs to be set if sourceType is EncodedVideoFrame. To set this parameter, contact .
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract setExternalVideoSource(enabled: boolean, useTexture: boolean, sourceType?: ExternalVideoSourceType, encodedVideoOption?: SenderOptions): number;
+    /**
+     * Sets the external audio source parameters.
+     * Call this method before joining a channel.
+     *
+     * @param enabled Whether to enable the external audio source:true: Enable the external audio source.false: (Default) Disable the external audio source.
+     * @param sampleRate The sample rate (Hz) of the external audio which can be set as 8000, 16000, 32000, 44100, or 48000.
+     * @param channels The number of channels of the external audio source, which can be set as 1 (Mono) or 2 (Stereo).
+     * @param sourceNumber The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In ChannelMediaOptions , you can set publishCustomAudioSourceId to the audio track ID you want to publish.
+     * @param localPlayback Whether to play the external audio source:true: Play the external audio source.false: (Default) Do not play the external source.
+     * @param publish Whether to publish audio to the remote users:true: (Default) Publish audio to the remote users.false: Do not publish audio to the remote users.
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract setExternalAudioSource(enabled: boolean, sampleRate: number, channels: number, localPlayback?: boolean, publish?: boolean): number;
+    /**
+     * @ignore
+     */
+    abstract createCustomAudioTrack(trackType: AudioTrackType, config: AudioTrackConfig): number;
+    /**
+     * @ignore
+     */
+    abstract destroyCustomAudioTrack(trackId: number): number;
+    /**
+     * Sets the external audio sink.
+     * This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call pullAudioFrame to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
+     *
+     * @param enabled Whether to enable or disable the external audio sink:true: Enables the external audio sink.false: (Default) Disables the external audio sink.
+     * @param sampleRate The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
+     * @param channels The number of audio channels of the external audio sink:1: Mono.2: Stereo.
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract setExternalAudioSink(enabled: boolean, sampleRate: number, channels: number): number;
+    /**
+     * @ignore
+     */
+    abstract enableCustomAudioLocalPlayback(trackId: number, enabled: boolean): number;
+    /**
+     * Pushes the external raw video frame to the SDK.
+     * If you call createCustomVideoTrack method to get the video track ID, set the customVideoTrackId parameter to the video track ID you want to publish in the ChannelMediaOptions of each channel, and set the publishCustomVideoTrack parameter to true, you can call this method to push the unencoded external video frame to the SDK.
+     *
+     * @param frame The external raw video frame to be pushed. See ExternalVideoFrame .
+     * @param videoTrackId The video track ID returned by calling the createCustomVideoTrack method. The default value is 0.
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract pushVideoFrame(frame: ExternalVideoFrame, videoTrackId?: number): number;
+    /**
+     * @ignore
+     */
+    abstract pushEncodedVideoImage(imageBuffer: Uint8Array, length: number, videoEncodedFrameInfo: EncodedVideoFrameInfo, videoTrackId?: number): number;
+    /**
+     * @ignore
+     */
+    abstract release(): void;
+    /**
+     * Unregisters an audio frame observer.
+     *
+     * @param observer The audio frame observer, reporting the reception of each audio frame. See IAudioFrameObserver .
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract unregisterAudioFrameObserver(observer: IAudioFrameObserver): number;
+    /**
+     * Unregisters the video frame observer.
+     *
+     * @param observer The video observer, reporting the reception of each video frame. See IVideoFrameObserver .
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract unregisterVideoFrameObserver(observer: IVideoFrameObserver): number;
+    /**
+     * Unregisters a receiver object for the encoded video image.
+     *
+     * @param observer The video observer, reporting the reception of each video frame. See IVideoEncodedFrameObserver .
+     *
+     * @returns
+     * 0: Success.< 0: Failure.
+     */
+    abstract unregisterVideoEncodedFrameObserver(observer: IVideoEncodedFrameObserver): number;
+}
+//# sourceMappingURL=IAgoraMediaEngine.d.ts.map

package/types/Private/IAgoraMediaEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"IAgoraMediaEngine.d.ts","sourceRoot":"","sources":["../../ts/Private/IAgoraMediaEngine.ts"],"names":[],"mappings":"AAAA,OAAO,wCAAwC,CAAC;AAChD,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,aAAa,EACd,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,mBAAmB,EACnB,0BAA0B,EAC1B,mBAAmB,EACpB,MAAM,kBAAkB,CAAC;AAE1B;;GAEG;AACH,oBAAY,uBAAuB;IACjC;;OAEG;IACH,uBAAuB,IAAI;IAC3B;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,oBAAoB,IAAI;IACxB;;OAEG;IACH,sBAAsB,IAAI;CAC3B;AAED;;GAEG;AACH,8BAAsB,YAAY;IAChC;;;;;;;;OAQG;IACH,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM;IAE1E;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CAAC,0BAA0B,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM;IAE1E;;;;;;;;OAQG;IACH,QAAQ,CAAC,iCAAiC,CACxC,QAAQ,EAAE,0BAA0B,GACnC,MAAM;IAET;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAEpE;;;;;;OAMG;IACH,QAAQ,CAAC,cAAc,IAAI,UAAU;IAErC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,OAAO,EACnB,UAAU,CAAC,EAAE,uBAAuB,EACpC,kBAAkB,CAAC,EAAE,aAAa,GACjC,MAAM;IAET;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,EAChB,aAAa,CAAC,EAAE,OAAO,EACvB,OAAO,CAAC,EAAE,OAAO,GAChB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,sBAAsB,CAC7B,SAAS,EAAE,cAAc,EACzB,MAAM,EAAE,gBAAgB,GACvB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,uBAAuB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;IAEzD;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,oBAAoB,CAC3B,OAAO,EAAE,OAAO,EAChB,UAAU,EAAE,MAAM,EAClB,QAAQ,EAAE,MAAM,GACf,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,8BAA8B,CACrC,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,OAAO,GACf,MAAM;IAET;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,CACrB,KAAK,EAAE,kBAAkB,EACzB,YAAY,CAAC,EAAE,MAAM,GACpB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,qBAAqB,CAC5B,WAAW,EAAE,UAAU,EACvB,MAAM,EAAE,MAAM,EACd,qBAAqB,EAAE,qBAAqB,EAC5C,YAAY,CAAC,EAAE,MAAM,GACpB,MAAM;IAET;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,IAAI;IAExB;;;;;;;OAOG;IACH,QAAQ,CAAC,4BAA4B,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM;IAE5E;;;;;;;OAOG;IACH,QAAQ,CAAC,4BAA4B,CAAC,QAAQ,EAAE,mBAAmB,GAAG,MAAM;IAE5E;;;;;;;OAOG;IACH,QAAQ,CAAC,mCAAmC,CAC1C,QAAQ,EAAE,0BAA0B,GACnC,MAAM;CACV"}