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

# Web UI SDK integration

> Low-code integration with UI for Web: the open-source SMeeting Web meeting app (Vue 3 + TypeScript + Vite), its tech stack, project structure, dev commands, and the login, home, and meeting pages and layouts. Read this to take the source code, modify the UI, and deploy it yourself.

This is the web client project of a video conferencing system that integrates the Web SDK, built with Vue 3 + TypeScript + Vite.

GitHub source code: [https://github.com/seastart/meeting-web-demo](https://github.com/seastart/meeting-web-demo)

## Tech stack

* Vue 3
* TypeScript
* Vite
* Element Plus
* Pinia
* Vue Router
* SCSS

## Project structure

```text theme={null}
├── src/                    # Source code directory
│   ├── api/               # API definitions
│   ├── assets/            # Static assets
│   ├── components/        # Shared components
│   ├── directives/        # Vue custom directives
│   ├── hooks/             # Vue composables
│   ├── router/            # Router configuration
│   ├── sdk/               # SDK-related code
│   ├── stores/            # Pinia state management
│   ├── styles/            # Global styles
│   ├── types/             # TypeScript type definitions
│   ├── utils/             # Utility functions
│   ├── views/             # Page view components
│   ├── App.vue            # Root component
│   └── main.ts            # App entry file
├── public/                # Public static assets
├── doc/                   # Project documentation
├── .env.development       # Development environment configuration
├── .env.production        # Production environment configuration
├── vite.config.ts         # Vite configuration file
└── package.json           # Project dependency configuration
```

## Key files

### Configuration files

* `package.json`: project dependencies and script configuration
* `vite.config.ts`: Vite build tool configuration
* `tsconfig.json`: TypeScript configuration
* `.env.development`: development environment variables
* `.env.production`: production environment variables

### Source directories

* `src/api/`: code for calling backend APIs
* `src/components/`: reusable Vue components
* `src/directives/`: Vue custom directives
* `src/hooks/`: Vue composables
* `src/router/`: router configuration and route guards
* `src/sdk/`: wrapper code for the conferencing SDK
* `src/stores/`: Pinia state stores
* `src/utils/`: utility functions and common methods
* `src/views/`: page-level components

## Dev commands

```bash theme={null}
# Install dependencies
npm install

# Run in development mode
npm run dev

# Build for production
npm run build

# Format code
npm run format

# Type check
npm run type-check
```

## Page features

### Login page

```text theme={null}
├── login/                	
│   ├── cpn/ 
│      ├── Login.vue     #Login page component
│      ├── Register.vue 	#Registration page component
│   ├── index.vue       #Login entry

```

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/339904_1736926098475-78d5f4b6-14de-4e1c-84ab-ea41db0c02ee.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=1d5a6b41772ea3a4bfdf86d54fa3ee76" alt="" width="1202" height="587" data-path="zh/meeting/ui-sdk/images/339904_1736926098475-78d5f4b6-14de-4e1c-84ab-ea41db0c02ee.png" />

### Home page

```text theme={null}
├── home/                	
│   ├── cpn/ 
│      ├── AppointmentMeeting.vue     #Schedule meeting dialog component
│      ├── AppointmentResult.vue 			#Scheduling result dialog component
│      ├── Contacts.vue 							#Contacts dialog component
│      ├── HistoryMeeting.vue 				#Meeting history dialog component
│      ├── ImmediateMeeting.vue 			#Instant meeting dialog component
│      ├── JoinMeeting.vue 						#Enter meeting dialog component
│   ├── index.vue       							#Home entry

```

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/585166_1732101587454-d92b8903-9808-4eef-9d5f-80512f1b85a6.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=79bbd9dd722ac1dc07c4f617b916481c" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/585166_1732101587454-d92b8903-9808-4eef-9d5f-80512f1b85a6.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/174500_1732101675605-22b52baa-b2bb-4d2e-9092-84025871fffa.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=c5e832bfcfc9797a3ce0cd2a07e5eae6" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/174500_1732101675605-22b52baa-b2bb-4d2e-9092-84025871fffa.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/250744_1732101695538-3c9d0687-553c-4c8a-a35c-78fadc0e81b6.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=599af40d0c4a0ac26fb2e02747072560" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/250744_1732101695538-3c9d0687-553c-4c8a-a35c-78fadc0e81b6.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/156166_1732101668462-2852d607-41ad-40f3-8dbf-4ce212169fe1.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=4f4104689f8e162772a4b47c20d21d19" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/156166_1732101668462-2852d607-41ad-40f3-8dbf-4ce212169fe1.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/361833_1732101909301-820305a4-18ba-4706-8392-fd94710a7dd4.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=e958401629c1eb7008aace4ea5a156bf" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/361833_1732101909301-820305a4-18ba-4706-8392-fd94710a7dd4.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/226736_1732102028492-c5aa427f-0e2e-4cc0-8893-81c2bc38e940.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=b730a511ddd1650775d365cb3ce9c9e2" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/226736_1732102028492-c5aa427f-0e2e-4cc0-8893-81c2bc38e940.png" />

### Meeting

```text theme={null}
├── meeting/                	
│   ├── cpn/                 
│      ├── ChatDrawer.vue     			#Chat side panel component
│      ├── Footer.vue 							#Bottom toolbar component
│      ├── LayoutImg.vue 						#Layout image component
│      ├── InviteEnter.vue 					#Invite-to-meeting dialog component
│      ├── MemberDrawer.vue 				#Member side panel component
│      ├── Preview.vue 							#Large-window video preview component
│      ├── Recording.vue 						#Recording component (shows "Recording 00:00:00" in the top-left corner)
│      ├── RecordLayout.vue 				#Recording layout settings dialog component
│   ├── room-content/       
│      ├── gird-view/     		
│      		├── index.vue 						#Grid view component
│      ├── size-view/				
│         ├── index.vue 						#Large/small view component
│         ├── SizeBr7.vue 					#Bottom L-shaped layout view component
│         ├── SizeRight4.vue 				#Right-side small windows view component
│         ├── SizeTl7.vue 					#Top L-shaped layout view component
│         ├── SizeTop4.vue 					#Top small windows view component
│      ├── index.vue 								#Content component
│      ├── MeItem.vue 							#Own video tile component
│      ├── UserItem.vue 						#Member video tile component
│      ├── OtherShareScreen.vue 		#Component for receiving others' screen sharing
│      ├── MixMode.vue 							#Composite mode component
│   ├── room-top/       
│      ├── index.vue								#Top bar component	 	 		
│   ├── index.vue       						#Meeting entry

```

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/205598_1736933056295-99b52537-008f-4354-a4f8-4e4b1de44c6d.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=80fce657cb050257599f7747a4149906" alt="" width="1908" height="922" data-path="zh/meeting/ui-sdk/images/205598_1736933056295-99b52537-008f-4354-a4f8-4e4b1de44c6d.png" />

<img src="https://mintcdn.com/freewind/VD3RwI6FRJ42JDbE/zh/meeting/ui-sdk/images/853936_1732102177269-4924f98b-e350-4abc-9550-603146082f73.png?fit=max&auto=format&n=VD3RwI6FRJ42JDbE&q=85&s=95db52c0568d6e6bd4216432e5303df3" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/853936_1732102177269-4924f98b-e350-4abc-9550-603146082f73.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/142306_1732104234585-158f0676-dd4c-4a40-9337-ce9ff25efb85.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=624626257406fe06efb9779423865bc5" alt="" width="937" height="440" data-path="zh/meeting/ui-sdk/images/142306_1732104234585-158f0676-dd4c-4a40-9337-ce9ff25efb85.png" />

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/542183_1737027322416-21c1c872-af73-4fa4-95ff-5abbd91e0540.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=506cc67d970d511b2f1a81191b31233b" alt="" width="3840" height="1720" data-path="zh/meeting/ui-sdk/images/542183_1737027322416-21c1c872-af73-4fa4-95ff-5abbd91e0540.png" />

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/492173_1737027341947-3147d60e-ad61-4ff7-a3b9-f8ba68832292.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=f6c2dd653b8a26af7e4a0e76bfa02d7a" alt="" width="3840" height="1720" data-path="zh/meeting/ui-sdk/images/492173_1737027341947-3147d60e-ad61-4ff7-a3b9-f8ba68832292.png" />

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/165214_1732102272627-6702293b-ffac-4c6f-8476-124cc544762a.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=5353841a03b1b18c2d8b844b11246c3b" alt="" width="1920" height="902" data-path="zh/meeting/ui-sdk/images/165214_1732102272627-6702293b-ffac-4c6f-8476-124cc544762a.png" />

## Layouts

### Auto layout

<img src="https://mintcdn.com/freewind/VD3RwI6FRJ42JDbE/zh/meeting/ui-sdk/images/753355_1736942788198-38d240e8-5a2d-4cbd-b72a-7da48ebfd34f.png?fit=max&auto=format&n=VD3RwI6FRJ42JDbE&q=85&s=4b3b9c25e403c1013c3cdb5bdad0dbf1" alt="" width="1896" height="870" data-path="zh/meeting/ui-sdk/images/753355_1736942788198-38d240e8-5a2d-4cbd-b72a-7da48ebfd34f.png" />

### Full screen

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/160811_1736942765548-087bf47d-06cb-43f2-9081-ca426e8bed8f.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=93d8c8944da6b8238b5b102d334463be" alt="" width="1896" height="874" data-path="zh/meeting/ui-sdk/images/160811_1736942765548-087bf47d-06cb-43f2-9081-ca426e8bed8f.png" />

### Split in two

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/120003_1736943008000-25173f0b-0dcd-4524-9c1a-968b68df859f.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=32b311bc31eda7d56641f06414af2619" alt="" width="1912" height="872" data-path="zh/meeting/ui-sdk/images/120003_1736943008000-25173f0b-0dcd-4524-9c1a-968b68df859f.png" />

### 4-grid

<img src="https://mintcdn.com/freewind/VD3RwI6FRJ42JDbE/zh/meeting/ui-sdk/images/849963_1736943016223-b553c65f-1779-4147-9c9f-3274c07f8907.png?fit=max&auto=format&n=VD3RwI6FRJ42JDbE&q=85&s=f057b5d7d2cea746ea52aa3199d9a4f4" alt="" width="1908" height="874" data-path="zh/meeting/ui-sdk/images/849963_1736943016223-b553c65f-1779-4147-9c9f-3274c07f8907.png" />

### 5-grid

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/224959_1736943021573-05895627-8f82-414d-9f2b-1795dd302036.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=cfdec93b00512aeac5be8f702aa70d39" alt="" width="1901" height="861" data-path="zh/meeting/ui-sdk/images/224959_1736943021573-05895627-8f82-414d-9f2b-1795dd302036.png" />

### 6-grid

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/648114_1736943026553-50f82a28-c52c-4af5-9792-2f1a260b8eff.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=64db0799c010a486d6a549cc2fdc536d" alt="" width="1891" height="883" data-path="zh/meeting/ui-sdk/images/648114_1736943026553-50f82a28-c52c-4af5-9792-2f1a260b8eff.png" />

### 8-grid

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/209278_1736943036517-7a3f26bd-16df-4d09-a0e6-cc7d3a26ec92.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=180357d8af35ad462061e622b7a1a13f" alt="" width="1903" height="878" data-path="zh/meeting/ui-sdk/images/209278_1736943036517-7a3f26bd-16df-4d09-a0e6-cc7d3a26ec92.png" />

### 10-grid

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/233712_1736943058279-cbdc4959-913f-4ad3-9624-e0617b77e782.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=59ac4393fc8bd54e2e74a4661cc3fce6" alt="" width="1901" height="873" data-path="zh/meeting/ui-sdk/images/233712_1736943058279-cbdc4959-913f-4ad3-9624-e0617b77e782.png" />

### 12-grid

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/287945_1736943077728-435bf505-8366-423e-b58f-0bdc6606bb1f.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=7d725d216d299823e94abc731e743961" alt="" width="1903" height="875" data-path="zh/meeting/ui-sdk/images/287945_1736943077728-435bf505-8366-423e-b58f-0bdc6606bb1f.png" />

### 16-grid

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/473032_1736943096169-877d9f77-9dc9-4499-a73f-d48f693d87b9.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=be752c7c75bf06dbbef3977e2192711c" alt="" width="1894" height="873" data-path="zh/meeting/ui-sdk/images/473032_1736943096169-877d9f77-9dc9-4499-a73f-d48f693d87b9.png" />

### Right-side small windows

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/648091_1737017818264-45982e58-89e9-4542-a008-45b9573ed978.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=ff8e799a21d54f32f215e4a1288131f9" alt="" width="1913" height="879" data-path="zh/meeting/ui-sdk/images/648091_1737017818264-45982e58-89e9-4542-a008-45b9573ed978.png" />

### Top small windows

<img src="https://mintcdn.com/freewind/VD3RwI6FRJ42JDbE/zh/meeting/ui-sdk/images/840562_1737017829365-15053ff0-20bc-402c-9206-67d827eaefdc.png?fit=max&auto=format&n=VD3RwI6FRJ42JDbE&q=85&s=093905db6fbce77cb59e281a75060bd1" alt="" width="1864" height="866" data-path="zh/meeting/ui-sdk/images/840562_1737017829365-15053ff0-20bc-402c-9206-67d827eaefdc.png" />

### Bottom L-shaped layout

<img src="https://mintcdn.com/freewind/IUSP5LOjrN13KCvY/zh/meeting/ui-sdk/images/676110_1737017848599-22056345-7314-430e-b1a3-addf203b8203.png?fit=max&auto=format&n=IUSP5LOjrN13KCvY&q=85&s=3146efb82a8fe643d52d2d2b29f167fc" alt="" width="1900" height="876" data-path="zh/meeting/ui-sdk/images/676110_1737017848599-22056345-7314-430e-b1a3-addf203b8203.png" />

### Top L-shaped layout

<img src="https://mintcdn.com/freewind/Cn3ABWhrunxWshNS/zh/meeting/ui-sdk/images/132399_1737017863777-0f0fbd63-52dd-4fa5-a46f-413448a50005.png?fit=max&auto=format&n=Cn3ABWhrunxWshNS&q=85&s=8dd5e59d8f2d230e8cfea531c9dd745c" alt="" width="1900" height="869" data-path="zh/meeting/ui-sdk/images/132399_1737017863777-0f0fbd63-52dd-4fa5-a46f-413448a50005.png" />
