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

# ISMeetingChannel meeting API

> Meeting-level C++ API of the SMeeting Windows SDK on ISMeetingChannel: channel ID and settings, setting the event handler before enter(), entering the meeting and exiting the waiting room, room and member info, nickname, chat, custom messages, raise hand, and waiting room management.

`ISMeetingChannel` represents one meeting object. It is created by `ISMeetingEngine::createChannel()` or `createChannelByMeetingId()` and destroyed by `ISMeetingEngine::leaveChannel()`.

***

## Channel basics

### Get the channel ID

```cpp theme={null}
virtual std::string getChannelId() = 0;
```

Returns the room number / meeting ID passed in when the channel object was created. The ID stays the same even if the object switches to entering by meeting ID midway because of the waiting room, and it is the key `leaveChannel()` uses to release the object.

### Get the channel settings object

```cpp theme={null}
virtual StatusCode getSetting(ISMeetingChannelSetting** sett) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| sett | ISMeetingChannelSetting\*\* | Output pointer to the settings object |

**Returns**

`StatusCode` - Error code

### Set the channel event handler

```cpp theme={null}
virtual StatusCode setEventHandler(ISMeetingChannelEvent* e) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| e | ISMeetingChannelEvent\* | Event handler object |

**Returns**

`StatusCode` - Error code

> You must set the handler before `enter()`: events raised while entering the meeting (member list, camera state, and so on) fire before `enter()` returns.

***

## Enter / exit APIs

### Enter the meeting

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

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| pass | std::string | Meeting password |
| back | Callback | Asynchronous callback |

`enter()` calls `/v1/meet/enter` and joins the underlying SRTC channel. Set the display name, avatar, streaming vendor, and so on for entering the meeting through `ISMeetingChannelSetting` before calling `enter()`.

**Returns**

`StatusCode` - Error code

### Exit the waiting room

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

**Parameters**

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

**Returns**

`StatusCode` - Error code

***

## Room info APIs

### Get your own info

```cpp theme={null}
virtual StatusCode getMe(std::string& s) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| s | std::string& | Output your own info as a JSON string |

**Returns**

`StatusCode` - Error code

### Get the room info

```cpp theme={null}
virtual StatusCode getRoom(std::string& s) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| s | std::string& | Output the room info as a JSON string |

**Returns**

`StatusCode` - Error code

### Get info for all members

```cpp theme={null}
virtual StatusCode getMembers(std::string& s) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| s | std::string& | Output member info as a JSON string |

**Returns**

`StatusCode` - Error code

### Get info for a specific member

```cpp theme={null}
virtual StatusCode getMember(std::string uid, std::string& s) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| s | std::string& | Output member info as a JSON string |

**Returns**

`StatusCode` - Error code

### Get extended info

```cpp theme={null}
virtual StatusCode getOpt(std::string& opt) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| opt | std::string& | Output extended info as a JSON string |

**Returns**

`StatusCode` - Error code

***

## User operation APIs

### Update your own name

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

**Parameters**

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

**Returns**

`StatusCode` - Error code

### Send a chat message

```cpp theme={null}
virtual StatusCode sendRoomChatMessage(int tp, std::string msg, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| tp | int | Message type |
| msg | std::string | Message content |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Send a custom message

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

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| First parameter | std::string | Message key |
| Second parameter | std::string | Message content |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Raise a hand

```cpp theme={null}
virtual StatusCode requestHandup(int code, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| code | int | Raise-hand type code |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Lower a raised hand

```cpp theme={null}
virtual StatusCode cancelHandup(int code, Callback back = NULL) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| code | int | Raise-hand type code |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

### Get the online member list

```cpp theme={null}
virtual StatusCode listOnlineMember(std::string _meetid, Callback back = nullptr) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| \_meetid | std::string | Meeting ID |
| back | Callback | Asynchronous callback |

**Returns**

`StatusCode` - Error code

***

## Waiting room APIs

### Update the waiting room state

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

**Parameters**

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

**Returns**

`StatusCode` - Error code

### Get the waiting room user list

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

**Parameters**

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

**Returns**

`StatusCode` - Error code

### Move into the waiting room

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

**Parameters**

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

**Returns**

`StatusCode` - Error code

### Move out of the waiting room

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

**Parameters**

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

**Returns**

`StatusCode` - Error code