trtc-sdk-v5 5.5.3-beta.3 → 5.6.0-beta.2

package/index.d.ts

@@ -785,6 +785,20 @@
 	     * })
 	     */
 	    readonly TRACK: "track";
+	    /**
+	     * @since v5.6.0
+	     * @description received a new custom message.
+	     * @default 'custom-message'
+	     * @memberof module:EVENT
+	     * @example
+	     * trtc.on(TRTC.EVENT.CUSTOM_MESSAGE, event => {
+	     *    // event.userId: remote userId.
+	     *    // event.cmdId: message cmdId.
+	     *    // event.seq: message sequence number.
+	     *    // event.message: custom message data, type is ArrayBuffer.
+	     * })
+	     */
+	    readonly CUSTOM_MESSAGE: "custom-message";
 	};
 	declare interface TRTCEventTypes {
 	    [TRTCEvent.ERROR]: [RtcError];
@@ -862,6 +876,7 @@
 	        streamType?: TRTCStreamType;
 	        track: MediaStreamTrack;
 	    }];
+	    [TRTCEvent.CUSTOM_MESSAGE]: [CustomMessage];
 	}
  class TRTC extends EventEmitter<TRTCEventTypes> {
 	    /**
@@ -1501,6 +1516,28 @@
 	     * trtc.off('*');
 	     */
 	    off<T extends keyof TRTCEventTypes>(event: T | '*', handler: T extends '*' ? never : (...args: TRTCEventTypes[T]) => void, context?: any): this;
+	    /**
+	     * Get audio track
+	     *
+	     * @returns {MediaStreamTrack?} Audio track
+	     * @param {Object|string} [config] If not passed, get the local microphone audioTrack
+	     * @param {string} [config.userId] If not passed or passed an empty string, get the local audioTrack. Pass the userId of the remote user to get the remote user's audioTrack.
+	     * @param {STREAM_TYPE_MAIN|STREAM_TYPE_SUB} [config.streamType] - stream type:
+	     * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream (user's microphone)(default)
+	     * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream (user's screen sharing audio). Only works for local screen sharing audio because there is only one remote audioTrack, and there is no distinction between Main and Sub for remote audioTrack.
+	     * @memberof TRTC
+	     * @example
+	     * // Version before v5.4.3
+	     * trtc.getAudioTrack(); // Get local microphone audioTrack, captured by trtc.startLocalAudio()
+	     * trtc.getAudioTrack('remoteUserId'); // Get remote audioTrack
+	     *
+	     * // Since v5.4.3+, you can get local screen audioTrack by passing the streamType = TRTC.STREAM_TYPE_SUB
+	     * trtc.getAudioTrack({ streamType: TRTC.STREAM_TYPE_SUB });
+	     */
+	    getAudioTrack(configOrUserId?: {
+	        userId?: string;
+	        streamType?: TRTCStreamType;
+	    } | string): MediaStreamTrack | null;
 	    /**
 	     * Get video track
 	     *
@@ -1526,27 +1563,23 @@
 	        streamType?: TRTCStreamType;
 	    }): MediaStreamTrack | null;
 	    /**
-	     * Get audio track
-	     *
-	     * @returns {MediaStreamTrack?} Audio track
-	     * @param {Object|string} [config] If not passed, get the local microphone audioTrack
-	     * @param {string} [config.userId] If not passed or passed an empty string, get the local audioTrack. Pass the userId of the remote user to get the remote user's audioTrack.
-	     * @param {STREAM_TYPE_MAIN|STREAM_TYPE_SUB} [config.streamType] - stream type:
-	     * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream (user's microphone)(default)
-	     * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream (user's screen sharing audio). Only works for local screen sharing audio because there is only one remote audioTrack, and there is no distinction between Main and Sub for remote audioTrack.
-	     * @memberof TRTC
+	     * Get video snapshot <br>
+	     * Notice: must play the video before it can obtain the snapshot. If there is no playback, an empty string will be returned.
+	     * @param {string} config.userId - Remote user ID
+	     * @param {TRTC.TYPE.STREAM_TYPE_MAIN|TRTC.TYPE.STREAM_TYPE_SUB} config.streamType
+	     * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream
+	     * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream
+	     * @since 5.4.0
 	     * @example
-	     * // Version before v5.4.3
-	     * trtc.getAudioTrack(); // Get local microphone audioTrack, captured by trtc.startLocalAudio()
-	     * trtc.getAudioTrack('remoteUserId'); // Get remote audioTrack
-	     *
-	     * // Since v5.4.3+, you can get local screen audioTrack by passing the streamType = TRTC.STREAM_TYPE_SUB
-	     * trtc.getAudioTrack({ streamType: TRTC.STREAM_TYPE_SUB });
+	     * // get self main stream video frame
+	     * trtc.getVideoSnapshot()
+	     * // get self sub stream video frame
+	     * trtc.getVideoSnapshot({streamType:TRTC.TYPE.STREAM_TYPE_SUB})
+	     * // get remote user main stream video frame
+	     * trtc.getVideoSnapshot({userId: 'remote userId', streamType:TRTC.TYPE.STREAM_TYPE_MAIN})
+	     * @memberof TRTC
 	     */
-	    getAudioTrack(configOrUserId?: {
-	        userId?: string;
-	        streamType?: TRTCStreamType;
-	    } | string): MediaStreamTrack | null;
+	    getVideoSnapshot(config?: VideoFrameConfig): string;
 	    setCurrentSpeaker(speakerId: string): void;
 	    /**
 	     * Send SEI Message <br>
@@ -1599,23 +1632,39 @@
 	        seiPayloadType: number;
 	    }): void;
 	    /**
-	     * Get video snapshot <br>
-	     * Notice: must play the video before it can obtain the snapshot. If there is no playback, an empty string will be returned.
-	     * @param {string} config.userId - Remote user ID
-	     * @param {TRTC.TYPE.STREAM_TYPE_MAIN|TRTC.TYPE.STREAM_TYPE_SUB} config.streamType
-	     * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: Main stream
-	     * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: Sub stream
-	     * @since 5.4.0
+	     * Send Custom Message to all remote users in the room. <br>
+	     *
+	     * Note:
+	     *
+	     * 1. Only {@link module:TYPE.ROLE_ANCHOR TRTC.TYPE.ROLE_ANCHOR} can call sendCustomMessage.
+	     * 2. You should call this api after {@link TRTC#enterRoom TRTC.enterRoom} successfully.
+	     * @since v5.6.0
+	     * @see Listen for the event {@link module:EVENT.CUSTOM_MESSAGE TRTC.EVENT.CUSTOM_MESSAGE} to receive custom message.
+	     * @param {object} data
+	     * @param {number} data.cmdId message Id. Integer, range [1, 10]. You can set different cmdId for different types of messages to reduce the delay of transferring message.
+	     * @param {ArrayBuffer} data.message - message content. <br/>
+	     * - Maximum 1KB(Byte) sent in a single call.
+	     * - Maximum 30 calls per second
+	     * - Maximum 8KB sent per second.
+	     * @param {boolean} [data.ordered=true] - Send messages in order and as reliably as possible. The receiver will also receive the message in order.
 	     * @example
-	     * // get self main stream video frame
-	     * trtc.getVideoSnapshot()
-	     * // get self sub stream video frame
-	     * trtc.getVideoSnapshot({streamType:TRTC.TYPE.STREAM_TYPE_SUB})
-	     * // get remote user main stream video frame
-	     * trtc.getVideoSnapshot({userId: 'remote userId', streamType:TRTC.TYPE.STREAM_TYPE_MAIN})
-	     * @memberof TRTC
+	     * // send custom message
+	     * trtc.sendCustomMessage({
+	     *   cmdId: 1,
+	     *   message: new TextEncoder().encode('hello').buffer,
+	     *   ordered: true,
+	     * });
+	     *
+	     * // receive custom message
+	     * trtc.on(TRTC.EVENT.CUSTOM_MESSAGE, event => {
+	     *    // event.userId: remote userId.
+	     *    // event.cmdId: message cmdId.
+	     *    // event.seq: message sequence number.
+	     *    // event.message: custom message data, type is ArrayBuffer.
+	     *    console.log(`received custom msg from ${event.userId}, message: ${new TextDecoder().decode(event.message)}`)
+	     * })
 	     */
-	    getVideoSnapshot(config?: VideoFrameConfig): string;
+	    sendCustomMessage(data: CustomMessageData): void;
 	    static EVENT: {
 	        readonly ERROR: "error";
 	        readonly AUTOPLAY_FAILED: "autoplay-failed";
@@ -1637,6 +1686,7 @@
 	        readonly STATISTICS: "statistics";
 	        readonly SEI_MESSAGE: "sei-message";
 	        readonly TRACK: "track";
+	        readonly CUSTOM_MESSAGE: "custom-message";
 	    };
 	    static ERROR_CODE: {
 	        INVALID_PARAMETER: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.5.3-beta.3",
+  "version": "5.6.0-beta.2",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",

package/plugins/cdn-streaming/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/cdn-streaming",
-  "version": "5.5.1",
+  "version": "5.5.2",
   "description": "TRTC Web SDK 5.x CDN streaming plugin",
   "main": "./cdn-streaming.esm.js",
   "author": "longyuqi <longyuqi@tencent.com>",

package/plugins/video-effect/beauty/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/beauty",
-  "version": "5.5.1",
+  "version": "5.5.2",
   "description": "TRTC Web SDK 5.x beauty plugin",
   "main": "./beauty.esm.js",
   "author": "longyuqi <longyuqi@tencent.com>",

package/plugins/video-effect/virtual-background/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rtc-plugin/virtual-background",
-  "version": "5.5.1",
+  "version": "5.5.2",
   "description": "TRTC Web SDK 5.x virtual background plugin",
   "main": "./virtual-background.esm.js",
   "author": "longyuqi <longyuqi@tencent.com>",