Skip to content

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

  1. Integrate the SDK framework into your Xcode project (contact Weiyi Pro support for Pod / Framework packages).
  2. Add camera and microphone usage descriptions in Info.plist.
  3. Call server: to set the Web Server address before joining a meeting.
  4. Call server:, setAutoOpenMicrophone:, and setAutoOpenUserVideos: before joinMeeting.

DRole enum

ValueNameDescription
0dRoleNomalNormal participant
1dRoleReserveReserved (downgraded to normal)
2dRoleSpeakerSpeaker
3dRoleHiderHidden user

WeiYiProSDK

Singleton

objective-c
WeiYiProSDK *sdk = [WeiYiProSDK sharedWeiYiProSDK];

Key methods

MethodDescription
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:

  • applicationDidEnterBackground
  • applicationDidBecomeActive

Version

ItemVersion
SDK1.0
Initial release2020-12-30

Server APIs: Web Server API. Contact Weiyi Pro support for SDK packages and integration details.

微议Pro SDK 开发者文档