@agora-js/media 4.20.0 → 4.20.1-1

package/rtc-sdk-media_en.d.ts

@@ -487,7 +487,7 @@ export declare class CameraVideoTrack extends LocalVideoTrack implements ICamera
     _enabled: boolean;
     _deviceName: string;
     get __className__(): string;
-    constructor(track: MediaStreamTrack, config: CameraVideoTrackInitConfig, constraints: MediaTrackConstraints, scalabilityConfig?: SVCConfiguration, optimizationMode?: "motion" | "detail" | "balanced", trackId?: string);
+    constructor(track: MediaStreamTrack, config: CameraVideoTrackInitConfig, constraints: MediaTrackConstraints, scalabilityConfig?: SVCConfiguration, optimizationMode?: OptimizationMode | "balanced", trackId?: string);
     setDevice(deviceId: string | RequiredOnlyOneOf<{
         facingMode: VideoFacingModeEnum;
         deviceId: string;
@@ -547,7 +547,7 @@ export declare interface CameraVideoTrackInitConfig {
      *
      * > Note: This method is only supported on Chrome.
      */
-    optimizationMode?: "motion" | "detail";
+    optimizationMode?: OptimizationMode;
     /**
      * @ignore
      *
@@ -896,6 +896,18 @@ declare function event_beauty_effect_overload(): void;
  */
 declare function event_first_frame_decoded(): void;
 
+/**
+ * **Since**
+ * <br>&emsp;&emsp;&emsp;*4.20.1*
+ *
+ * Parsing SEI data from the H.264 video stream triggers this event, which returns the SEI data.
+ *
+ * @param sei SEI data in Uint8Array
+ * @asMemberOf ILocalVideoTrack
+ * @event
+ */
+declare function event_sei_received(sei: Uint8Array): void;
+
 /**
  * Occurs when the state of processing the audio buffer in [BufferSourceAudioTrack]{@link IBufferSourceAudioTrack} changes.
  *
@@ -927,6 +939,8 @@ declare function event_source_state_change(currentState: AudioSourceState): void
  */
 declare function event_track_ended(): void;
 
+export declare function event_track_updated(track: MediaStreamTrack): void;
+
 /**
  * Occurs when the `RTCRtpTransceiver` instance of the current track is updated.
  *
@@ -999,6 +1013,14 @@ declare function event_video_element_visible_status(data?: CheckVideoVisibleResu
  */
 declare function event_video_element_visible_status_2(data?: CheckVideoVisibleResult): void;
 
+/**
+ * Occurs when the video state changes.
+ *
+ * @event
+ * @asMemberOf IRemoteTrack
+ */
+declare function event_video_state_changed(videoState: VideoState): void;
+
 export declare interface ExtendedVideoFrameCallbackMetadata extends VideoFrameCallbackMetadata {
     timestamp: DOMHighResTimeStamp;
 }
@@ -1042,7 +1064,9 @@ export declare function getAudioContext(): AudioContext;
 
 export declare function getAudioEncoderConfiguration(profile: AudioEncoderConfigurationPreset | AudioEncoderConfiguration): AudioEncoderConfiguration;
 
-export declare function getBitrateFromResAndFps(width: number, height: number, fps: number, bitrateAdapterType: "STANDARD_BITRATE" | "COMPATIABLE_BITRATE"): [number, number] | void;
+export declare function getBitrateConstrainRange(width: number, height: number, frameRate: number, bitrateMin?: number, bitrateMax?: number): DoubleRange;
+
+export declare function getBitrateFromResAndFps(width: number, height: number, fps: number): Required<DoubleRange>;
 
 export declare function getCompatibility(): AgoraRTCCompatibility;
 
@@ -1060,6 +1084,14 @@ export declare function getElectronScreenStreamByUserSelect(config: ScreenConstr
 
 export declare function getLocalStream(config: GetUserMediaConfig, id: string): Promise<MediaStream>;
 
+export declare const getOriginSenderConfig: (track: LocalVideoTrack) => {
+    frameRate: number;
+    bitrateMax: number;
+    bitrateMin: number;
+    scaleResolutionDownBy: number;
+    scale: number;
+};
+
 export declare function getScalabilityConfiguration(profile: SVCConfiguration | SVCConfigurationPreset): SVCConfiguration;
 
 export declare function getScreenEncoderConfiguration(profile: VideoEncoderConfiguration | ScreenEncoderConfigurationPreset | string): VideoEncoderConfiguration;
@@ -1317,7 +1349,6 @@ export declare interface ILocalAudioTrack extends ILocalTrack {
      *
      * > Note:
      * > - As of v4.7.0, this method no longer takes effect. Use [IRemoteAudioTrack.setPlaybackDevice]{@link IRemoteAudioTrack.setPlaybackDevice} instead.
-     * > - This method supports Chrome on desktop devices only. Other browsers throw a '`NOT_SUPPORTED` error when calling this method.
      *
      * Sets the playback device (speaker) for the remote audio stream.
      *
@@ -1371,6 +1402,7 @@ export declare interface ILocalDataChannel extends IDataChannel {
  * `LocalTrack` is the basic interface for local tracks, providing public methods for [LocalAudioTrack]{@link ILocalAudioTrack} and [LocalVideoTrack]{@link ILocalVideoTrack}.
  */
 export declare interface ILocalTrack extends ITrack {
+    on(event: "track-updated", listener: typeof event_track_updated): void;
     /**
      * @param event The event name.
      * @param listener See [track-ended]{@link event_track_ended}.
@@ -1424,7 +1456,7 @@ export declare interface ILocalTrack extends ITrack {
      *
      * If the track is published, a successful call of `setMuted(true)` triggers the [user-unpublished]{@link IAgoraRTCClient.event_user_unpublished} event on the remote client, and a successful call of `setMuted(false)` triggers the [user-published]{@link IAgoraRTCClient.event_user_published} event.
      *
-     * > - Calling `setMuted(true)` does not stop capturing audio or video and takes shorter time to take effect than [[setEnabled]]. For details, see [What are the differences between setEnabled and setMuted?](https://docs.agora.io/en/Interactive%20Broadcast/faq/differences_between_setenabled_and_setmuted).
+     * > - Calling `setMuted(true)` does not stop capturing audio or video and takes shorter time to take effect than [[setEnabled]]. For details, see [What are the differences between setEnabled and setMuted?](https://docs.agora.io/en/interactive-live-streaming/develop/product-workflow?platform=web#setenabled-and-setmuted).
      * > - Do not call `setEnabled` and `setMuted` together.
      *
      * @param muted Whether to stop sending the media data of the track:
@@ -1450,6 +1482,7 @@ export declare interface ILocalTrack extends ITrack {
  * Inherited from `LocalVideoTrack`, [CameraVideoTrack]{@link ICameraVideoTrack} is an interface for the video captured by a local camera and adds several camera-related functions.
  */
 export declare interface ILocalVideoTrack extends ILocalTrack {
+    on(event: "track-updated", listener: typeof event_track_updated): void;
     /** @internal */
     on(event: "beauty-effect-overload", listener: typeof event_beauty_effect_overload): void;
     /**
@@ -1469,7 +1502,7 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      */
     on(event: "transceiver-updated", listener: typeof event_transceiver_updated): void;
     /**
-     * Plays a local video track on the web page.
+     * Plays a remote video track on the web page.
      *
      * @param element Specifies a DOM element. The SDK will create a `<video>` element under the specified DOM element to play the video track. You can specify a DOM element in either of the following ways:
      * - `string`: Specify the ID of the DOM element.
@@ -1636,6 +1669,12 @@ export declare interface ILocalVideoTrack extends ILocalTrack {
      * @param config The video encoder configurations. You can pass either [[VideoEncoderConfigurationPreset]] or a customized [[VideoEncoderConfiguration]] object.
      */
     setEncoderConfiguration(config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset): Promise<void>;
+    /**
+     * Add the SEI data to the H.264 video stream.
+     *
+     * @param config SEI data.
+     */
+    sendSeiData(sei: Uint8Array): void;
 }
 
 export declare interface ImageTypedData {
@@ -1677,6 +1716,18 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
     setEnabled(enabled: boolean): Promise<void>;
 }
 
+export declare function interceptLocalAudioFrame(sender: RTCRtpSender): Promise<void>;
+
+export declare function interceptLocalVideoFrame(sender: RTCRtpSender, localVideoTrack: LocalVideoTrack): Promise<void>;
+
+export declare function interceptRemoteAudioFrame(receiver: RTCRtpReceiver): Promise<void>;
+
+export declare function interceptRemoteVideoFrame(receiver: RTCRtpReceiver, options?: InterceptVideoFrameOptions): Promise<void>;
+
+declare interface InterceptVideoFrameOptions {
+    onSei?: (sei: Uint8Array) => void;
+}
+
 /**
  * `RemoteAudioTrack` is the basic interface for the remote audio track.
  *
@@ -1701,7 +1752,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      *
      * Sets the audio playback device, for example, the speaker.
      *
-     * > This method supports Chrome on desktop devices only. Other browsers throw a `NOT_SUPPORTED` error when calling this method.
+     * > This method supports Chrome and Edge on desktop devices only. Other browsers throw a `NOT_SUPPORTED` error when calling this method.
      * @param deviceId Device ID, which can be retrieved by calling [[getPlaybackDevices]].
      */
     setPlaybackDevice(deviceId: string): Promise<void>;
@@ -1788,6 +1839,7 @@ export declare interface IRemoteDataChannel extends IDataChannel {
  * `RemoteTrack` is the basic interface for remote tracks, providing public methods for [RemoteAudioTrack]{@link IRemoteAudioTrack} and [RemoteVideoTrack]{@link IRemoteVideoTrack}.
  */
 export declare interface IRemoteTrack extends ITrack {
+    on(event: "track-updated", listener: typeof event_track_updated): void;
     /**
      * @param event The event name.
      * @param listener See [first-frame-decoded]{@link event_first_frame_decoded}.
@@ -1820,6 +1872,12 @@ export declare interface IRemoteTrack extends ITrack {
  * You can get create a remote video track by the [AgoraRTCRemoteUser.videoTrack]{@link IAgoraRTCRemoteUser.videoTrack} object after calling [subscribe]{@link IAgoraRTCClient.subscribe}.
  */
 export declare interface IRemoteVideoTrack extends IRemoteTrack {
+    /**
+     * @param event The event name.
+     * @param listener See [video-state-changed]{@link event_video_state_changed}.
+     */
+    on(event: "track-updated", listener: typeof event_track_updated): void;
+    on(event: "video-state-changed", listener: typeof event_video_state_changed): void;
     /**
      * @param event The event name.
      * @param listener See [first-frame-decoded]{@link event_first_frame_decoded}.
@@ -1836,6 +1894,12 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      * @param listener See [IRemoteTrack.transceiver-updated]{@link event_transceiver_updated_2}.
      */
     on(event: "transceiver-updated", listener: typeof event_transceiver_updated_2): void;
+    /**
+     * Adds an event listener.
+     * @param event The event name.
+     * @param listener See [ILocalTrack.sei-received]{@link event_sei_received}.
+     */
+    on(event: "sei-received", listener: typeof event_sei_received): void;
     /**
      * Gets the statistics of a remote video track.
      *
@@ -1975,23 +2039,21 @@ export declare class LocalAudioTrack extends LocalTrack implements ILocalAudioTr
     readonly trackMediaType: "audio" | "video";
     _encoderConfig?: AudioEncoderConfiguration;
     _trackSource: AudioTrackSource | FakeTrackSource;
-    get _source(): AudioTrackSource | FakeTrackSource;
+    get _source(): AudioTrackSource;
     set _source(source: AudioTrackSource | FakeTrackSource);
     _enabled: boolean;
     private _volume;
     _useAudioElement: boolean;
     _bypassWebAudio: boolean;
     protected processor?: IAudioProcessor;
-    protected _processorContext: AudioProcessorContext;
+    protected _processorContext: AudioProcessorContext | undefined;
     protected get processorContext(): AudioProcessorContext;
-    protected set processorContext(ctx: AudioProcessorContext);
-    _processorDestination: AudioProcessorDestination;
+    _processorDestination: AudioProcessorDestination | undefined;
     get processorDestination(): AudioProcessorDestination;
-    set processorDestination(des: AudioProcessorDestination);
     protected _getOriginVolumeLevel: boolean;
     get isPlaying(): boolean;
     get __className__(): string;
-    constructor(track: MediaStreamTrack, encoderConfig?: AudioEncoderConfiguration, trackId?: string, getOriginVolumeLevel?: boolean, deferWebAudio?: boolean);
+    constructor(track: MediaStreamTrack, encoderConfig?: AudioEncoderConfiguration, trackId?: string, getOriginVolumeLevel?: boolean);
     setVolume(volume: number): void;
     getVolumeLevel(): number;
     setPlaybackDevice(deviceId: string): Promise<void>;
@@ -2010,7 +2072,10 @@ export declare class LocalAudioTrack extends LocalTrack implements ILocalAudioTr
     unpipe(): void;
     private bindProcessorDestinationEvents;
     private unbindProcessorDestinationEvents;
-    private unbindProcessorContextEvents;
+    protected bindProcessorContextEvents(processorContext: AudioProcessorContext): void;
+    protected unbindProcessorContextEvents(processorContext: AudioProcessorContext): void;
+    private initWebAudio;
+    private initProcessor;
 }
 
 /**
@@ -2083,9 +2148,9 @@ export declare abstract class LocalTrack extends Track implements ILocalTrack {
     _isClosed: boolean;
     protected _enabledMutex: PromiseMutex;
     protected processor?: IBaseProcessor;
-    protected abstract _processorContext: IProcessorContext;
-    protected get processorContext(): IProcessorContext;
-    protected set processorContext(ctx: IProcessorContext);
+    protected abstract _processorContext: IProcessorContext | undefined;
+    protected get processorContext(): IProcessorContext | undefined;
+    abstract processorDestination: IBaseProcessor;
     constructor(track: MediaStreamTrack, trackId?: string);
     abstract getStats(): LocalVideoTrackStats | LocalAudioTrackStats;
     abstract setMuted(enabled: boolean): Promise<void>;
@@ -2119,9 +2184,15 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
     protected _statsTimer: number | null;
     private _previousVideoVisibleStatus;
     private _clearPreviousVideoVisibleStatus;
-    _encoderConfig?: Partial<VideoEncoderConfiguration>;
+    _encoderConfig?: Partial<VideoEncoderConfiguration & {
+        scale: number;
+    }>;
     _scalabilityMode?: SVCConfiguration;
-    _optimizationMode?: "motion" | "detail" | "balanced";
+    _optimizationMode?: OptimizationMode | "balanced";
+    _qualityLimitationReason?: QualityLimitationReason;
+    private _originalSenderConfig?;
+    _adaptationConfig?: VideoSenderConfig;
+    private _adaptationTimer;
     _videoHeight?: number;
     _videoWidth?: number;
     _forceBitrateLimit?: {
@@ -2135,13 +2206,13 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
     protected get processorContext(): VideoProcessorContext;
     protected set processorContext(ctx: VideoProcessorContext);
     get __className__(): string;
-    constructor(track: MediaStreamTrack, encoderConfig?: Partial<VideoEncoderConfiguration>, scalabilityConfig?: SVCConfiguration, optimizationMode?: "motion" | "detail" | "balanced", trackId?: string, hints?: TrackHint[]);
+    constructor(track: MediaStreamTrack, encoderConfig?: Partial<VideoEncoderConfiguration>, scalabilityConfig?: SVCConfiguration, optimizationMode?: OptimizationMode | "balanced", trackId?: string, hints?: TrackHint[]);
     play(element: HTMLElement | HTMLVideoElement | string, config?: VideoPlayerConfig): void;
     stop(): void;
     setEnabled(enabled: boolean, skipChangeState?: boolean): Promise<void>;
     setMuted(muted: boolean): Promise<void>;
     setEncoderConfiguration(config: VideoEncoderConfiguration | VideoEncoderConfigurationPreset, doNotRenegoation?: boolean): Promise<void>;
-    getStats(): LocalVideoTrackStats;
+    getStats(isExternal?: boolean): LocalVideoTrackStats;
     setBeautyEffect(enabled: boolean, options?: BeautyEffectOptions): Promise<void>;
     getCurrentFrameData(): ImageData;
     getCurrentFrameImage(imageType: string, quality?: number): Promise<ImageTypedData>;
@@ -2149,7 +2220,10 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
         max_bitrate: number;
         min_bitrate: number;
     }): Promise<void>;
-    setOptimizationMode(mode: "motion" | "detail" | "balanced"): Promise<void>;
+    setOptimizationMode(mode: OptimizationMode | "balanced"): Promise<void>;
+    protected applyAdaptation(config: VideoSenderConfig): Promise<void>;
+    startVideoStreamAdapter(): void;
+    protected updateAdapterConfig(): void;
     setScalabiltyMode(mode: SVCConfiguration): void;
     updateMediaStreamTrackResolution(): void;
     protected _updatePlayerSource(): void;
@@ -2164,6 +2238,7 @@ export declare class LocalVideoTrack extends LocalTrack implements ILocalVideoTr
     clone(config?: VideoEncoderConfiguration | VideoEncoderConfigurationPreset, cloneTrack?: boolean): LocalVideoTrack;
     replaceTrack(track: MediaStreamTrack, stopOldTrack: boolean): Promise<void>;
     startMonitorStats(): void;
+    sendSeiData(sei: Uint8Array): never;
     private bindProcessorDestinationEvents;
     private unbindProcessorDestinationEvents;
     private unbindProcessorContextEvents;
@@ -2334,7 +2409,8 @@ export declare class MicrophoneAudioTrack extends LocalAudioTrack implements IMi
     close(): void;
     protected onTrackEnded(): void;
     renewMediaStreamTrack(newConstraints?: MediaTrackConstraints): Promise<void>;
-    private bindProcessorContextEvents;
+    protected bindProcessorContextEvents(processorContext: AudioProcessorContext): void;
+    protected unbindProcessorContextEvents(processorContext: AudioProcessorContext): void;
 }
 
 /**
@@ -2399,6 +2475,8 @@ export declare class MixingAudioTrack extends LocalAudioTrack {
     _updateRtpTransceiver(transceiver: RTCRtpTransceiver): void;
 }
 
+export declare type OptimizationMode = "motion" | "detail";
+
 export declare interface PlayerConfig extends VideoPlayerConfig {
     trackId: string;
     element: HTMLElement;
@@ -2423,6 +2501,13 @@ export declare interface ProcessorUsageStats {
     totalTs: number;
 }
 
+declare enum QualityLimitationReason {
+    BANDWIDTH = "bandwidth",
+    CPU = "cpu",
+    NONE = "none",
+    OTHER = "other"
+}
+
 export declare class RemoteAudioTrack extends RemoteTrack implements IRemoteAudioTrack {
     readonly trackMediaType: "audio" | "video";
     _source: AudioTrackSource | FakeTrackSource;
@@ -2593,7 +2678,8 @@ export declare abstract class RemoteTrack extends Track implements IRemoteTrack
 
 export declare enum RemoteTrackEvents {
     FIRST_FRAME_DECODED = "first-frame-decoded",
-    VIDEO_ELEMENT_VISIBLE_STATUS = "video-element-visible-status"
+    VIDEO_ELEMENT_VISIBLE_STATUS = "video-element-visible-status",
+    VIDEO_STATE_CHANGED = "video-state-changed"
 }
 
 export declare class RemoteVideoTrack extends RemoteTrack implements IRemoteVideoTrack {
@@ -2621,6 +2707,7 @@ export declare class RemoteVideoTrack extends RemoteTrack implements IRemoteVide
     private bindProcessorDestinationEvents;
     private unbindProcessorDestinationEvents;
     _destroy(): void;
+    _onSei(sei: Uint8Array): void;
 }
 
 /**
@@ -2888,6 +2975,12 @@ export declare interface ScreenVideoTrackInitConfig {
     systemAudio?: "include" | "exclude";
 }
 
+export declare type SenderConfig = {
+    bitrateMax: number;
+    bitrateMin: number;
+    scaleResolutionDownBy: number;
+};
+
 export declare function silenceScriptProcessHandler(e: AudioProcessingEvent): AudioBuffer;
 
 export declare interface StatsRegistry {
@@ -2983,7 +3076,9 @@ export declare abstract class Track extends EventEmitter implements ITrack {
     _hints: TrackHint[];
     _isClosed: boolean;
     _originMediaStreamTrack: MediaStreamTrack;
-    _mediaStreamTrack: MediaStreamTrack;
+    mediaStreamTrack: MediaStreamTrack;
+    set _mediaStreamTrack(track: MediaStreamTrack);
+    get _mediaStreamTrack(): MediaStreamTrack;
     _external: ExternalMethods;
     constructor(track: MediaStreamTrack, trackId?: string);
     toString(): string;
@@ -2998,7 +3093,10 @@ export declare abstract class Track extends EventEmitter implements ITrack {
 }
 
 export declare enum TrackEvents {
-    TRANSCEIVER_UPDATED = "transceiver-updated"
+    TRANSCEIVER_UPDATED = "transceiver-updated",
+    SEI_TO_SEND = "sei-to-send",
+    SEI_RECEIVED = "sei-received",
+    TRACK_UPDATED = "track-updated"
 }
 
 export declare enum TrackHint {
@@ -3010,6 +3108,7 @@ export declare enum TrackHint {
 export declare enum TrackInternalEvent {
     NEED_RENEGOTIATE = "@need_renegotiate",
     NEED_REPLACE_TRACK = "@need_replace_track",
+    NEED_REPLACE_MIXING_TRACK = "@need_replace_mixing_track",
     NEED_CLOSE = "@need_close",
     NEED_ENABLE_TRACK = "@need_enable_track",
     NEED_DISABLE_TRACK = "@need_disable_track",
@@ -3020,6 +3119,7 @@ export declare enum TrackInternalEvent {
     GET_LOW_VIDEO_TRACK = "@get_low_video_track",
     NEED_RESET_REMOTE_SDP = "@need_reset_remote_sdp",
     NEED_UPDATE_VIDEO_ENCODER = "@need_update_video_encoder",
+    NEED_UPDATE_VIDEO_SEND_PARAMETERS = "@need_update_video_send_parameters",
     NEED_MUTE_TRACK = "@need_mute_track",
     NEED_UNMUTE_TRACK = "@need_unmute_track"
 }
@@ -3141,6 +3241,7 @@ declare class VideoPlayer {
     trackId: string;
     config: PlayerConfig;
     onFirstVideoFrameDecoded?: () => void;
+    onVideoStateChanged?: (state: VideoState) => void;
     freezeTimeCounterList: number[];
     renderFreezeAccTime: number;
     isKeepLastFrame: boolean;
@@ -3154,7 +3255,11 @@ declare class VideoPlayer {
     protected cacheVideoElement?: HTMLVideoElement;
     get videoElementStatus(): MediaElementStatus;
     set videoElementStatus(status: MediaElementStatus);
+    get videoState(): VideoState;
+    set videoState(state: VideoState);
+    private _videoState;
     private videoElementCheckInterval?;
+    private videoElementFreezeTimeout?;
     private _videoElementStatus;
     private isGettingVideoDimensions;
     constructor(config: PlayerConfig);
@@ -3245,6 +3350,36 @@ export declare class VideoProcessorDestination extends EventEmitter implements I
     reset(): void;
 }
 
+declare interface VideoSenderConfig {
+    frameRate: number;
+    bitrateMax: number;
+    bitrateMin: number;
+    scaleResolutionDownBy: number;
+    scale: number;
+}
+
+/**
+ * The state of the video stream.
+ */
+export declare enum VideoState {
+    /**
+     * 0: The initial state of the video.
+     */
+    VideoStateStopped = 0,
+    /**
+     * 1: The local user has received the first video packet.
+     */
+    VideoStateStarting = 1,
+    /**
+     * 2: The video stream is being decoded and played normally.
+     */
+    VideoStateDecoding = 2,
+    /**
+     * 3: The video stream is frozen.
+     */
+    VideoStateFrozen = 3
+}
+
 declare class VisibilityWatcher extends EventEmitter {
     private _lastHiddenTime;
     private _lastVisibleTime;