iOS SDK
The Weiyi Pro iOS UI SDK integrates audio/video conferencing into native apps. The main entry class is WeiYiProSDK (Objective-C), providing meeting join, video management, and floating window support.
Before You Start
- Integrate the SDK framework into your Xcode project (contact Weiyi Pro support for Pod / Framework packages).
- Add camera and microphone usage descriptions in
Info.plist. - Call
server:to set the Web Server address before joining a meeting. - Call
server:,setAutoOpenMicrophone:, andsetAutoOpenUserVideos:beforejoinMeeting.
DRole enum
| Value | Name | Description |
|---|---|---|
| 0 | dRoleNomal | Normal participant |
| 1 | dRoleReserve | Reserved (downgraded to normal) |
| 2 | dRoleSpeaker | Speaker |
| 3 | dRoleHider | Hidden user |
WeiYiProSDK
Singleton
objective-c
WeiYiProSDK *sdk = [WeiYiProSDK sharedWeiYiProSDK];Key methods
| Method | Description |
|---|---|
server: | Set server URL (normalized to {scheme}://{host}/ClientAPI/) |
setAutoOpenMicrophone: | Auto-open mic on join (default YES) |
setAutoOpenUserVideos: | Auto-open local video on join (default YES) |
joinMeeting:userId:nickName:meetingId:signature:role: | Join a meeting |
applicationOpenURL: | Handle URL Scheme launch |
Join meeting
objective-c
[[WeiYiProSDK sharedWeiYiProSDK] joinMeeting:self
userId:@"user123"
nickName:@"Alice"
meetingId:@"meeting456"
signature:@""
role:dRoleNomal];Pass @"" for signature when no signature is required. If the meeting has a password, the SDK shows a password dialog automatically.
URL Scheme
weiyipro://{server}/?serial={meetingId}&sig={signature}Example:
weiyipro://api.example.com/?serial=meeting123&sig=Basic flow
sharedWeiYiProSDK → server: → setAutoOpen* → joinMeeting:Full Objective-C samples: Chinese iOS SDK guide.
Lifecycle
Forward AppDelegate callbacks to SDK:
applicationDidEnterBackgroundapplicationDidBecomeActive
Version
| Item | Version |
|---|---|
| SDK | 1.0 |
| Initial release | 2020-12-30 |
Server APIs: Web Server API. Contact Weiyi Pro support for SDK packages and integration details.
