> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stmlink.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> 对外开放的服务端接口有两组前缀，都用同一套鉴权：`/server/v1/...`（SRTC 与 SMeeting 的主接口）和 `/stm/srvapi/v1/...`（SMeeting 的用户体系，服务端极简对接会用到）。鉴权是 app_id + nonce + timestamp + signature 四个请求头，用 app_key 做 HMAC-SHA256 签名，只能从业务方自己的后端调用。除这两组前缀外的接口均为内部接口，不要建议客户调用。 Public server APIs use two path prefixes with the same authentication: `/server/v1/...` (the main APIs of both SRTC and SMeeting) and `/stm/srvapi/v1/...` (the SMeeting user system, used by server-side low-code integration). Authenticate with four request headers, app_id + nonce + timestamp + signature, where signature is HMAC-SHA256 keyed with app_key; call these APIs only from the customer's own backend. Any other path is internal: never suggest calling it.
> app_key 是服务端密钥，绝不能出现在客户端代码、前端配置或移动 App 里。客户端加入频道用的 token 必须由业务方后端签发后下发（SRTC 走 `/server/v1/channel/grant`，SMeeting 走 `/stm/srvapi/v1/member/grant`）。 app_key is a server-side secret and must never appear in client code, frontend config, or a mobile app. The token a client uses to join must be issued by the customer's backend and passed down to the client (SRTC: `/server/v1/channel/grant`; SMeeting: `/stm/srvapi/v1/member/grant`).
> SRTC 与 SMeeting 是上下两层不同的产品，术语不通用：SRTC 是音视频底座，说「频道 channel」「加入 / 退出」；SMeeting 建在 SRTC 之上，说「房间 room」「会议 meeting」「进入 / 退出」。回答时按用户所在的层用对应术语，不要把「房间」「会议」安到 SRTC 的接口上，也不要用「频道」「加入 / 离开」描述 SMeeting 的概念（接口标识符原样保留）。 SRTC and SMeeting are two separate layers with different terminology. SRTC is the audio/video foundation: it has channels, and users join and leave a channel. SMeeting is built on top of SRTC: it has rooms and meetings, and members enter and exit a meeting. Answer in the terms of the layer the user is working with: never apply "room" or "meeting" to SRTC APIs, and never describe SMeeting concepts in prose with "channel", "join", or "leave" (API identifiers such as `force_join` keep their literal names).
> 同一能力在各端 SDK 里的包名、类名、方法名并不相同。写示例代码时请使用文档中该端自己的 API，不要把一个端的写法套到另一个端上。苹果平台每个产品都有两套 SDK（Swift 原生与 Objective-C），两套 API 不能混用。 Package, class, and method names differ between platform SDKs for the same capability. In sample code, use the API documented for that platform; never carry one platform's code over to another. On Apple platforms each product ships two SDKs (native Swift and Objective-C) whose APIs must not be mixed.

# Events

> Every room event the SMeeting Web SDK delivers through onNotifyRoomEvent: the RoomEvent structure, each CommonRoomEventType and RoomEventType value, when it fires, and which data type it carries.

You can listen to every event through `smeeting.onNotifyRoomEvent`

```typescript theme={null}
// Handle callback events
smeeting.onNotifyRoomEvent = (evt: RoomEvent) => {
  console.log('Received room event', evt);
  switch (evt.type) {
      // ...
  }
})
```

RoomEvent is defined as follows:

```typescript theme={null}
/** Room event notification */
declare class RoomEvent {
    /** Event type */
    type: CommonRoomEventType;
    /** Data carried by the event */
    data?: any;
}
```

CommonRoomEventType and the corresponding `data` are defined as follows:

```typescript theme={null}
    /** Automatic reconnection after a disconnect has started, no data */
    static readonly RECONNECTING = 'reconnecting';
    /** Reconnected; fires after reconnecting successfully following a disconnect, no data */
    static readonly RECONNECTED = 'reconnected';
    /** You were forced to exit the meeting; data is DisconnectEventData */
    static readonly DISCONNECTED = 'disconnected';

    /** Another user entered the meeting; data is UserInfo */
    static readonly USER_ENTER = 'user_enter';
    /** Another user exited the meeting; data is UserExitEventData */
    static readonly USER_EXIT = 'user_exit';
    /** A user's camera state changed (changed by yourself/others, or by the host); data is UserCameraStateChangeEventData */
    static readonly USER_CAMREA_STATE_CHANGED = "user_camera_state_changed";
    /** A user's mic state changed (changed by yourself/others, or by the host); data is UserMicStateChangeEventData */
    static readonly USER_MIC_STATE_CHANGED = "user_mic_state_changed";
    /** A user's display name changed (changed by yourself/others, or by the host); data is UserNameChangeEventData */
    static readonly USER_NAME_CHANGED = "user_name_changed";
    /** A user's role changed; data is UserRoleChangeEventData */
    static readonly USER_ROLE_CHANGED = 'user_role_changed';
    /** A user's chat-disabled state changed; data is UserChatDisabledChangeEventData */
    static readonly USER_CHAT_DISABLED_CHANGED = 'user_chat_disabled_changed';
    /** User raise-hand events (received only by the host and co-hosts); data is UserHandupEventData */
    static readonly USER_HANDUP = 'user_handup';

    /** The room's camera-disabled state changed; data is RoomCameraStateChangeEventData */
    static readonly ROOM_CAMREA_STATE_CHANGED = 'room_camera_state_changed';
    /** The room's mic-disabled state changed; data is RoomMicStateChangeEventData */
    static readonly ROOM_MIC_STATE_CHANGED = 'room_mic_state_changed';
    /** The room's chat-disabled state changed; data is RoomChatDisabledChangeEventData */
    static readonly ROOM_CHAT_DISABLED_CHANGED = 'room_chat_disabled_changed';
    /** The room's screenshot-disabled state changed; data is RoomScreenshotDisabledChangeEventData */
    static readonly ROOM_SCREENSHOT_DISABLED_CHANGED = 'room_screenshot_disabled_changed';
    /** The room's watermark-disabled state changed; data is RoomWatermarkDisabledChangeEventData */
    static readonly ROOM_WATERMARK_DISABLED_CHANGED = 'room_watermark_disabled_changed';
    /** The room's locked state changed; data is RoomLockedChangeEventData */
    static readonly ROOM_LOCKED_CHANGED = 'room_locked_changed';
    /** Sharing started in the room; data is RoomShareStartEventData */
    static readonly ROOM_SHARE_START = 'room_share_start';
    /** Sharing stopped in the room; data is RoomShareStopEventData */
    static readonly ROOM_SHARE_STOP = 'room_share_stop';
    /** Room chat message; data is RoomChatMsgEventData */
    static readonly ROOM_CHAT_MSG = 'room_chat_msg';
    /** Room custom message; data is RoomCustomMsgEventData */
    static readonly ROOM_CUSTOM_MSG = 'room_custom_msg';
    /** Room MCU task; data is RoomMcuTaskEventData */
    static readonly ROOM_MCU_TASK = 'room_mcu_task';
    /** Failed to enter the room; data is RoomJoinFailedEventData */
    static readonly ROOM_JOIN_FAILED = 'room_join_failed';

    /** The host handled your raise-hand request; data is AdminConfirmHandupEventData */
    static readonly ADMIN_CONFIRM_HANDUP = 'admin_confirm_handup';
    /** The host asks you to unmute your mic; data is AdminRequestOpenMicEventData */
    static readonly ADMIN_REQUEST_OPEN_MIC = 'admin_request_open_mic';
    /** The host asks you to turn on your camera; data is AdminRequestOpenCameraEventData */
    static readonly ADMIN_REQUEST_OPEN_CAMERA = 'admin_request_open_camera';

```

RoomEventType and the corresponding `data` are defined as follows:

```typescript theme={null}
/** Room event types */
export class RoomEventType extends CommonRoomEventType {
     /** Device plugged in; data is MediaDeviceInfo */
     static readonly DEVICE_ADD = 'device_add';
     /** Device unplugged; data is MediaDeviceInfo */
     static readonly DEVICE_REMOVE = 'device_remove';
     /** Track stopped; data is BaseTrack */
     static readonly TRACK_ENDED = 'track_ended';
     /** Track has no data */
     static readonly TRACK_MUTED = 'track_muted';
     /** Track data resumed */
     static readonly TRACK_UNMUTED = 'track_unmuted';
}

```
