@zegocloud/zego-uikit-prebuilt 1.10.2 → 1.10.4

package/index.d.ts

@@ -72,10 +72,12 @@ declare enum ConsoleLevel {
   None = "None",
 }
 declare interface InRoomMessageInfo {
-  fromUser: ZegoUser;
-  message: string;
-  sendTime: number;
-  messageID: number;
+	fromUser: ZegoUser
+	message: string
+	sendTime: number
+	messageID: number
+	attrs?: any
+	status?: "SENDING" | "SENDED" | "FAILED"
 }
 declare enum ScreenSharingResolution {
 	_360P = "360p",
@@ -90,85 +92,87 @@ declare enum ScreenSharingResolution {
 declare interface ZegoCloudRoomConfig {
 	// 1 UI controls
 	// 1.1 Global
-	container?: HTMLElement | undefined | null; // Component container.
-	maxUsers?: number; // In-call participants range from [2 - 20]. The default value is unlimited.
+	container?: HTMLElement | undefined | null // Component container.
+	maxUsers?: number // In-call participants range from [2 - 20]. The default value is unlimited.
 	scenario?: {
-		mode?: ScenarioModel; // Scenario selection.
-		config?: ScenarioConfig[ScenarioModel]; // Specific configurations in the corresponding scenario.
-	};
-	console?: ConsoleLevel; // Used to problem localization, not a regular setup. While setting this can decide what severity of logs you want to print.
+		mode?: ScenarioModel // Scenario selection.
+		config?: ScenarioConfig[ScenarioModel] // Specific configurations in the corresponding scenario.
+	}
+	console?: ConsoleLevel // Used to problem localization, not a regular setup. While setting this can decide what severity of logs you want to print.
 	screenSharingConfig?: {
-		resolution?: ScreenSharingResolution;
-		width?: number;
-		height?: number;
-		frameRate?: number;
-		maxBitRate?: number;
-	}; // Screen sharing settings, resolution settings
+		resolution?: ScreenSharingResolution
+		width?: number
+		height?: number
+		frameRate?: number
+		maxBitRate?: number
+	} // Screen sharing settings, resolution settings
 
 	// 1.2 Prejoin view
-	showPreJoinView?: boolean; // Whether to display the prejoin view. Displayed by default.
+	showPreJoinView?: boolean // Whether to display the prejoin view. Displayed by default.
 	preJoinViewConfig?: {
-		title?: string; // The title of the prejoin view. Uses "enter Room" by default.
-	};
-	turnOnMicrophoneWhenJoining?: boolean; // Whether to enable the microphone when joining the call. Enabled by default.
-	turnOnCameraWhenJoining?: boolean; // Whether to enable the camera when joining the call. Enabled by default.
-	useFrontFacingCamera?: boolean; // Whether to use the front-facing camera when joining the room. Uses a front-facing camera by default.
-	videoResolutionDefault?: VideoResolution; // The default video resolution.
-	enableStereo?: boolean; // Whether to enable stereo, disenabled by default.
+		title?: string // The title of the prejoin view. Uses "enter Room" by default.
+	}
+	turnOnMicrophoneWhenJoining?: boolean // Whether to enable the microphone when joining the call. Enabled by default.
+	turnOnCameraWhenJoining?: boolean // Whether to enable the camera when joining the call. Enabled by default.
+	useFrontFacingCamera?: boolean // Whether to use the front-facing camera when joining the room. Uses a front-facing camera by default.
+	videoResolutionDefault?: VideoResolution // The default video resolution.
+	enableStereo?: boolean // Whether to enable stereo, disenabled by default.
 
 	// 1.3 Room view
-	showRoomDetailsButton?: boolean; // Whether to display room details. Displayed by default
-	showRoomTimer?: boolean; //  Whether to display the timer. Not displayed by default.
-	showMyCameraToggleButton?: boolean; // Whether to display the button for toggling my camera. Displayed by default.
-	showMyMicrophoneToggleButton?: boolean; // Whether to display the button for toggling my microphone. Displayed by default.
-	showAudioVideoSettingsButton?: boolean; // Whether to display the button for audio and video settings. Displayed by default.
-	showTurnOffRemoteCameraButton?: boolean; /// Whether to display the button for turning off the remote camera. Not displayed by default.
-	showTurnOffRemoteMicrophoneButton?: boolean; // Whether to display the button for turning off the remote microphone. Not displayed by default.
-	showTextChat?: boolean; // Whether to display the text chat interface on the right side. Displayed by default.
-	showUserList?: boolean; // Whether to display the participant list. Displayed by default.
-	showRemoveUserButton?: boolean; // Whether to display the button for removing participants. Not displayed by default.
+	showRoomDetailsButton?: boolean // Whether to display room details. Displayed by default
+	showRoomTimer?: boolean //  Whether to display the timer. Not displayed by default.
+	showMyCameraToggleButton?: boolean // Whether to display the button for toggling my camera. Displayed by default.
+	showMyMicrophoneToggleButton?: boolean // Whether to display the button for toggling my microphone. Displayed by default.
+	showAudioVideoSettingsButton?: boolean // Whether to display the button for audio and video settings. Displayed by default.
+	showTurnOffRemoteCameraButton?: boolean /// Whether to display the button for turning off the remote camera. Not displayed by default.
+	showTurnOffRemoteMicrophoneButton?: boolean // Whether to display the button for turning off the remote microphone. Not displayed by default.
+	showTextChat?: boolean // Whether to display the text chat interface on the right side. Displayed by default.
+	showUserList?: boolean // Whether to display the participant list. Displayed by default.
+	showRemoveUserButton?: boolean // Whether to display the button for removing participants. Not displayed by default.
 	lowerLeftNotification?: {
-		showUserJoinAndLeave?: boolean; // Whether to display notifications on the lower left area when participants join and leave the room. Displayed by default.
-		showTextChat?: boolean; // Whether to display the latest messages on the lower left area. Displayed by default.
-	};
+		showUserJoinAndLeave?: boolean // Whether to display notifications on the lower left area when participants join and leave the room. Displayed by default.
+		showTextChat?: boolean // Whether to display the latest messages on the lower left area. Displayed by default.
+	}
 	branding?: {
-		logoURL?: string; // The branding LOGO URL.
-	};
-	layout?: "Sidebar" | "Grid" | "Auto"; // The layout modes. Uses the Auto mode by default.
-	showLayoutButton?: boolean; // Whether to display the button for switching layouts. Displayed by default.
-	showNonVideoUser?: boolean; // Whether to display the non-video participants. Displayed by default.
-	showOnlyAudioUser?: boolean; // Whether to display audio-only participants. Displayed by default.
-	sharedLinks?: { name?: string; url?: string }[]; // Description of the generated shared links.
-	showScreenSharingButton?: boolean; // Whether to display the Screen Sharing button. Displayed by default.
-	showPinButton?: boolean; // Whether to display the Pin button. Displayed by default.
+		logoURL?: string // The branding LOGO URL.
+	}
+	layout?: "Sidebar" | "Grid" | "Auto" // The layout modes. Uses the Auto mode by default.
+	showLayoutButton?: boolean // Whether to display the button for switching layouts. Displayed by default.
+	showNonVideoUser?: boolean // Whether to display the non-video participants. Displayed by default.
+	showOnlyAudioUser?: boolean // Whether to display audio-only participants. Displayed by default.
+	sharedLinks?: { name?: string; url?: string }[] // Description of the generated shared links.
+	showScreenSharingButton?: boolean // Whether to display the Screen Sharing button. Displayed by default.
+	showPinButton?: boolean // Whether to display the Pin button. Displayed by default.
 	whiteboardConfig?: {
-		showAddImageButton?: boolean; // It's set to false by default. To use this feature, activate the File Sharing feature, and then import the plugin. Otherwise, this prompt will occur: "Failed to add image, this feature is not supported."
-		showCreateAndCloseButton?: boolean; // Whether to display the button that is used to create/turn off the whiteboard. Displayed by default.
-	};
-	showInviteToCohostButton?: boolean; // Whether to show the button that is used to invite the audience to co-host on the host end.
-	showRemoveCohostButton?: boolean; // Whether to show the button that is used to remove the audience on the host end.
-	showRequestToCohostButton?: boolean; // Whether to show the button that is used to request to co-host on the audience end.
-	rightPanelExpandedType?: RightPanelExpandedType; // Controls the type of the information displayed on the right panel, display "None" by default.
-	autoHideFooter?: boolean; // Whether to enable the footer auto-hide feature, enabled by default.
-	enableUserSearch?: boolean; // Whether to enable the user search feature, false by default.
+		showAddImageButton?: boolean // It's set to false by default. To use this feature, activate the File Sharing feature, and then import the plugin. Otherwise, this prompt will occur: "Failed to add image, this feature is not supported."
+		showCreateAndCloseButton?: boolean // Whether to display the button that is used to create/turn off the whiteboard. Displayed by default.
+	}
+	showInviteToCohostButton?: boolean // Whether to show the button that is used to invite the audience to co-host on the host end.
+	showRemoveCohostButton?: boolean // Whether to show the button that is used to remove the audience on the host end.
+	showRequestToCohostButton?: boolean // Whether to show the button that is used to request to co-host on the audience end.
+	rightPanelExpandedType?: RightPanelExpandedType // Controls the type of the information displayed on the right panel, display "None" by default.
+	autoHideFooter?: boolean // Whether to enable the footer auto-hide feature, enabled by default.
+	enableUserSearch?: boolean // Whether to enable the user search feature, false by default.
 	// 1.4 Leaving view
-	showLeavingView?: boolean; // Whether to display the leaving view. Displayed by default.
-	showLeaveRoomConfirmDialog?: boolean; // When leaving the room, whether to display a confirmation pop-up window, the default is true
+	showLeavingView?: boolean // Whether to display the leaving view. Displayed by default.
+	showLeaveRoomConfirmDialog?: boolean // When leaving the room, whether to display a confirmation pop-up window, the default is true
 
 	// 2 Related event callbacks
-	onJoinRoom?: () => void; // Callback for participants join the room.
-	onLeaveRoom?: () => void; // Callback for participants exits the room.
-	onUserJoin?: (users: ZegoUser[]) => void; // Callback for other participants join the call.
-	onUserLeave?: (users: ZegoUser[]) => void; // Callback for other participants leave the call.
-	onUserAvatarSetter?: (user: ZegoUser[]) => void; // Callback for the user avatar can be set.
-	onLiveStart?: (user: ZegoUser) => void; //  Callback for livestream starts.
-	onLiveEnd?: (user: ZegoUser) => void; // Callback for livestream ends.
-	onYouRemovedFromRoom?: () => void; // Callback for me removed from the room.
-	onInRoomMessageReceived?: (messageInfo: InRoomMessageInfo) => void; // Callback for room chat message
-	onInRoomCommandReceived?: (fromUser: ZegoUser, command: string) => void; // Callback for room command message
-	onInRoomTextMessageReceived?: (messages: ZegoSignalingInRoomTextMessage[]) => void; // Callback for room signaling text message
-	onInRoomCustomCommandReceived?: (command: ZegoSignalingInRoomCommandMessage[]) => void; // Callback for room custom command message
-	onReturnToHomeScreenClicked?: () => void; // Callback for click return to home screen button.
+	onJoinRoom?: () => void // Callback for participants join the room.
+	onLeaveRoom?: () => void // Callback for participants exits the room.
+	onUserJoin?: (users: ZegoUser[]) => void // Callback for other participants join the call.
+	onUserLeave?: (users: ZegoUser[]) => void // Callback for other participants leave the call.
+	onUserAvatarSetter?: (user: ZegoUser[]) => void // Callback for the user avatar can be set.
+	onLiveStart?: (user: ZegoUser) => void //  Callback for livestream starts.
+	onLiveEnd?: (user: ZegoUser) => void // Callback for livestream ends.
+	onYouRemovedFromRoom?: () => void // Callback for me removed from the room.
+	onInRoomMessageReceived?: (messageInfo: InRoomMessageInfo) => void // Callback for room chat message
+	onInRoomCommandReceived?: (fromUser: ZegoUser, command: string) => void // Callback for room command message
+	onInRoomTextMessageReceived?: (messages: ZegoSignalingInRoomTextMessage[]) => void // Callback for room signaling text message
+	onInRoomCustomCommandReceived?: (command: ZegoSignalingInRoomCommandMessage[]) => void // Callback for room custom command message
+	onReturnToHomeScreenClicked?: () => void // Callback for click return to home screen button.
+	addInRoomMessageMessageAttributes?: () => any //  add in room message message attribute. return custom message attribute.
+	customMessageUI?: (msg: InRoomMessageInfo) => Element // Custom message UI. need return Element.
 }
 
 export enum RightPanelExpandedType {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zegocloud/zego-uikit-prebuilt",
-	"version": "1.10.2",
+	"version": "1.10.4",
 	"description": "zegocloud prebuilt meeting webrtc sdk",
 	"keywords": [
 		"sdk",