@naviedu/room-platform-react 0.0.27 → 0.0.28

package/index.d.ts

@@ -59,7 +59,7 @@ export declare function RoomActionButton({ icon, state, ...props }: ComponentPro
 
 declare type RoomActionName = (typeof roomActionNames)[number];
 
-declare const roomActionNames: readonly [RoomPlatformAction.PRIVATE_ROOM_INVITE, RoomPlatformAction.PRIVATE_ROOM_RESPOND, RoomPlatformAction.PRIVATE_ROOM_CLOSE, RoomPlatformAction.PRIVATE_ROOM_SCREEN_SHARE_START, RoomPlatformAction.PRIVATE_ROOM_SCREEN_SHARE_STOP, RoomPlatformAction.MONITOR_START, RoomPlatformAction.MONITOR_STOP, RoomPlatformAction.MODERATION_MUTE, RoomPlatformAction.MODERATION_REMOVE, RoomPlatformAction.MODERATION_LOWER_HAND, RoomPlatformAction.WHITEBOARD_CLEAR, RoomPlatformAction.SPEAK_REQUEST, RoomPlatformAction.SPEAK_CANCEL, RoomPlatformAction.SPEAK_APPROVE, RoomPlatformAction.SPEAK_REJECT, RoomPlatformAction.SPEAKER_SET, RoomPlatformAction.SPEAKER_CLEAR];
+declare const roomActionNames: readonly [RoomPlatformAction.PRIVATE_ROOM_INVITE, RoomPlatformAction.PRIVATE_ROOM_RESPOND, RoomPlatformAction.PRIVATE_ROOM_CLOSE, RoomPlatformAction.PRIVATE_ROOM_SCREEN_SHARE_START, RoomPlatformAction.PRIVATE_ROOM_SCREEN_SHARE_STOP, RoomPlatformAction.MONITOR_START, RoomPlatformAction.MONITOR_STOP, RoomPlatformAction.MODERATION_MUTE, RoomPlatformAction.MODERATION_REMOVE, RoomPlatformAction.MODERATION_LOWER_HAND, RoomPlatformAction.WHITEBOARD_CLEAR, RoomPlatformAction.SPEAK_REQUEST, RoomPlatformAction.SPEAK_CANCEL, RoomPlatformAction.SPEAK_APPROVE, RoomPlatformAction.SPEAK_REJECT, RoomPlatformAction.SPEAKER_SET, RoomPlatformAction.SPEAKER_CLEAR, RoomPlatformAction.MODE_SET];
 
 export declare type RoomActionState = {
     label: string;
@@ -69,6 +69,7 @@ export declare type RoomActionState = {
 
 declare interface RoomControlState {
     revision: string;
+    mode: string;
     raisedHandParticipantIdentities: string[];
     activeSpeakerParticipantIdentity?: string;
     monitorActive: boolean;
@@ -155,7 +156,8 @@ declare enum RoomPlatformAction {
     SPEAK_APPROVE = "speak.approve",
     SPEAK_REJECT = "speak.reject",
     SPEAKER_SET = "speaker.set",
-    SPEAKER_CLEAR = "speaker.clear"
+    SPEAKER_CLEAR = "speaker.clear",
+    MODE_SET = "room.mode.set"
 }
 
 export declare type RoomPlatformActionName = RoomActionName;
@@ -198,6 +200,7 @@ declare const RoomPlatformCapability: {
     readonly MEDIA_PUBLISH_AUDIO: "media:publish_audio";
     readonly MEDIA_PUBLISH_VIDEO: "media:publish_video";
     readonly MEDIA_SHARE_SCREEN: "media:share_screen";
+    readonly ROOM_SET_MODE: "room:set_mode";
     readonly DATA_PUBLISH: "data:publish";
     readonly ROOM_SPEAK_REQUEST: "room:speak_request";
     readonly ROOM_MODERATE: "room:moderate";
@@ -327,6 +330,7 @@ export declare type RoomPlatformExtensionProps = {
     actions: RoomPlatformActions;
     capabilities: readonly RoomPlatformCapabilityName[];
     connectionStatus: RoomPlatformConnectionStatus;
+    currentMode: string;
     currentParticipant?: RoomParticipantPresence;
     presentation: RoomPlatformPresentation;
     roomId?: string;
@@ -401,6 +405,17 @@ export declare function RoomPlatformLocalPreview({ trackRef, localPreviewTrack,
 
 export declare function RoomPlatformMediaRuntime({ children }: PropsWithChildren): JSX.Element;
 
+export declare type RoomPlatformModeConfig = {
+    modes?: readonly {
+        key: string;
+        label: string;
+    }[];
+    beforeModeChange?: (input: {
+        from: string;
+        to: string;
+    }) => boolean | Promise<boolean>;
+};
+
 export declare function RoomPlatformMonitorSidebarVideoTile(props: RoomPlatformMonitorSidebarVideoTileProps): JSX.Element;
 
 export declare type RoomPlatformMonitorSidebarVideoTileProps = Omit<RoomPlatformMonitorVideoTileProps, 'testId'> & {
@@ -565,7 +580,7 @@ export declare type RoomPlatformRoomProps = {
     completionAction?: RoomPlatformCompletionActionConfig;
     extensions?: RoomPlatformExtensions;
     launchToken: string;
-    isPracticeMode?: boolean;
+    modeConfig?: RoomPlatformModeConfig;
     shadowDom?: boolean;
     sizing?: RoomPlatformSizing;
     onError?: (event: RoomPlatformErrorEvent) => void;