agora-electron-sdk 4.2.0-dev.5 → 4.2.0-dev.8

package/js/Private/AgoraMediaBase.d.ts

@@ -1,1124 +0,0 @@
-import './extension/AgoraMediaBaseExtension';
-import { EncodedVideoFrameInfo } from './AgoraBase';
-/**
- * The capture type of the custom video source.
- */
-export declare enum VideoSourceType {
-    /**
-     * @ignore
-     */
-    VideoSourceCameraPrimary = 0,
-    /**
-     * The camera.
-     */
-    VideoSourceCamera = 0,
-    /**
-     * The secondary camera.
-     */
-    VideoSourceCameraSecondary = 1,
-    /**
-     * The primary screen.
-     */
-    VideoSourceScreenPrimary = 2,
-    /**
-     * The screen.
-     */
-    VideoSourceScreen = 2,
-    /**
-     * The secondary screen.
-     */
-    VideoSourceScreenSecondary = 3,
-    /**
-     * The custom video source.
-     */
-    VideoSourceCustom = 4,
-    /**
-     * The video source from the media player.
-     */
-    VideoSourceMediaPlayer = 5,
-    /**
-     * The video source is a PNG image.
-     */
-    VideoSourceRtcImagePng = 6,
-    /**
-     * The video source is a JPEG image.
-     */
-    VideoSourceRtcImageJpeg = 7,
-    /**
-     * The video source is a GIF image.
-     */
-    VideoSourceRtcImageGif = 8,
-    /**
-     * The video source is remote video acquired by the network.
-     */
-    VideoSourceRemote = 9,
-    /**
-     * A transcoded video source.
-     */
-    VideoSourceTranscoded = 10,
-    /**
-     * @ignore
-     */
-    VideoSourceCameraThird = 11,
-    /**
-     * @ignore
-     */
-    VideoSourceCameraFourth = 12,
-    /**
-     * @ignore
-     */
-    VideoSourceScreenThird = 13,
-    /**
-     * @ignore
-     */
-    VideoSourceScreenFourth = 14,
-    /**
-     * An unknown video source.
-     */
-    VideoSourceUnknown = 100
-}
-/**
- * The type of the audio route.
- */
-export declare enum AudioRoute {
-    /**
-     * -1: The default audio route.
-     */
-    RouteDefault = -1,
-    /**
-     * 0: Audio output routing is a headset with microphone.
-     */
-    RouteHeadset = 0,
-    /**
-     * 1: The audio route is an earpiece.
-     */
-    RouteEarpiece = 1,
-    /**
-     * 2: The audio route is a headset without a microphone.
-     */
-    RouteHeadsetnomic = 2,
-    /**
-     * 3: The audio route is the speaker that comes with the device.
-     */
-    RouteSpeakerphone = 3,
-    /**
-     * 4: The audio route is an external speaker. (macOS only)
-     */
-    RouteLoudspeaker = 4,
-    /**
-     * @ignore
-     */
-    RouteHeadsetbluetooth = 5,
-    /**
-     * 7: The audio route is a USB peripheral device. (For macOS only)
-     */
-    RouteUsb = 6,
-    /**
-     * 6: The audio route is an HDMI peripheral device. (For macOS only)
-     */
-    RouteHdmi = 7,
-    /**
-     * 8: The audio route is a DisplayPort peripheral device. (For macOS only)
-     */
-    RouteDisplayport = 8,
-    /**
-     * 9: The audio route is Apple AirPlay. (For macOS only)
-     */
-    RouteAirplay = 9
-}
-/**
- * @ignore
- */
-export declare enum BytesPerSample {
-    /**
-     * @ignore
-     */
-    TwoBytesPerSample = 2
-}
-/**
- * @ignore
- */
-export declare class AudioParameters {
-    /**
-     * @ignore
-     */
-    sample_rate?: number;
-    /**
-     * @ignore
-     */
-    channels?: number;
-    /**
-     * @ignore
-     */
-    frames_per_buffer?: number;
-}
-/**
- * The use mode of the audio data.
- */
-export declare enum RawAudioFrameOpModeType {
-    /**
-     * 0: Read-only mode, Users only read the data returned by the SDK without modifying anything. For example, when users acquire the data with the Agora SDK, then start the media push.
-     */
-    RawAudioFrameOpModeReadOnly = 0,
-    /**
-     * 2: Read and write mode, Users read the data returned by the SDK, modify it, and then play it. For example, when users have their own audio-effect processing module and perform some voice preprocessing, such as a voice change.
-     */
-    RawAudioFrameOpModeReadWrite = 2
-}
-/**
- * Media source type.
- */
-export declare enum MediaSourceType {
-    /**
-     * 0: Audio playback device.
-     */
-    AudioPlayoutSource = 0,
-    /**
-     * 1: Audio capturing device.
-     */
-    AudioRecordingSource = 1,
-    /**
-     * 2: The primary camera.
-     */
-    PrimaryCameraSource = 2,
-    /**
-     * 3: The secondary camera.
-     */
-    SecondaryCameraSource = 3,
-    /**
-     * @ignore
-     */
-    PrimaryScreenSource = 4,
-    /**
-     * @ignore
-     */
-    SecondaryScreenSource = 5,
-    /**
-     * @ignore
-     */
-    CustomVideoSource = 6,
-    /**
-     * @ignore
-     */
-    MediaPlayerSource = 7,
-    /**
-     * @ignore
-     */
-    RtcImagePngSource = 8,
-    /**
-     * @ignore
-     */
-    RtcImageJpegSource = 9,
-    /**
-     * @ignore
-     */
-    RtcImageGifSource = 10,
-    /**
-     * @ignore
-     */
-    RemoteVideoSource = 11,
-    /**
-     * @ignore
-     */
-    TranscodedVideoSource = 12,
-    /**
-     * 100: Unknown media source.
-     */
-    UnknownMediaSource = 100
-}
-/**
- * @ignore
- */
-export declare enum ContentInspectResult {
-    /**
-     * @ignore
-     */
-    ContentInspectNeutral = 1,
-    /**
-     * @ignore
-     */
-    ContentInspectSexy = 2,
-    /**
-     * @ignore
-     */
-    ContentInspectPorn = 3
-}
-/**
- * The type of video content moderation module.
- */
-export declare enum ContentInspectType {
-    /**
-     * 0: (Default) This module has no actual function. Do not set type to this value.
-     */
-    ContentInspectInvalid = 0,
-    /**
-     * 1: Video content moderation. SDK takes screenshots, inspects video content of the video stream in the channel, and uploads the screenshots and moderation results.
-     */
-    ContentInspectModeration = 1,
-    /**
-     * @ignore
-     */
-    ContentInspectSupervision = 2
-}
-/**
- * A structure used to configure the frequency of video screenshot and upload.ContentInspectModule
- */
-export declare class ContentInspectModule {
-    /**
-     * Types of functional module. See ContentInspectType .
-     */
-    type?: ContentInspectType;
-    /**
-     * The frequency (s) of video screenshot and upload. The value should be set as larger than 0. The default value is 0, the SDK does not take screenshots. Agora recommends that you set the value as 10; you can also adjust it according to your business needs.
-     */
-    interval?: number;
-}
-/**
- * Configuration of video screenshot and upload.
- */
-export declare class ContentInspectConfig {
-    /**
-     * Additional information on the video content (maximum length: 1024 Bytes).The SDK sends the screenshots and additional information on the video content to the Agora server. Once the video screenshot and upload process is completed, the Agora server sends the additional information and the callback notification to your server.
-     */
-    extraInfo?: string;
-    /**
-     * Functional module. See ContentInspectModule .A maximum of 32 ContentInspectModule instances can be configured, and the value range of MAX_CONTENT_INSPECT_MODULE_COUNT is an integer in [1,32].A function module can only be configured with one instance at most. Currently only the video screenshot and upload function is supported.
-     */
-    modules?: ContentInspectModule[];
-    /**
-     * The number of functional modules, that is,the number of configured ContentInspectModule instances, must be the same as the number of instances configured in modules. The maximum number is 32.
-     */
-    moduleCount?: number;
-}
-/**
- * @ignore
- */
-export declare class PacketOptions {
-    /**
-     * @ignore
-     */
-    timestamp?: number;
-    /**
-     * @ignore
-     */
-    audioLevelIndication?: number;
-}
-/**
- * @ignore
- */
-export declare class AudioEncodedFrameInfo {
-    /**
-     * @ignore
-     */
-    sendTs?: number;
-    /**
-     * @ignore
-     */
-    codec?: number;
-}
-/**
- * The parameters of the audio frame in PCM format.
- */
-export declare class AudioPcmFrame {
-    /**
-     * The timestamp (ms) of the audio frame.
-     */
-    capture_timestamp?: number;
-    /**
-     * The number of samples per channel in the audio frame.
-     */
-    samples_per_channel_?: number;
-    /**
-     * Audio sample rate (Hz).
-     */
-    sample_rate_hz_?: number;
-    /**
-     * The number of audio channels.
-     */
-    num_channels_?: number;
-    /**
-     * The number of bytes per sample.
-     */
-    bytes_per_sample?: BytesPerSample;
-    /**
-     * The video frame.
-     */
-    data_?: number[];
-}
-/**
- * The channel mode.
- */
-export declare enum AudioDualMonoMode {
-    /**
-     * 0: Original mode.
-     */
-    AudioDualMonoStereo = 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.
-     */
-    AudioDualMonoL = 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.
-     */
-    AudioDualMonoR = 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.
-     */
-    AudioDualMonoMix = 3
-}
-/**
- * The video pixel format.
- */
-export declare enum VideoPixelFormat {
-    /**
-     * 0: Raw video pixel format.
-     */
-    VideoPixelDefault = 0,
-    /**
-     * 1: The format is I420.
-     */
-    VideoPixelI420 = 1,
-    /**
-     * @ignore
-     */
-    VideoPixelBgra = 2,
-    /**
-     * @ignore
-     */
-    VideoPixelNv21 = 3,
-    /**
-     * 4: The format is RGBA.
-     */
-    VideoPixelRgba = 4,
-    /**
-     * 8: The format is NV12.
-     */
-    VideoPixelNv12 = 8,
-    /**
-     * @ignore
-     */
-    VideoTexture2d = 10,
-    /**
-     * @ignore
-     */
-    VideoTextureOes = 11,
-    /**
-     * @ignore
-     */
-    VideoCvpixelNv12 = 12,
-    /**
-     * @ignore
-     */
-    VideoCvpixelI420 = 13,
-    /**
-     * @ignore
-     */
-    VideoCvpixelBgra = 14,
-    /**
-     * 16: The format is I422.
-     */
-    VideoPixelI422 = 16
-}
-/**
- * Video display modes.
- */
-export declare enum RenderModeType {
-    /**
-     * 1: Hidden mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). One dimension of the video may have clipped contents.
-     */
-    RenderModeHidden = 1,
-    /**
-     * 2: Fit mode. Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit). Areas that are not filled due to disparity in the aspect ratio are filled with black.
-     */
-    RenderModeFit = 2,
-    /**
-     * @ignore
-     */
-    RenderModeAdaptive = 3
-}
-/**
- * @ignore
- */
-export declare enum CameraVideoSourceType {
-    /**
-     * @ignore
-     */
-    CameraSourceFront = 0,
-    /**
-     * @ignore
-     */
-    CameraSourceBack = 1,
-    /**
-     * @ignore
-     */
-    VideoSourceUnspecified = 2
-}
-/**
- * @ignore
- */
-export declare enum EglContextType {
-    /**
-     * @ignore
-     */
-    EglContext10 = 0,
-    /**
-     * @ignore
-     */
-    EglContext14 = 1
-}
-/**
- * The video buffer type.
- */
-export declare enum VideoBufferType {
-    /**
-     * 1: The video buffer in the format of raw data.
-     */
-    VideoBufferRawData = 1,
-    /**
-     * 2: The video buffer in the format of raw data.
-     */
-    VideoBufferArray = 2,
-    /**
-     * 3: The video buffer in the format of Texture.
-     */
-    VideoBufferTexture = 3
-}
-/**
- * The external video frame.
- */
-export declare class ExternalVideoFrame {
-    /**
-     * The video type. See VideoBufferType .
-     */
-    type?: VideoBufferType;
-    /**
-     * The pixel format. See VideoPixelFormat .
-     */
-    format?: VideoPixelFormat;
-    /**
-     * Video frame buffer.
-     */
-    buffer?: Uint8Array;
-    /**
-     * Line spacing of the incoming video frame, which must be in pixels instead of bytes. For textures, it is the width of the texture.
-     */
-    stride?: number;
-    /**
-     * Height of the incoming video frame.
-     */
-    height?: number;
-    /**
-     * Raw data related parameter. The number of pixels trimmed from the left. The default value is 0.
-     */
-    cropLeft?: number;
-    /**
-     * Raw data related parameter. The number of pixels trimmed from the top. The default value is 0.
-     */
-    cropTop?: number;
-    /**
-     * Raw data related parameter. The number of pixels trimmed from the right. The default value is 0.
-     */
-    cropRight?: number;
-    /**
-     * Raw data related parameter. The number of pixels trimmed from the bottom. The default value is 0.
-     */
-    cropBottom?: number;
-    /**
-     * Raw data related parameter. The clockwise rotation of the video frame. You can set the rotation angle as 0, 90, 180, or 270. The default value is 0.
-     */
-    rotation?: number;
-    /**
-     * Timestamp (ms) of the incoming video frame. An incorrect timestamp results in frame loss or unsynchronized audio and video.
-     */
-    timestamp?: number;
-    /**
-     * This parameter only applies to video data in Texture format. Texture ID of the frame.
-     */
-    eglType?: EglContextType;
-    /**
-     * This parameter only applies to video data in Texture format. Incoming 4 x 4 transformational matrix. The typical value is a unit matrix.
-     */
-    textureId?: number;
-    /**
-     * This parameter only applies to video data in Texture format. Incoming 4 x 4 transformational matrix. The typical value is a unit matrix.
-     */
-    matrix?: number[];
-    /**
-     * This parameter only applies to video data in Texture format. The MetaData buffer. The default value is NULL.
-     */
-    metadata_buffer?: Uint8Array;
-    /**
-     * This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.
-     */
-    metadata_size?: number;
-    /**
-     * @ignore
-     */
-    alphaBuffer?: Uint8Array;
-}
-/**
- * Configurations of the video frame.
- * Note that the buffer provides a pointer to a pointer. This interface cannot modify the pointer of the buffer, but it can modify the content of the buffer.
- */
-export declare class VideoFrame {
-    /**
-     * The pixel format. See VideoPixelFormat .
-     */
-    type?: VideoPixelFormat;
-    /**
-     * The width of the video, in pixels.
-     */
-    width?: number;
-    /**
-     * The height of the video, in pixels.
-     */
-    height?: number;
-    /**
-     * For YUV data, the line span of the Y buffer; for RGBA data, the total data length.
-     */
-    yStride?: number;
-    /**
-     * For YUV data, the line span of the U buffer; for RGBA data, the value is 0.
-     */
-    uStride?: number;
-    /**
-     * For YUV data, the line span of the V buffer; for RGBA data, the value is 0.
-     */
-    vStride?: number;
-    /**
-     * For YUV data, the pointer to the Y buffer; for RGBA data, the data buffer.
-     */
-    yBuffer?: Uint8Array;
-    /**
-     * For YUV data, the pointer to the U buffer; for RGBA data, the value is 0.
-     */
-    uBuffer?: Uint8Array;
-    /**
-     * For YUV data, the pointer to the V buffer; for RGBA data, the value is 0.
-     */
-    vBuffer?: Uint8Array;
-    /**
-     * The clockwise rotation of the video frame before rendering. Supported values include 0, 90, 180, and 270 degrees.
-     */
-    rotation?: number;
-    /**
-     * The Unix timestamp (ms) when the video frame is rendered. This timestamp can be used to guide the rendering of the video frame. It is required.
-     */
-    renderTimeMs?: number;
-    /**
-     * Reserved for future use.
-     */
-    avsync_type?: number;
-    /**
-     * This parameter only applies to video data in Texture format. The MetaData buffer. The default value is NULL.
-     */
-    metadata_buffer?: Uint8Array;
-    /**
-     * This parameter only applies to video data in Texture format. The MetaData size. The default value is 0.
-     */
-    metadata_size?: number;
-    /**
-     * This parameter only applies to video data in Texture format. Texture ID.
-     */
-    textureId?: number;
-    /**
-     * This parameter only applies to video data in Texture format. Incoming 4 × 4 transformational matrix. The typical value is a unit matrix.
-     */
-    matrix?: number[];
-    /**
-     * @ignore
-     */
-    alphaBuffer?: Uint8Array;
-    /**
-     * @ignore
-     */
-    pixelBuffer?: Uint8Array;
-}
-/**
- * @ignore
- */
-export declare enum MediaPlayerSourceType {
-    /**
-     * @ignore
-     */
-    MediaPlayerSourceDefault = 0,
-    /**
-     * @ignore
-     */
-    MediaPlayerSourceFullFeatured = 1,
-    /**
-     * @ignore
-     */
-    MediaPlayerSourceSimple = 2
-}
-/**
- * The frame position of the video observer.
- */
-export declare enum VideoModulePosition {
-    /**
-     * 1: The post-capturer position, which corresponds to the video data in the onCaptureVideoFrame callback.
-     */
-    PositionPostCapturer = 1,
-    /**
-     * 2: The pre-renderer position, which corresponds to the video data in the onRenderVideoFrame callback.
-     */
-    PositionPreRenderer = 2,
-    /**
-     * 4: The pre-encoder position, which corresponds to the video data in the onPreEncodeVideoFrame callback.
-     */
-    PositionPreEncoder = 4
-}
-/**
- * @ignore
- */
-export interface IAudioPcmFrameSink {
-    /**
-     * Occurs each time the player receives a video frame.
-     * After registering the video frame observer, the callback occurs every time the player receives a video frame, reporting the detailed information of the video frame.
-     *
-     * @param frame Video frame information. See VideoFrame .
-     */
-    onFrame?(frame: AudioPcmFrame): void;
-}
-/**
- * Audio frame type.
- */
-export declare enum AudioFrameType {
-    /**
-     * 0: PCM 16
-     */
-    FrameTypePcm16 = 0
-}
-/**
- * Raw audio data.
- */
-export declare class AudioFrame {
-    /**
-     * The type of the audio frame. See AudioFrameType .
-     */
-    type?: AudioFrameType;
-    /**
-     * The number of samples per channel in the audio frame.
-     */
-    samplesPerChannel?: number;
-    /**
-     * The number of bytes per audio sample, which is usually 16-bit (2 bytes).
-     */
-    bytesPerSample?: BytesPerSample;
-    /**
-     * The number of audio channels (the data are interleaved if it is stereo).1: Mono.2: Stereo.
-     */
-    channels?: number;
-    /**
-     * The number of samples per channel in the audio frame.
-     */
-    samplesPerSec?: number;
-    /**
-     * The data buffer of the audio frame. When the audio frame uses a stereo channel, the data buffer is interleaved.The size of the data buffer is as follows: buffer = samples ×channels × bytesPerSample.
-     */
-    buffer?: Uint8Array;
-    /**
-     * The timestamp (ms) of the external audio frame.You can use this timestamp to restore the order of the captured audio frame, and synchronize audio and video frames in video scenarios, including scenarios where external video sources are used.
-     */
-    renderTimeMs?: number;
-    /**
-     * Reserved for future use.
-     */
-    avsync_type?: number;
-}
-/**
- * @ignore
- */
-export declare enum AudioFramePosition {
-    /**
-     * @ignore
-     */
-    AudioFramePositionNone = 0,
-    /**
-     * @ignore
-     */
-    AudioFramePositionPlayback = 1,
-    /**
-     * @ignore
-     */
-    AudioFramePositionRecord = 2,
-    /**
-     * @ignore
-     */
-    AudioFramePositionMixed = 4,
-    /**
-     * @ignore
-     */
-    AudioFramePositionBeforeMixing = 8,
-    /**
-     * @ignore
-     */
-    AudioFramePositionEarMonitoring = 16
-}
-/**
- * Audio data format.
- * The SDK sets the audio data format in the following callbacks according to AudioParams. onRecordAudioFrame onPlaybackAudioFrame onMixedAudioFrame The SDK calculates the sampling interval through the samplesPerCall, sampleRate, and channel parameters in AudioParams, and triggers the onRecordAudioFrame, onPlaybackAudioFrame, onMixedAudioFrame, and onEarMonitoringAudioFrame callbacks according to the sampling interval.Sample interval (sec) = samplePerCall/(sampleRate × channel).Ensure that the sample interval ≥ 0.01 (s).
- */
-export declare class AudioParams {
-    /**
-     * The audio sample rate (Hz), which can be set as one of the following values:8000.(Default) 16000.32000.4410048000
-     */
-    sample_rate?: number;
-    /**
-     * The number of audio channels, which can be set as either of the following values:1: (Default) Mono.2: Stereo.
-     */
-    channels?: number;
-    /**
-     * The use mode of the audio data. See RawAudioFrameOpModeType .
-     */
-    mode?: RawAudioFrameOpModeType;
-    /**
-     * The number of samples, such as 1024 for the media push.
-     */
-    samples_per_call?: number;
-}
-/**
- * The audio frame observer.
- */
-export interface IAudioFrameObserverBase {
-    /**
-     * Gets the raw audio frame for playback.
-     * To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.
-     *
-     * @param channelId The channel ID.
-     * @param audioFrame The raw audio data. See AudioFrame .
-     *
-     * @returns
-     * Reserved for future use.
-     */
-    onRecordAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean;
-    /**
-     * Gets the raw audio frame for playback.
-     * To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.
-     *
-     * @param channelId The channel ID.
-     * @param audioFrame The raw audio data. See AudioFrame .
-     *
-     * @returns
-     * Reserved for future use.
-     */
-    onPlaybackAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean;
-    /**
-     * Gets the raw audio frame for playback.
-     * To ensure that the data format of audio frame for playback is as expected, Agora recommends that you set the audio data format as follows: After calling setPlaybackAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onPlaybackAudioFrame callback according to the sampling interval.
-     *
-     * @param channelId The channel ID.
-     * @param audioFrame The raw audio data. See AudioFrame .
-     *
-     * @returns
-     * Reserved for future use.
-     */
-    onMixedAudioFrame?(channelId: string, audioFrame: AudioFrame): boolean;
-    /**
-     * Gets the in-ear monitoring audio frame.
-     * In order to ensure that the obtained in-ear audio data meets the expectations, Agora recommends that you set the in-ear monitoring-ear audio data format as follows: After calling setEarMonitoringAudioFrameParameters to set the audio data format and registerAudioFrameObserver to register the audio frame observer object, the SDK calculates the sampling interval according to the parameters set in the methods, and triggers the onEarMonitoringAudioFrame callback according to the sampling interval.
-     *
-     * @returns
-     * Reserved for future use.
-     */
-    onEarMonitoringAudioFrame?(audioFrame: AudioFrame): boolean;
-}
-/**
- * The audio frame observer.
- */
-export interface IAudioFrameObserver extends IAudioFrameObserverBase {
-    /**
-     * Retrieves the audio frame of a specified user before mixing.
-     *
-     * @param channelId The channel ID.
-     * @param uid The user ID of the specified user.
-     * @param audioFrame The raw audio data. See AudioFrame .
-     *
-     * @returns
-     * Reserved for future use.
-     */
-    onPlaybackAudioFrameBeforeMixing?(channelId: string, uid: number, audioFrame: AudioFrame): boolean;
-}
-/**
- * The audio spectrum data.
- */
-export declare class AudioSpectrumData {
-    /**
-     * The audio spectrum data. Agora divides the audio frequency into 256 frequency domains, and reports the energy value of each frequency domain through this parameter. The value range of each energy type is [-300, 1] and the unit is dBFS.
-     */
-    audioSpectrumData?: number[];
-    /**
-     * The audio spectrum data length is 256.
-     */
-    dataLength?: number;
-}
-/**
- * Audio spectrum information of the remote user.
- */
-export declare class UserAudioSpectrumInfo {
-    /**
-     * The user ID of the remote user.
-     */
-    uid?: number;
-    /**
-     * Audio spectrum information of the remote user.See AudioSpectrumData .
-     */
-    spectrumData?: AudioSpectrumData;
-}
-/**
- * The audio spectrum observer.
- */
-export interface IAudioSpectrumObserver {
-    /**
-     * Gets the statistics of a local audio spectrum.
-     * After successfully calling registerAudioSpectrumObserver to implement the onLocalAudioSpectrumcallback in IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
-     *
-     * @param data The audio spectrum data of the local user. See AudioSpectrumData .
-     *
-     * @returns
-     * Whether the spectrum data is received:true: Spectrum data is received.false: No spectrum data is received.
-     */
-    onLocalAudioSpectrum?(data: AudioSpectrumData): boolean;
-    /**
-     * Gets the remote audio spectrum.
-     * After successfully calling registerAudioSpectrumObserver to implement the onRemoteAudioSpectrum callback in the IAudioSpectrumObserver and calling enableAudioSpectrumMonitor to enable audio spectrum monitoring, the SDK will trigger the callback as the time interval you set to report the received remote audio data spectrum.
-     *
-     * @param spectrums The audio spectrum information of the remote user, see UserAudioSpectrumInfo . The number of arrays is the number of remote users monitored by the SDK. If the array is null, it means that no audio spectrum of remote users is detected.
-     * @param spectrumNumber The number of remote users.
-     *
-     * @returns
-     * Whether the spectrum data is received:true: Spectrum data is received.false: No spectrum data is received.
-     */
-    onRemoteAudioSpectrum?(spectrums: UserAudioSpectrumInfo[], spectrumNumber: number): boolean;
-}
-/**
- * Receives encoded video images.
- */
-export interface IVideoEncodedFrameObserver {
-    /**
-     * Reports that the receiver has received the to-be-decoded video frame sent by the remote end.
-     * If you call the setRemoteVideoSubscriptionOptions method and set encodedFrameOnly to true, the SDK triggers this callback locally to report the received encoded video frame information.
-     *
-     * @param uid The user ID of the remote user.
-     * @param imageBuffer The encoded video image buffer.
-     * @param length The data length of the video image.
-     * @param videoEncodedFrameInfo For the information of the encoded video frame, see EncodedVideoFrameInfo .
-     *
-     * @returns
-     * Reserved for future use.
-     */
-    onEncodedVideoFrameReceived?(uid: number, imageBuffer: Uint8Array, length: number, videoEncodedFrameInfo: EncodedVideoFrameInfo): boolean;
-}
-/**
- * The process mode of the video frame:
- */
-export declare enum VideoFrameProcessMode {
-    /**
-     * Read-only mode.In this mode, you do not modify the video frame. The video frame observer is a renderer.
-     */
-    ProcessModeReadOnly = 0,
-    /**
-     * Read and write mode.In this mode, you modify the video frame. The video frame observer is a video filter.
-     */
-    ProcessModeReadWrite = 1
-}
-/**
- * The IVideoFrameObserver class.
- */
-export interface IVideoFrameObserver {
-    /**
-     * Occurs each time the SDK receives a video frame captured by the local camera.
-     * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data captured by the local camera. You can then pre-process the data according to your scenarios.After pre-processing, you can send the processed video data back to the SDK through this callback.The video data that this callback gets has not been pre-processed, and is not watermarked, cropped, rotated or beautified.If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
-     *
-     * @param videoFrame The video frame. See VideoFrame .The default value of the video frame data format obtained through this callback is as follows:macOS: YUV 420Windows: YUV 420
-     *
-     * @returns
-     * When the video processing mode is ProcessModeReadOnly:true: Reserved for future use.false: Reserved for future use.When the video processing mode is ProcessModeReadWrite:true: Sets the SDK to receive the video frame.false: Sets the SDK to discard the video frame.
-     */
-    onCaptureVideoFrame?(sourceType: VideoSourceType, videoFrame: VideoFrame): boolean;
-    /**
-     * Occurs each time the SDK receives a video frame before encoding.
-     * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data before encoding and then process the data according to your particular scenarios.After processing, you can send the processed video data back to the SDK in this callback.The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
-     *
-     * @param videoFrame The video frame. See VideoFrame .The default value of the video frame data format obtained through this callback is as follows:macOS: YUV 420Windows: YUV 420
-     *
-     * @returns
-     * When the video processing mode is ProcessModeReadOnly:true: Reserved for future use.false: Reserved for future use.When the video processing mode is ProcessModeReadWrite:true: Sets the SDK to receive the video frame.false: Sets the SDK to discard the video frame.
-     */
-    onPreEncodeVideoFrame?(sourceType: VideoSourceType, videoFrame: VideoFrame): boolean;
-    /**
-     * @ignore
-     */
-    onMediaPlayerVideoFrame?(videoFrame: VideoFrame, mediaPlayerId: number): boolean;
-    /**
-     * Occurs each time the SDK receives a video frame sent by the remote user.
-     * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data sent from the remote end before rendering, and then process it according to the particular scenarios.If the video data type you get is RGBA, the SDK does not support processing the data of the alpha channel.
-     *
-     * @param channelId The channel ID.
-     * @param remoteUid The user ID of the remote user who sends the current video frame.
-     * @param videoFrame The video frame. See VideoFrame .The default value of the video frame data format obtained through this callback is as follows:
-     *  macOS: YUV 420
-     *  Windows: YUV 420
-     *
-     * @returns
-     * When the video processing mode is ProcessModeReadOnly:
-     *  true: Reserved for future use.
-     *  false: Reserved for future use. When the video processing mode is ProcessModeReadWrite:
-     *  true: Sets the SDK to receive the video frame.
-     *  false: Sets the SDK to discard the video frame.
-     */
-    onRenderVideoFrame?(channelId: string, remoteUid: number, videoFrame: VideoFrame): boolean;
-    /**
-     * Occurs each time the SDK receives a video frame before encoding.
-     * After you successfully register the video frame observer, the SDK triggers this callback each time it receives a video frame. In this callback, you can get the video data before encoding and then process the data according to your particular scenarios.After processing, you can send the processed video data back to the SDK in this callback.The video data that this callback gets has been preprocessed, with its content cropped and rotated, and the image enhanced.
-     *
-     * @param videoFrame The video frame. See VideoFrame .The default value of the video frame data format obtained through this callback is as follows:macOS: YUV 420Windows: YUV 420
-     *
-     * @returns
-     * When the video processing mode is ProcessModeReadOnly:true: Reserved for future use.false: Reserved for future use.When the video processing mode is ProcessModeReadWrite:true: Sets the SDK to receive the video frame.false: Sets the SDK to discard the video frame.
-     */
-    onTranscodedVideoFrame?(videoFrame: VideoFrame): boolean;
-}
-/**
- * The external video frame encoding type.
- */
-export declare enum ExternalVideoSourceType {
-    /**
-     * 0: The video frame is not encoded.
-     */
-    VideoFrame = 0,
-    /**
-     * 1: The video frame is encoded.
-     */
-    EncodedVideoFrame = 1
-}
-/**
- * The format of the recording file.
- */
-export declare enum MediaRecorderContainerFormat {
-    /**
-     * 1: (Default) MP4.
-     */
-    FormatMp4 = 1
-}
-/**
- * The recording content.
- */
-export declare enum MediaRecorderStreamType {
-    /**
-     * Only audio.
-     */
-    StreamTypeAudio = 1,
-    /**
-     * Only video.
-     */
-    StreamTypeVideo = 2,
-    /**
-     * (Default) Audio and video.
-     */
-    StreamTypeBoth = 3
-}
-/**
- * The current recording state.
- */
-export declare enum RecorderState {
-    /**
-     * -1: An error occurs during the recording. See RecorderErrorCode for the reason.
-     */
-    RecorderStateError = -1,
-    /**
-     * 2: The audio and video recording starts.
-     */
-    RecorderStateStart = 2,
-    /**
-     * 3: The audio and video recording stops.
-     */
-    RecorderStateStop = 3
-}
-/**
- * The reason for the state change.
- */
-export declare enum RecorderErrorCode {
-    /**
-     * 0: No error.
-     */
-    RecorderErrorNone = 0,
-    /**
-     * 1: The SDK fails to write the recorded data to a file.
-     */
-    RecorderErrorWriteFailed = 1,
-    /**
-     * 2: The SDK does not detect any audio and video streams, or audio and video streams are interrupted for more than five seconds during recording.
-     */
-    RecorderErrorNoStream = 2,
-    /**
-     * 3: The recording duration exceeds the upper limit.
-     */
-    RecorderErrorOverMaxDuration = 3,
-    /**
-     * 4: The recording configuration changes.
-     */
-    RecorderErrorConfigChanged = 4
-}
-/**
- * Configurations for the local audio and video recording.
- */
-export declare class MediaRecorderConfiguration {
-    /**
-     * The absolute path (including the filename extensions) of the recording file. For example:Windows: C:\Users\<user_name>\AppData\Local\Agora\<process_name>\example.mp4iOS: /App Sandbox/Library/Caches/example.mp4macOS: /Library/Logs/example.mp4Android: /storage/emulated/0/Android/data/<package name>/files/example.mp4Ensure that the directory for the log files exists and is writable.
-     */
-    storagePath?: string;
-    /**
-     * The format of the recording file. See MediaRecorderContainerFormat .
-     */
-    containerFormat?: MediaRecorderContainerFormat;
-    /**
-     * The recording content. See MediaRecorderStreamType .
-     */
-    streamType?: MediaRecorderStreamType;
-    /**
-     * The maximum recording duration, in milliseconds. The default value is 120000.
-     */
-    maxDurationMs?: number;
-    /**
-     * The interval (ms) of updating the recording information. The value range is [1000,10000]. Based on the value you set in this parameter, the SDK triggers the onRecorderInfoUpdated callback to report the updated recording information.
-     */
-    recorderInfoUpdateInterval?: number;
-}
-/**
- * The information about the file that is recorded.
- */
-export declare class RecorderInfo {
-    /**
-     * The absolute path of the recording file.
-     */
-    fileName?: string;
-    /**
-     * The recording duration (ms).
-     */
-    durationMs?: number;
-    /**
-     * The size (bytes) of the recording file.
-     */
-    fileSize?: number;
-}
-/**
- * The IMediaRecorderObserver class.
- */
-export interface IMediaRecorderObserver {
-    /**
-     * Occurs when the recording state changes.
-     * When the local audio or video recording state changes, the SDK triggers this callback to report the current recording state and the reason for the change.
-     *
-     * @param state The current recording state. See RecorderState .
-     * @param error The reason for the state change. See RecorderErrorCode .
-     */
-    onRecorderStateChanged?(channelId: string, uid: number, state: RecorderState, error: RecorderErrorCode): void;
-    /**
-     * Occurs when the recording information is updated.
-     * After you successfully enable the local audio and video recording, the SDK periodically triggers this callback based on the value of recorderInfoUpdateInterval set in MediaRecorderConfiguration . This callback reports the file name, duration, and size of the current recording file.
-     *
-     * @param info The information about the file that is recorded. See RecorderInfo .
-     */
-    onRecorderInfoUpdated?(channelId: string, uid: number, info: RecorderInfo): void;
-}