@agora-js/media 4.23.0 → 4.23.2-1

package/media.d.ts

@@ -363,6 +363,10 @@ export declare interface AudioEncoderConfiguration {
  */
 export declare type AudioEncoderConfigurationPreset = keyof typeof AUDIO_ENCODER_CONFIG_SETTINGS;
 
+export declare interface AudioMetadata {
+    value: Uint8Array;
+}
+
 export declare interface AudioPlaybackOptions {
     /**
      * 控制人声是否要被播放，默认为 `true`
@@ -1405,12 +1409,17 @@ declare function event_beauty_effect_overload(): void;
 /**
  * 首帧音频或视频解码时触发。
  *
+ * > 注意：
+ * > 该事件只有在本地调用了 [IRemoteTrack.play]{@link play} 后才会触发。
  * @event
  * @asMemberOf IRemoteTrack
  */
 /** @en
  * Occurs when the first remote audio or video frame is decoded.
  *
+ * > Note:
+ * > To trigger this callback, the local client needs to call [IRemoteTrack.play]{@link play}.
+ *
  * @event
  * @asMemberOf IRemoteTrack
  */
@@ -2879,15 +2888,25 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
     setEnabled(enabled: boolean): Promise<void>;
 }
 
-export declare function interceptLocalAudioFrame(sender: RTCRtpSender): Promise<void>;
+export declare function interceptLocalAudioFrame(sender: RTCRtpSender, options?: InterceptLocalAudioFrameOptions): Promise<void>;
+
+export declare interface InterceptLocalAudioFrameOptions {
+    metadata?: () => Uint8Array | undefined;
+}
 
 export declare function interceptLocalVideoFrame(sender: RTCRtpSender, localVideoTrack: LocalVideoTrack): Promise<void>;
 
-export declare function interceptRemoteAudioFrame(receiver: RTCRtpReceiver): Promise<void>;
+export declare function interceptRemoteAudioFrame(receiver: RTCRtpReceiver, options?: InterceptRemoteAudioFrameOptions): Promise<void>;
+
+export declare interface InterceptRemoteAudioFrameOptions {
+    enableTopn?: boolean;
+    enableMetadata?: boolean;
+    onMetadata?: (metadata: Uint8Array) => void;
+}
 
 export declare function interceptRemoteVideoFrame(receiver: RTCRtpReceiver, options?: InterceptVideoFrameOptions): Promise<void>;
 
-declare interface InterceptVideoFrameOptions {
+export declare interface InterceptVideoFrameOptions {
     onSei?: (sei: Uint8Array) => void;
 }
 
@@ -3462,6 +3481,7 @@ export declare class LocalAudioTrack extends LocalTrack implements ILocalAudioTr
     readonly trackMediaType: "audio" | "video";
     _encoderConfig?: AudioEncoderConfiguration;
     _trackSource: AudioTrackSource | FakeTrackSource;
+    metadata: AudioMetadata[];
     /**
      * @description This method is used to init WebAudio, if you're sure you don't want to use WebAudio, call _trackSource
      */

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@agora-js/media",
-	"version": "4.23.0",
+	"version": "4.23.2-1",
 	"description": "media module across @agora-js packages",
 	"main": "AgoraRTC_N-media.js",
 	"module": "AgoraRTC_N-media.esm.mjs",
@@ -23,9 +23,9 @@
 	"homepage": "https://api-ref.agora.io/en/voice-sdk/web/4.x/index.html",
 	"peerDependencies": {},
 	"dependencies": {
-		"@agora-js/shared": "4.23.0",
-		"@agora-js/report": "4.23.0",
-		"axios": "^1.7.7",
+		"@agora-js/shared": "4.23.2-1",
+		"@agora-js/report": "4.23.2-1",
+		"axios": "^1.8.3",
 		"agora-rte-extension": "^1.2.4",
 		"webrtc-adapter": "8.2.0"
 	}

package/rtc-sdk-media_en.d.ts

@@ -229,6 +229,10 @@ export declare interface AudioEncoderConfiguration {
  */
 export declare type AudioEncoderConfigurationPreset = keyof typeof AUDIO_ENCODER_CONFIG_SETTINGS;
 
+export declare interface AudioMetadata {
+    value: Uint8Array;
+}
+
 export declare interface AudioPlaybackOptions {
     origin?: boolean;
     mixing?: boolean;
@@ -919,6 +923,9 @@ declare function event_beauty_effect_overload(): void;
 /**
  * Occurs when the first remote audio or video frame is decoded.
  *
+ * > Note:
+ * > To trigger this callback, the local client needs to call [IRemoteTrack.play]{@link play}.
+ *
  * @event
  * @asMemberOf IRemoteTrack
  */
@@ -1766,15 +1773,25 @@ export declare interface IMicrophoneAudioTrack extends ILocalAudioTrack {
     setEnabled(enabled: boolean): Promise<void>;
 }
 
-export declare function interceptLocalAudioFrame(sender: RTCRtpSender): Promise<void>;
+export declare function interceptLocalAudioFrame(sender: RTCRtpSender, options?: InterceptLocalAudioFrameOptions): Promise<void>;
+
+export declare interface InterceptLocalAudioFrameOptions {
+    metadata?: () => Uint8Array | undefined;
+}
 
 export declare function interceptLocalVideoFrame(sender: RTCRtpSender, localVideoTrack: LocalVideoTrack): Promise<void>;
 
-export declare function interceptRemoteAudioFrame(receiver: RTCRtpReceiver): Promise<void>;
+export declare function interceptRemoteAudioFrame(receiver: RTCRtpReceiver, options?: InterceptRemoteAudioFrameOptions): Promise<void>;
+
+export declare interface InterceptRemoteAudioFrameOptions {
+    enableTopn?: boolean;
+    enableMetadata?: boolean;
+    onMetadata?: (metadata: Uint8Array) => void;
+}
 
 export declare function interceptRemoteVideoFrame(receiver: RTCRtpReceiver, options?: InterceptVideoFrameOptions): Promise<void>;
 
-declare interface InterceptVideoFrameOptions {
+export declare interface InterceptVideoFrameOptions {
     onSei?: (sei: Uint8Array) => void;
 }
 
@@ -2099,6 +2116,7 @@ export declare class LocalAudioTrack extends LocalTrack implements ILocalAudioTr
     readonly trackMediaType: "audio" | "video";
     _encoderConfig?: AudioEncoderConfiguration;
     _trackSource: AudioTrackSource | FakeTrackSource;
+    metadata: AudioMetadata[];
     get _source(): AudioTrackSource;
     set _source(source: AudioTrackSource | FakeTrackSource);
     _enabled: boolean;