Web SDK
JavaScript SDK for web audio/video calls, Room connection, stream publish/subscribe, and signaling.
Weiyi ProDeveloper Docs
Quickly integrate audio/video conferencing capabilities
Skip to content
Quick Start
SDK Overview
Weiyi Pro provides Web, Android, and iOS SDKs for audio/video conferencing:
| SDK | Description |
|---|---|
| Web SDK | JavaScript SDK — Room connection, publish/subscribe, signaling, device and media stream management |
| Android SDK | Native Android integration — WySdk join flow and APIs |
| iOS SDK | Native iOS UI SDK — WeiYiProSDK integration and APIs |
System Requirements
| Platform | Minimum Version |
|---|---|
| Windows | Windows 10 or later |
| Android | Android 8.0 (API 26) or later |
| iOS | iOS 14 or later |
| Web | Chrome 90+, Edge 90+, Firefox 95+, Safari 15+ |
Integration Methods
Weiyi Pro offers two integration methods to suit different scenarios.
Method 1: Protocol Launch (Zero Code, 5 Minutes)
Launch the Weiyi Pro client via a custom protocol URL, or join a meeting in the browser via an H5 link. No SDK code required.
Client launch (custom protocol):
weiyi://https://your-domain.com/h5/index.html?serial=xxxx&userid=xxx&username=xxxxExample:
weiyi://https://your-domain.com/h5/index.html?serial=754884357&userid=123456&username=JohnWeb join (H5 multi-parameter):
https://your-domain.com/h5/#/login?serial=xxxx&userid=xxx&username=xxxx&invisible=1&joinRole=presenterExample:
https://your-domain.com/h5/#/login?serial=754884357&userid=123456&username=John&invisible=0&joinRole=presenter| Parameter | Description |
|---|---|
| serial | Meeting ID |
| userid | User ID (must be unique) |
| username | Display name |
| invisible | 0 visible, 1 invisible |
| joinRole | presenter attendee, speaker presenter, chairman chair |
Ideal for scenarios where the Weiyi Pro client is installed, or when opening an H5 meeting page directly in the browser.
Method 2: UI SDK (Pre-built UI, 1 Day)
Join a meeting via H5 URL using Weiyi Pro's pre-built meeting interface. No custom UI development required.
Multi-parameter:
https://your-domain.com/h5/#/login?serial=123456789&userid=1234&username=name&invisible=1&joinRole=presenterSingle-parameter Token:
https://your-domain.com/h5/index.html?token=encrypted-token-stringThe token is generated server-side via AES encryption. Example parameter JSON:
json
{"serial":"111111","userid":"123456","username":"weiyi","joinRole":"presenter"}See Web Server API — URL Join (Single Parameter) for full Java/PHP token generation examples.
The UI SDK provides a ready-to-use meeting interface including video layout, toolbar, and participant list. When embedding via iframe, add allow="geolocation; microphone; camera;display-capture".
Next Steps
- Web SDK Guide — JavaScript SDK: Room connection, publish/subscribe, signaling
- Android SDK Guide — WySdk init, join, publish/subscribe
- iOS SDK Guide — WeiYiProSDK setup, join, URL Scheme
- API Reference — Web Server API, Media Server API, Document Server API