> ## 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.

# Host management APIs

> C++ host and co-host APIs of the SMeeting Windows SDK on ISMeetingChannel: end the meeting, room-wide camera, microphone, chat, screenshot, lock, and sharing controls, member name, role, and chat permissions, controlling members' devices, removing members, raise-hand approval, and invites.

All of the following APIs are called on [ISMeetingChannel](/en/meeting/windows/api-reference/smeeting-channel) and can only be executed by the host or members with the corresponding permission.

***

## Room controls

### End the meeting

```cpp theme={null}
virtual StatusCode adminDestroyRoom(Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the room name

```cpp theme={null}
virtual StatusCode adminUpdateRoomName() = 0;
```

**Returns**

`StatusCode` - Error code

### Update the room video state

```cpp theme={null}
virtual StatusCode adminUpdateRoomVideoState() = 0;
```

**Returns**

`StatusCode` - Error code

### Update the room audio state

```cpp theme={null}
virtual StatusCode adminUpdateRoomAudioState() = 0;
```

**Returns**

`StatusCode` - Error code

### Update the room camera state

```cpp theme={null}
virtual StatusCode adminUpdateRoomCameraState(bool self_unmute_camera_disabled, bool camera_disabled, Callback back = NULL) = 0;
virtual StatusCode adminUpdateRoomCameraState(bool self_unmute_camera_disabled, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| self\_unmute\_camera\_disabled | bool | Whether members are prevented from turning their cameras back on themselves |
| camera\_disabled | bool | Whether cameras are disabled |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the room microphone state

```cpp theme={null}
virtual StatusCode adminUpdateRoomMicState(bool self_unmute_mic_disabled, bool mic_disabled, Callback back = NULL) = 0;
virtual StatusCode adminUpdateRoomMicState(bool self_unmute_mic_disabled, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| self\_unmute\_mic\_disabled | bool | Whether members are prevented from unmuting themselves |
| mic\_disabled | bool | Whether microphones are disabled |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the room chat state

```cpp theme={null}
virtual StatusCode adminUpdateRoomChatDisabled(bool chat_disabled, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| chat\_disabled | bool | Whether chat is disabled |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the room screenshot state

```cpp theme={null}
virtual StatusCode adminUpdateRoomScreenshotDisabled(bool screenshot_disabled, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| screenshot\_disabled | bool | Whether screenshots are disabled |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the room MCU mode

```cpp theme={null}
virtual StatusCode adminUpdateRoomMCUMode() = 0;
```

**Returns**

`StatusCode` - Error code

### Update the room lock state

```cpp theme={null}
virtual StatusCode adminUpdateRoomLocked(bool locked, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| locked | bool | Whether the room is locked |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Stop sharing in the room

```cpp theme={null}
virtual StatusCode adminStopRoomShare(Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the room sharing state

```cpp theme={null}
virtual StatusCode adminUpdateRoomShareState(bool v, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| v | bool | Sharing state |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update whether entering before the host is disabled

```cpp theme={null}
virtual StatusCode adminUpdateEnterBeforeHostDisabled(bool v, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| v | bool | Whether members are prevented from entering before the host |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

***

## Member controls

### Update a member's name

```cpp theme={null}
virtual StatusCode adminUpdateUserName(std::string uid, std::string name, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| name | std::string | New name |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update a member's role

```cpp theme={null}
virtual StatusCode adminUpdateUserRole(std::string uid, int role, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| role | int | Role type |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update a member's chat permission

```cpp theme={null}
virtual StatusCode adminUpdateUserChatDisabled(std::string uid, bool chat_disabled, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| chat\_disabled | bool | Whether chat is disabled |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Disable a member's camera

```cpp theme={null}
virtual StatusCode adminDisableUserCamera() = 0;
```

**Returns**

`StatusCode` - Error code

### Disable a member's microphone

```cpp theme={null}
virtual StatusCode adminDisableUserMic() = 0;
```

**Returns**

`StatusCode` - Error code

### Turn off a member's camera

```cpp theme={null}
virtual StatusCode adminCloseUserCamera(std::string uid, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Turn off a member's microphone

```cpp theme={null}
virtual StatusCode adminCloseUserMic(std::string uid, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Ask a member to turn on the camera

```cpp theme={null}
virtual StatusCode adminRequestUserOpenCamera(std::string uid, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Ask a member to turn on the microphone

```cpp theme={null}
virtual StatusCode adminRequestUserOpenMic(std::string uid, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Remove a member

```cpp theme={null}
virtual StatusCode adminKickUserOut(std::string uid, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Respond to a raised hand

```cpp theme={null}
virtual StatusCode adminConfirmHandup(std::string uid, int code, bool approve, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| code | int | Raise-hand type code |
| approve | bool | Whether to approve |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Invite devices to the meeting

```cpp theme={null}
virtual StatusCode adminInviteAgent(std::string no, int tp, std::vector<std::string> devs, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| no | std::string | Room number |
| tp | int | Type |
| devs | `std::vector<std::string>` | List of devices |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the invitee list

```cpp theme={null}
virtual StatusCode adminUpdateConferee(std::vector<std::string> conferee, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| conferee | `std::vector<std::string>` | List of invitees |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Update the layout

```cpp theme={null}
virtual StatusCode adminUpdateLayout(std::string layout, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| layout | std::string | Layout configuration |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Call users

```cpp theme={null}
virtual StatusCode adminCallUsers(std::vector<std::string> users, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| users | `std::vector<std::string>` | List of users |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Remind users

```cpp theme={null}
virtual StatusCode adminRemind(std::vector<std::string> users, bool sms, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| users | `std::vector<std::string>` | List of users |
| sms | bool | Whether to send an SMS |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code
