> ## 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.
# MeetingKit
> Global singleton of the SMeeting iOS (Objective-C) SDK: login and logout, IM, meeting queries and scheduling, creating and querying room instances, local capture and preview, audio routing, virtual background, and screen capture extension APIs. Read this for account- and device-level APIs.
`MeetingKit` is a singleton with only one instance per process. It carries only **account-level and device-level** capabilities: login, IM, local capture and preview, audio routing, process-side screen capture integration, and meeting queries and scheduling.
All in-meeting operations and events are scoped to a room and go through a [MeetingKitRoom](/en/meeting/ios/api-reference/MeetingKitRoom) instance created with `createRoomWithDelegate:`. The same account can create and enter multiple rooms at the same time, and the media and business state of each room are independent of each other.
Starting with `2.0.0`, the in-meeting APIs have moved out of this class. For `enterRoom:onSuccess:onFailed:`, `requestOpenCamera:view:onSuccess:onFailed:`, `sendRoomChatMessage:messageType:targetId:onSuccess:onFailed:`, the `adminXxx` family, cloud recording, the waiting room, sub-meetings, sign-in, and similar APIs, use [MeetingKitRoom](/en/meeting/ios/api-reference/MeetingKitRoom) instead.
## Core APIs
### sharedInstance()
`+ (MeetingKit *)sharedInstance`
Creates the MeetingKit instance (singleton).
### version()
`- (NSString *)version`
Gets the MeetingKit version number.
### addDelegate:()
`- (void)addDelegate:(id )delegate`
Sets the global event callback.
Through [MeetingKitDelegate](/en/meeting/ios/api-reference/MeetingKitDelegate) you receive two kinds of global event notifications: audio route changes and app performance. For in-room events, implement [MeetingKitRoomDelegate](/en/meeting/ios/api-reference/MeetingKitRoomDelegate) and pass it in when creating the room.
| Parameter | Description |
| :- | - |
| delegate | Listener instance |
### createRoomWithDelegate:()
`- (nullable MeetingKitRoom *)createRoomWithDelegate:(nullable id)delegate`
Creates an independent meeting room instance.
Each call returns a new [MeetingKitRoom](/en/meeting/ios/api-reference/MeetingKitRoom) instance, and instances don't affect each other. To be in multiple rooms at the same time, call it multiple times and hold each instance separately.
The instance becomes invalid after you call the room's `exitRoom:`, and you need to create a new one.
| Parameter | Description |
| :- | - |
| delegate | Room event delegate; see [MeetingKitRoomDelegate](/en/meeting/ios/api-reference/MeetingKitRoomDelegate) |
### getRooms()
`- (NSArray *)getRooms`
Gets the list of meeting rooms you're currently in.
Instances that have been created but haven't entered the meeting yet, or that have already exited, aren't included in the result.
### loginWithToken:appGroup:onSuccess:onFailed:()
`- (void)loginWithToken:(NSString *)token appGroup:(NSString *)appGroup onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Login API. You need to initialize the user information first before you can enter a room and perform other operations.
This API enables process-wide local log capture by default.
| Parameter | Description |
| :- | - |
| token | User token |
| appGroup | App Group identifier |
| onSuccess | Success callback |
| onFailed | Failure callback |
### loginWithToken:appGroup:logConfig:onSuccess:onFailed:()
`- (void)loginWithToken:(NSString *)token appGroup:(NSString *)appGroup logConfig:(SEALogConfig *)logConfig onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Logs in with a custom log configuration. You need to initialize the user information first before you can enter a room and perform other operations.
| Parameter | Description |
| :- | - |
| token | User token |
| appGroup | App Group identifier |
| logConfig | Log configuration; see [SEALogConfig](/en/meeting/ios/types#sealogconfig) |
| onSuccess | Success callback |
| onFailed | Failure callback |
### logout()
`- (void)logout`
Logout API. Exits and destroys all room instances and releases resources, so you don't need to call `exitRoom:` on each room instance.
## IM APIs
### enableImWithDelegate:onSuccess:onFailed:()
`- (void)enableImWithDelegate:(nullable id)delegate onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Enables IM.
Call this API to turn on the SDK's IM service, which you can use to build features such as pre-meeting calls and notifications.
| Parameter | Description |
| :- | - |
| delegate | Delegate; see [MeetingKitIMDelegate](/en/meeting/ios/api-reference/MeetingKitIMDelegate) |
| onSuccess | Success callback |
| onFailed | Failure callback |
### disableIm()
`- (void)disableIm`
Disables IM.
When you no longer need the IM service, disable it with this API.
## Meeting APIs
### getMeetingList:onFailed:()
`- (void)getMeetingList:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets the meeting list.
| Parameter | Description |
| :- | - |
| onSuccess | Success callback; see [SEAMeetingListModel](/en/meeting/ios/types#seameetinglistmodel) |
| onFailed | Failure callback |
### getMoreMeetingList:onFailed:()
`- (void)getMoreMeetingList:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets more of the meeting list (next page).
| Parameter | Description |
| :- | - |
| onSuccess | Success callback; see [SEAMeetingListModel](/en/meeting/ios/types#seameetinglistmodel) |
| onFailed | Failure callback |
### getHistoryMeetingList:onFailed:()
`- (void)getHistoryMeetingList:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets the past meeting list.
| Parameter | Description |
| :- | - |
| onSuccess | Success callback; see [SEAMeetingListModel](/en/meeting/ios/types#seameetinglistmodel) |
| onFailed | Failure callback |
### getMoreHistoryMeetingList:onFailed:()
`- (void)getMoreHistoryMeetingList:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets more of the past meeting list (next page).
| Parameter | Description |
| :- | - |
| onSuccess | Success callback; see [SEAMeetingListModel](/en/meeting/ios/types#seameetinglistmodel) |
| onFailed | Failure callback |
### getMeetingDetailsWithMeetingId:onSuccess:onFailed:()
`- (void)getMeetingDetailsWithMeetingId:(NSString *)meetingId onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets meeting details.
| Parameter | Description |
| :- | - |
| meetingId | Meeting ID |
| onSuccess | Success callback; see [SEAMeetingModel](/en/meeting/ios/types#seameetingmodel) |
| onFailed | Failure callback |
### getMeetingDetailsWithRoomNo:onSuccess:onFailed:()
`- (void)getMeetingDetailsWithRoomNo:(NSString *)roomNo onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets meeting details.
| Parameter | Description |
| :- | - |
| roomNo | Room number |
| onSuccess | Success callback; see [SEAMeetingModel](/en/meeting/ios/types#seameetingmodel) |
| onFailed | Failure callback |
### getParticipantListsWithMeetingId:onSuccess:onFailed:()
`- (void)getParticipantListsWithMeetingId:(NSString *)meetingId onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets the attendance records of a meeting.
| Parameter | Description |
| :- | - |
| meetingId | Meeting ID |
| onSuccess | Success callback; see [SEAMemberListModel](/en/meeting/ios/types#seamemberlistmodel) |
| onFailed | Failure callback |
### getMoreParticipantListsWithMeetingId:onSuccess:onFailed:()
`- (void)getMoreParticipantListsWithMeetingId:(NSString *)meetingId onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets more attendance records (next page).
| Parameter | Description |
| :- | - |
| meetingId | Meeting ID |
| onSuccess | Success callback; see [SEAMemberListModel](/en/meeting/ios/types#seamemberlistmodel) |
| onFailed | Failure callback |
### requestCancelMeetingWithMeetingId:onSuccess:onFailed:()
`- (void)requestCancelMeetingWithMeetingId:(NSString *)meetingId onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Requests to cancel a meeting.
| Parameter | Description |
| :- | - |
| meetingId | Meeting ID |
| onSuccess | Success callback |
| onFailed | Failure callback |
### createRoom:onSuccess:onFailed:()
`- (void)createRoom:(SEAMeetingParam *)params onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Creates a room.
| Parameter | Description |
| :- | - |
| params | Room creation parameters; see [SEAMeetingParam](/en/meeting/ios/types#seameetingparam) |
| onSuccess | Success callback |
| onFailed | Failure callback |
### updateRoom:onSuccess:onFailed:()
`- (void)updateRoom:(SEAMeetingParam *)params onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Updates room data.
| Parameter | Description |
| :- | - |
| params | Room update parameters; see [SEAMeetingParam](/en/meeting/ios/types#seameetingparam) |
| onSuccess | Success callback |
| onFailed | Failure callback |
## User APIs
### getAgentList:keyword:onSuccess:onFailed:()
`- (void)getAgentList:(NSArray *)typesList keyword:(nullable NSString *)keyword onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets the device list.
| Parameter | Description |
| :- | - |
| typesList | List of device types; for device types, see the [SEAAgentType](/en/meeting/ios/types#seaagenttype) definition |
| keyword | Keyword |
| onSuccess | Success callback; see [SEAAgentListModel](/en/meeting/ios/types#seaagentlistmodel) |
| onFailed | Failure callback |
### getMoreAgentList:keyword:onSuccess:onFailed:()
`- (void)getMoreAgentList:(NSArray *)typesList keyword:(nullable NSString *)keyword onSuccess:(nullable SEASuccessBlock)onSuccess onFailed:(nullable SEAFailedBlock)onFailed`
Gets more of the device list (next page).
| Parameter | Description |
| :- | - |
| typesList | List of device types; for device types, see the [SEAAgentType](/en/meeting/ios/types#seaagenttype) definition |
| keyword | Keyword |
| onSuccess | Success callback; see [SEAAgentListModel](/en/meeting/ios/types#seaagentlistmodel) |
| onFailed | Failure callback |
## Local capture APIs
### updateLocalView:()
`- (void)updateLocalView:(VIEW_CLASS *)view`
Updates the local camera preview.
| Parameter | Description |
| :- | - |
| view | Video rendering view |
### switchCamera()
`- (void)switchCamera`
Switches between the front and rear cameras.
### setLocalPreviewMirror:()
`- (void)setLocalPreviewMirror:(BOOL)mirror`
Sets the local preview mirroring preference for the front camera.
Applies only to the local preview and doesn't affect the published data. The front camera is mirrored according to `mirror`, and the rear camera is never mirrored; after you switch cameras, the SDK applies the corresponding policy automatically.
| Parameter | Description |
| :- | - |
| mirror | YES: mirror the front camera; NO: don't mirror the front camera |
### currentCameraDirection()
`- (SEACameraDirection)currentCameraDirection`
Gets the current camera direction.
Returns the direction of the camera currently used for capture; see [SEACameraDirection](/en/meeting/ios/types#seacameradirection).
## Audio routing APIs
### switchAudioRoute:()
`- (void)switchAudioRoute:(SEAAudioRoute)route`
Switches the audio route.
Use this API to request switching between built-in audio output devices, such as the speaker and the earpiece. When a Bluetooth or wired headset is present, iOS decides which external device is used. The actual final route is whatever `currentAudioRoute` and the [onAudioRouteChange:previousRoute:()](/en/meeting/ios/api-reference/MeetingKitDelegate#onaudioroutechangepreviousroute) callback in `MeetingKitDelegate` report.
| Parameter | Description |
| :- | - |
| route | Audio route; see [SEAAudioRoute](/en/meeting/ios/types#seaaudioroute) |
### currentAudioRoute()
`- (SEAAudioRoute)currentAudioRoute`
Gets the system's current actual audio route.
Returns the audio route the system is actually using, such as the speaker, the earpiece, or a Bluetooth or wired headset. See [SEAAudioRoute](/en/meeting/ios/types#seaaudioroute).
### headphoneDeviceAvailable()
`- (BOOL)headphoneDeviceAvailable`
Whether a wired headset is present.
Returns whether a wired headset is present.
### bluetoothDeviceAvailable()
`- (BOOL)bluetoothDeviceAvailable`
Whether a Bluetooth headset is present.
Returns whether a Bluetooth headset is present.
## Virtual background APIs
Virtual background applies to the single shared camera capture pipeline in the process. It's a device-level capability, and its settings apply to all rooms at once. After you switch cameras during the meeting or reconnect after a disconnect, the SDK automatically re-applies the current configuration, so you don't need to do it yourself. For usage, see [Virtual background](/en/meeting/ios/advanced/virtual-background).
### installVirtualBackground:()
`- (SEAError)installVirtualBackground:(nullable NSString *)modelPath`
Installs the virtual background component.
We recommend calling it before entering the room and turning on the camera. After installation, you also need to call [enabledVirtualBackground:()](#enabledvirtualbackground) for it to take effect.
| Parameter | Description |
| :- | - |
| modelPath | Path to the person segmentation model file (`selfie_segmenter_fixed.onnx`); pass `nil` to use the copy built into the SDK |
| Return value | Description |
| :- | - |
| SEAErrorOK | Installed successfully |
| SEAErrorConflict | The component is already installed; this call is discarded |
| SEAErrorNotFound | The model file doesn't exist; check `modelPath` |
| SEAErrorSystemError | Failed to create the inference session; this is a runtime environment problem |
### uninstallVirtualBackground()
`- (void)uninstallVirtualBackground`
Uninstalls the virtual background component.
Releases the inference session and related buffers.
### enabledVirtualBackground:()
`- (SEAError)enabledVirtualBackground:(BOOL)enabled`
Virtual background switch.
After installation, it's off by default and must be turned on explicitly. When off, frames pass straight through with zero overhead, and no inference runs. Calling it before the component is installed returns `SEAErrorConflict`.
| Parameter | Description |
| :- | - |
| enabled | YES: on; NO: off |
### setVirtualBackgroundBlur:()
`- (void)setVirtualBackgroundBlur:(NSInteger)level`
Sets background blur.
Mutually exclusive with [setVirtualBackgroundImage:()](#setvirtualbackgroundimage); the later call wins.
| Parameter | Description |
| :- | - |
| level | Blur level, range `1`–`10`, default `5`; out-of-range values are clamped to the boundary |
### setVirtualBackgroundImage:()
`- (void)setVirtualBackgroundImage:(nullable UIImage *)image`
Sets background replacement.
Mutually exclusive with [setVirtualBackgroundBlur:()](#setvirtualbackgroundblur); the later call wins.
| Parameter | Description |
| :- | - |
| image | Background image, cropped to cover without stretching; pass `nil` to cancel replacement and go back to blur |
### setVirtualBackgroundInferenceInterval:()
`- (void)setVirtualBackgroundInferenceInterval:(NSInteger)interval`
Sets the segmentation inference interval.
A performance tier for you to set per device model; we don't recommend exposing it to end users.
| Parameter | Description |
| :- | - |
| interval | Run segmentation every N frames (compositing still runs every frame); default `1`, and values below `1` are treated as `1`. Increase it on low-end devices to keep the frame rate up |
### setVirtualBackgroundMaskSync:()
`- (void)setVirtualBackgroundMaskSync:(BOOL)enabled`
Sets mask sync.
Eliminates misaligned trails when waving, at the cost of the video update rate dropping to the mask rate. When `interval` is `1`, turning it on or off makes no difference at all; it only takes effect after you increase the inference interval.
| Parameter | Description |
| :- | - |
| enabled | YES: on; NO: off; default NO |
### isVirtualBackgroundEnabled()
`- (BOOL)isVirtualBackgroundEnabled`
Gets whether virtual background is on.
## Screen sharing APIs
### broadcastStartedWithAppGroup:delegate:()
`- (void)broadcastStartedWithAppGroup:(NSString *)appGroup delegate:(id)delegate`
Starts screen recording in the extension and binds the delegate.
Use this method in the extension's `SampleHandler`.
After screen capture is turned off, the SDK notifies you of the current device capture status through the [meetingRoom:onScreenRecordStatus:()](/en/meeting/ios/api-reference/MeetingKitRoomDelegate) callback in `MeetingKitRoomDelegate`. Based on the status in the callback, choose whether to request to start sharing or to stop sharing.
| Parameter | Description |
| :- | - |
| appGroup | App Group identifier |
| delegate | Screen recording extension delegate; see [Screen recording](/en/meeting/ios/advanced/screen-recording) |
### sendSampleBuffer:withType:()
`- (void)sendSampleBuffer:(CMSampleBufferRef)sampleBuffer withType:(RPSampleBufferType)sampleBufferType`
Sends screen capture frames from the extension.
Use this method in the extension's `SampleHandler`.
| Parameter | Description |
| :- | - |
| sampleBuffer | Data frame |
| sampleBufferType | Data frame type, including video, audio, and more |