@agora-js/media 4.24.0 → 4.24.1

package/rtc-sdk-media_en.d.ts

@@ -41,6 +41,8 @@ export declare interface AgoraRTCCompatibility {
     supportWebRTCInsertableStream: boolean;
     supportRequestVideoFrameCallback: boolean;
     supportWebCrypto: boolean;
+    supportSuppressLocalAudioPlayback: boolean;
+    supportRestrictOwnAudio: boolean;
 }
 
 export declare class AgoraRTCPlayer extends VideoPlayer {
@@ -172,11 +174,12 @@ declare class AudioElementPlayCenter {
     updateTrack(trackId: string, track: MediaStreamTrack): void;
     isPlaying(trackId: string): boolean;
     setVolume(trackId: string, volume: number): void;
+    getVolume(trackId: string): number;
     stop(trackId: string): void;
     private bindAudioElementEvents;
     getPlayerState(trackId: string): string;
     private autoResumeAudioElement;
-    autoResumeAfterInterruption: (force?: boolean) => void;
+    autoResumeAfterInterruption: (force?: boolean) => Promise<void[]>;
     private autoResumeAfterInterruptionOnIOS15_16;
 }
 
@@ -840,6 +843,10 @@ export declare function detectSupportPrePc(store?: SDKStore): boolean;
 
 export declare function detectSupportPreSub(store?: SDKStore): boolean;
 
+export declare function detectSupportRestrictOwnAudio(): boolean;
+
+export declare function detectSupportSuppressLocalAudioPlayback(): boolean;
+
 /**
  * Information of the media input device.
  *
@@ -949,7 +956,7 @@ 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.
+ * Parsing SEI data from the H.264 or H.265 video stream triggers this event, which returns the SEI data.
  *
  * @param sei SEI data in Uint8Array
  * @asMemberOf ILocalVideoTrack
@@ -1112,7 +1119,7 @@ declare class FakeTrackSource extends EventEmitter {
     createMediaStreamSourceNode(): undefined;
 }
 
-export declare const frameData2CryptoBuffer: (imageData: ImageTypedData, appid: string, channelName: string) => Promise<Uint8Array<ArrayBufferLike>>;
+export declare const frameData2CryptoBuffer: (imageData: ImageTypedData, appid: string, channelName: string) => Promise<Uint8Array>;
 
 export declare function getAudioContext(): AudioContext;
 
@@ -1130,7 +1137,10 @@ export declare function getConstraintsFromCameraConfig(config: CameraVideoTrackI
 
 export declare function getConstraintsFromMicrophoneConfig(config: MicrophoneAudioTrackInitConfig): MediaTrackConstraints;
 
-export declare function getConstraintsFromScreenAudioConfig(config: ScreenAudioTrackInitConfig): MediaTrackConstraints;
+export declare function getConstraintsFromScreenAudioConfig(config: ScreenAudioTrackInitConfig): MediaTrackConstraints & {
+    suppressLocalAudioPlayback?: boolean;
+    restrictOwnAudio?: boolean;
+};
 
 export declare function getConstraintsFromScreenConfig(config: ScreenVideoTrackInitConfig): ScreenConstraintsWithElectron;
 
@@ -1183,6 +1193,8 @@ export declare let HAS_GUM_VIDEO: boolean;
 
 export declare function hasAudioContext(): boolean;
 
+export declare function hasMicrophoneTrack(): boolean;
+
 /**
  * Inherited from [LocalAudioTrack]{@link ILocalAudioTrack}, `BufferSourceAudioTrack` is an interface for the audio from a local audio file and adds several functions for controlling the processing of the audio buffer, such as starting processing, stopping processing, and seeking a specified time location.
  *
@@ -1355,6 +1367,15 @@ declare interface IDataStream {
     deserialize: (packet: ArrayBuffer) => ArrayBuffer;
 }
 
+export declare interface IFrameInfo {
+    type: string;
+    rtpTimestamp: number;
+    payloadType: number;
+    ssrc: number;
+    length: number;
+    mimeType?: string;
+}
+
 /**
  * `LocalAudioTrack` is the basic interface for local audio tracks, providing main methods of local audio tracks.
  *
@@ -1523,11 +1544,11 @@ export declare interface ILocalTrack extends ITrack {
      * Sends or stops sending the media data of the track.
      *
      * @since
-     * <br>&emsp;&emsp;&emsp;*4.6.0*
+     * <br>&emsp;&emsp;&emsp;*4.0.0*
      *
      * 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-live-streaming/develop/product-workflow?platform=web#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/help/integration-issues/set_enabled_set_muted).
      * > - Do not call `setEnabled` and `setMuted` together.
      *
      * @param muted Whether to stop sending the media data of the track:
@@ -1813,6 +1834,7 @@ export declare function interceptRemoteVideoFrame(receiver: RTCRtpReceiver, opti
 
 export declare interface InterceptVideoFrameOptions {
     onSei?: (sei: Uint8Array) => void;
+    onFirstFrame?: (frameInfo: IFrameInfo) => void;
 }
 
 /**
@@ -1874,6 +1896,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      * @param volume The volume. The value ranges from 0 (mute) to 100 (maximum). A value of 100 is the current volume.
      */
     setVolume(volume: number): void;
+    setAmplifiedVolume(volume: number): void;
     /**
      * Gets the audio level of a remote audio track.
      *
@@ -1881,6 +1904,7 @@ export declare interface IRemoteAudioTrack extends IRemoteTrack {
      * Usually a user with audio level above 0.6 is a speaking user.
      */
     getVolumeLevel(): number;
+    getVolume(): number;
     /**
      * @since
      * <br>&emsp;&emsp;&emsp;*4.13.0*
@@ -2060,6 +2084,12 @@ export declare interface IRemoteVideoTrack extends IRemoteTrack {
      * The destination of the current processing pipeline on the remote video track.
      */
     processorDestination: IBaseProcessor;
+    /**
+     * Stops playing the media track.
+     * @param isKeepLastFrame Whether to keep the last frame.
+     * @internal
+     */
+    stop(isKeepLastFrame?: boolean): void;
 }
 
 export declare function isAudioEncoderConfiguration(config: AudioEncoderConfiguration): config is AudioEncoderConfiguration;
@@ -2603,8 +2633,10 @@ export declare class RemoteAudioTrack extends RemoteTrack implements IRemoteAudi
     constructor(track: MediaStreamTrack, userId: UID, uintId: number, store: SDKStore);
     setAudioFrameCallback(callback: null | ((buffer: AudioBuffer) => void), frameSize?: number): void;
     setVolume(volume: number): void;
+    setAmplifiedVolume(volume: number): void;
     setPlaybackDevice(deviceId: string): Promise<void>;
     getVolumeLevel(): number;
+    getVolume(): number;
     getStats(): RemoteAudioTrackStats;
     play(): void;
     stop(): void;
@@ -2798,7 +2830,7 @@ export declare class RemoteVideoTrack extends RemoteTrack implements IRemoteVide
     constructor(track: MediaStreamTrack, userId: UID, uintId: number, store: SDKStore, player?: AgoraRTCPlayer);
     getStats(): RemoteVideoTrackStats;
     play(element: string | HTMLElement | HTMLVideoElement, config?: VideoPlayerConfig): void;
-    stop(): void;
+    stop(isKeepLastFrame?: boolean): void;
     getCurrentFrameData(): ImageData;
     updateMediaStreamTrackResolution(): void;
     protected _updatePlayerSource(): void;
@@ -2914,12 +2946,59 @@ export declare interface Resolution {
     height: number;
 }
 
+export declare function restartBackgroundTag(): void;
+
 export declare const SAFARI_GLOBAL_GUM_LOCK: PromiseMutex;
 
 /**
  * Configurations for the audio track of screen sharing. Set these configurations when calling [AgoraRTC.createScreenVideoTrack]{@link IAgoraRTC.createScreenVideoTrack} to enable audio during screen sharing.
  */
-export declare type ScreenAudioTrackInitConfig = AudioTrackInitConfig;
+export declare type ScreenAudioTrackInitConfig = {
+    /**
+     * Whether to enable acoustic echo cancellation:
+     * - `true`: Enable acoustic echo cancellation.
+     * - `false`: Do not enable acoustic echo cancellation.
+     */
+    AEC?: boolean;
+    /**
+     * Whether to enable audio gain control:
+     * - `true`: Enable audio gain control.
+     * - `false`: Do not enable audio gain control.
+     */
+    AGC?: boolean;
+    /**
+     * Whether to enable automatic noise suppression:
+     * - `true`: Enable automatic noise suppression.
+     * - `false`: Do not enable automatic noise suppression.
+     */
+    ANS?: boolean;
+    /**
+     * @since
+     * <br>&emsp;&emsp;&emsp;*4.24.1*</br>
+     *
+     * Whether to suppress local audio playback.
+     * - `true`: Suppress local audio playback.
+     * - `false`: (Default) Do not suppress local audio playback.
+     *
+     * See [suppressLocalAudioPlayback](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSupportedConstraints/suppressLocalAudioPlayback) for details.
+     *
+     * > This parameter is supported on Chrome 109 and later, Edge 109 and later, and Opera 95 and later.
+     */
+    suppressLocalAudioPlayback?: boolean;
+    /**
+     * @since
+     * <br>&emsp;&emsp;&emsp;*4.24.1*</br>
+     *
+     * Whether to restrict local audio capture.
+     * - `true`: Restrict local audio capture.
+     * - `false`: (Default) Do not restrict local audio capture.
+     *
+     * See [restrictOwnAudio](https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSupportedConstraints/restrictOwnAudio) for details.
+     *
+     * > This parameter is supported on Chrome 141 and later, Edge 141 and later, and Opera 125 and later.
+     */
+    restrictOwnAudio?: boolean;
+};
 
 export declare interface ScreenConstraintsWithElectron extends MediaTrackConstraints {
     sourceId?: string;
@@ -2933,6 +3012,8 @@ export declare interface ScreenConstraintsWithElectron extends MediaTrackConstra
     surfaceSwitching?: "include" | "exclude";
     systemAudio?: "include" | "exclude";
     preferCurrentTab?: boolean;
+    monitorTypeSurfaces?: "exclude" | "include";
+    windowAudio?: "exclude" | "system";
 }
 
 /**
@@ -3096,6 +3177,31 @@ export declare interface ScreenVideoTrackInitConfig {
      * > Note: This property is only supported in Chrome 94 and above, and Opera 80 and above..
      */
     preferCurrentTab?: boolean;
+    /**
+     * @since
+     * <br>&emsp;&emsp;&emsp;*4.24.1*</br>
+     *
+     * Whether to allow sharing window audio.
+     * - `"exclude"`: Do not share any audio.
+     * - `"system"`: (Default) Share system audio.
+     *
+     * See [withAudio](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#windowAudio) for details.
+     */
+    windowAudio?: "exclude" | "system";
+    /**
+     * @since
+     * <br>&emsp;&emsp;&emsp;*4.24.1*</br>
+     *
+     * Whether to allow sharing the entire screen, including the browser tab and window options.
+     * - `"exclude"`: Do not share the entire screen.
+     * - `"include"`: Share the entire screen.
+     *
+     * See [monitorTypeSurfaces](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getDisplayMedia#monitortypesurfaces) for details.
+     *
+     * > - This parameter is supported on Chrome 119 and later.
+     * > - If you set `monitorTypeSurface` to `exclude`, you cannot set `displaySurface` to `monitor`; otherwise, an error will occur.
+     */
+    monitorTypeSurfaces?: "exclude" | "include";
 }
 
 export declare type SenderConfig = {
@@ -3312,14 +3418,14 @@ export declare interface VideoEncoderConfiguration {
  * | Video Profile | Resolution (Width×Height) | Frame Rate (fps) | Chrome | Firefox | Safari |
  * | -------- | --------------- | ----------- | ------ | ------- | ------ |
  * | 120p     | 160 × 120       | 15          | ✓      |         |        |
- * | 120p_1   | 160 × 120       | 15          | ✓      |         |        |
+ * | 120p_1   | 160 × 120       | 15          | ✓      |         | ✓      |
  * | 120p_3   | 120 × 120       | 15          | ✓      |         |        |
  * | 180p     | 320 × 180       | 15          | ✓      |         |        |
  * | 180p_1   | 320 × 180       | 15          | ✓      |         |        |
  * | 180p_3   | 180 × 180       | 15          | ✓      |         |        |
- * | 180p_4   | 240 × 180       | 15          | ✓      |         |        |
+ * | 180p_4   | 240 × 180       | 15          | ✓      |         | ✓      |
  * | 240p     | 320 × 240       | 15          | ✓      |         |        |
- * | 240p_1   | 320 × 240       | 15          | ✓      |         |        |
+ * | 240p_1   | 320 × 240       | 15          | ✓      |         | ✓      |
  * | 240p_3   | 240 × 240       | 15          | ✓      |         |        |
  * | 240p_4   | 424 × 240       | 15          | ✓      |         |        |
  * | 360p     | 640 × 360       | 15          | ✓      |         |        |
@@ -3327,7 +3433,7 @@ export declare interface VideoEncoderConfiguration {
  * | 360p_3   | 360 × 360       | 15          | ✓      |         |        |
  * | 360p_4   | 640 × 360       | 30          | ✓      |         |        |
  * | 360p_6   | 360 × 360       | 30          | ✓      |         |        |
- * | 360p_7   | 480 × 360       | 15          | ✓      |         |        |
+ * | 360p_7   | 480 × 360       | 15          | ✓      |         | ✓      |
  * | 360p_8   | 480 × 360       | 30          | ✓      |         |        |
  * | 360p_9   | 640 × 360       | 15          | ✓      |         |        |
  * | 360p_10  | 640 × 360       | 24          | ✓      |         |        |
@@ -3363,6 +3469,7 @@ declare class VideoPlayer {
     config: PlayerConfig;
     onFirstVideoFrameDecoded?: () => void;
     onFirstVideoFrameRender?: () => void;
+    onVideoBufferReady?: () => void;
     onVideoStateChanged?: (state: VideoState) => void;
     freezeTimeCounterList: number[];
     renderFreezeAccTime: number;
@@ -3377,6 +3484,7 @@ declare class VideoPlayer {
     protected videoTrack?: MediaStreamTrack;
     protected videoElement: HTMLVideoElement;
     protected cacheVideoElement?: HTMLVideoElement;
+    protected cancelRVFId?: number;
     protected internal: boolean;
     get rendFrameRate(): number;
     get videoElementStatus(): MediaElementStatus;
@@ -3399,7 +3507,7 @@ declare class VideoPlayer {
     play(sessionId?: string): void;
     getCurrentFrame(): ImageData;
     getCurrentFrameToUint8Array(type: string, quality?: number): Promise<ImageTypedData>;
-    destroy(): void;
+    destroy(isKeepLastFrame?: boolean): void;
     protected initVideoElement(): void;
     protected resetVideoElement(): void;
     private startGetVideoDimensions;
@@ -3435,6 +3543,11 @@ export declare interface VideoPlayerConfig {
      * > - When playing the remote video track, the SDK uses cover mode by default.
      */
     fit?: "cover" | "contain" | "fill";
+    /**
+     * Whether to use the style
+     * @ignore
+     */
+    noStyle?: boolean;
 }
 
 export declare class VideoProcessorContext extends EventEmitter implements IProcessorContext {
@@ -3505,10 +3618,14 @@ export declare enum VideoState {
 declare class VisibilityWatcher extends EventEmitter {
     private _lastHiddenTime;
     private _lastVisibleTime;
+    needUploadStats: number[];
+    isCollectingStats: boolean;
     get visibility(): DocumentVisibilityState;
     get lastHiddenTime(): DOMHighResTimeStamp;
     get lastVisibleTime(): DOMHighResTimeStamp;
     constructor();
+    startCollectStats(): void;
+    stopCollectStats(): void;
 }
 
 export declare const visibilityWatcher: VisibilityWatcher;