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

# Media track APIs

> C++ media object APIs of the SMeeting Windows SDK: local microphone, camera, and screen objects, remote audio and video, MCU video, custom tracks, and local recording, plus the IMEETLocalMic, IMEETLocalCamera, IMEETLocalScreen, IMEETRemoteVideo, IMEETRemoteAudio, IMEETRecord, and IMEETVideo methods.

All of the following media objects are obtained through [ISMeetingChannel](/en/meeting/windows/api-reference/smeeting-channel).

***

## Local media stream APIs

### Get the local microphone object

```cpp theme={null}
virtual StatusCode getLocalMic(IMEETLocalMic**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| (output) | IMEETLocalMic\*\* | Output pointer to the local microphone object |

**Returns**

`StatusCode` - Error code

### Get the local camera object

```cpp theme={null}
virtual StatusCode getLocalCamera(IMEETLocalCamera**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| (output) | IMEETLocalCamera\*\* | Output pointer to the local camera object |

**Returns**

`StatusCode` - Error code

### Get the local screen sharing object

```cpp theme={null}
virtual StatusCode getLocalScreen(IMEETLocalScreen**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| (output) | IMEETLocalScreen\*\* | Output pointer to the local screen sharing object |

**Returns**

`StatusCode` - Error code

***

## Remote media stream APIs

### Get a remote video object

```cpp theme={null}
virtual StatusCode getRemoteVideo(std::string uid, std::string track_desc, IMEETRemoteVideo**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| track\_desc | std::string | Track description |
| (output) | IMEETRemoteVideo\*\* | Output pointer to the remote video object |

**Returns**

`StatusCode` - Error code

### Get a remote audio object

```cpp theme={null}
virtual StatusCode getRemoteAudio(std::string uid, IMEETRemoteAudio**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| uid | std::string | User ID |
| (output) | IMEETRemoteAudio\*\* | Output pointer to the remote audio object |

**Returns**

`StatusCode` - Error code

### Get the MCU video object

```cpp theme={null}
virtual StatusCode getMcuVideo(IMEETRemoteVideo**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| (output) | IMEETRemoteVideo\*\* | Output pointer to the MCU video object |

**Returns**

`StatusCode` - Error code

***

## Custom track APIs

### Get a custom video track

```cpp theme={null}
virtual StatusCode getCustomVideo(CustomPublishTrack* push, IMeetCustomVideoTrack**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| push | CustomPublishTrack\* | Custom track configuration |
| (output) | IMeetCustomVideoTrack\*\* | Output pointer to the custom video track object |

**Returns**

`StatusCode` - Error code

### Get a custom audio track

```cpp theme={null}
virtual StatusCode getCustomAudio(CustomPublishTrack* push, IMeetCustomAudioTrack**) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| push | CustomPublishTrack\* | Custom track configuration |
| (output) | IMeetCustomAudioTrack\*\* | Output pointer to the custom audio track object |

**Returns**

`StatusCode` - Error code

### Set the custom receive callback

```cpp theme={null}
virtual StatusCode setCustomRecvBack(RTC_Custom_FrameEvent e, void* ext) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| e | RTC\_Custom\_FrameEvent | Frame event callback function |
| ext | void\* | Extension data |

**Returns**

`StatusCode` - Error code

***

## Local recording APIs

### Get the local recording object

```cpp theme={null}
virtual StatusCode getLocalRecord(IMEETRecord** e) = 0;
```

**Parameters**

| Parameter | Type | Description |
| - | - | - |
| e | IMEETRecord\*\* | Pointer to the recording object |

**Returns**

`StatusCode` - Error code

> Starting with `1.0.0-alpha.5`, you no longer pass in a meeting ID; the current channel object's own meeting ID is used.

***

## IMEETLocalMic methods

### Request to turn on the microphone

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

### Turn off the microphone

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

### Switch microphones

```cpp theme={null}
virtual StatusCode switchMic(std::string name) = 0;
```

### Confirm turning on the microphone

```cpp theme={null}
virtual StatusCode confirmOpenMic(bool approve, std::string uid, Callback function = NULL) = 0;
```

***

## IMEETLocalCamera methods

Inherits from `IMEETVideo`.

### Switch cameras

```cpp theme={null}
virtual StatusCode switchCamera(std::string name, int w = 0, int h = 0) = 0;
```

### Request to turn on the camera

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

### Turn off the camera

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

### Confirm turning on the camera

```cpp theme={null}
virtual StatusCode confirmOpenCamera(bool approve, std::string uid, Callback function = nullptr) = 0;
```

***

## IMEETLocalScreen methods

Inherits from `IMEETVideo`.

### Request to share

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

### Stop sharing

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

### Add screen audio

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

### Update the stream output

```cpp theme={null}
virtual StatusCode updateStreamOutput(int w, int h) = 0;
```

### Confirm starting to share

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

***

## IMEETRemoteVideo methods

Inherits from `IMEETVideo`.

### Load the remote video

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

### Unload the remote video

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

***

## IMEETRemoteAudio methods

### Turn on the speaker

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

### Turn off the speaker

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

### Switch speakers

```cpp theme={null}
virtual StatusCode switchSpeaker(std::string name) = 0;
```

***

## IMEETRecord methods

### Set the recording file name

```cpp theme={null}
virtual StatusCode setRecordFileName(std::string filepath) = 0;
```

### Set the watermark

```cpp theme={null}
virtual StatusCode setWaterMask(std::string mask) = 0;
```

### Start recording

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

### Set the recording window

```cpp theme={null}
virtual StatusCode setRecordHwnd(void*, int, int, int, int) = 0;
```

### Set the recording layout member views

```cpp theme={null}
virtual StatusCode setRecordLayoutMemberView(std::string json) = 0;
```

### Pause recording

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

### Stop recording

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

***

## IMEETVideo methods

### Add a playback view

```cpp theme={null}
virtual StatusCode addPlayView(IRTCView* v) = 0;
```

### Remove a playback view

```cpp theme={null}
virtual StatusCode removePlayView(IRTCView* v) = 0;
```

### Remove all playback views

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