f0ab835b46
Initializing a new URL/NSURL instance is a chore especially when one takes into account that the JavaScript side (1) is loading the URL asynchronously and (2) is capable of parsing strings that may or may not be represented as URL/NSURL. The Android method loadURLString(String) may have been called loadURL(String) to overload loadURL(URL) but I didn't want to do that because: 1. It would not be compatible with existing source code such as loadURL(null) which would have become ambiguous. 2. I wanted to achieve better convergence with the iOS API. |
||
|---|---|---|
| .. | ||
| app | ||
| jitsi-meet.xcworkspace | ||
| scripts | ||
| sdk | ||
| Podfile | ||
| README.md | ||
| apple-app-site-association | ||
README.md
Jitsi Meet SDK for iOS
This directory contains the source code of the Jitsi Meet app and the Jitsi Meet SDK for iOS.
Jitsi Meet SDK
JitsiMeet is an iOS framework which embodies the whole Jitsi Meet experience and makes it reusable by third-party apps.
To get started:
-
Add a
JitsiMeetViewto your app using a Storyboard or Interface Builder, for example. -
Then, once the view has loaded, set the delegate in your controller and load the desired URL:
- (void)viewDidLoad {
[super viewDidLoad];
JitsiMeetView *view = (JitsiMeetView *) self.view;
view.delegate = self;
[view loadURL:nil];
}
JitsiMeetView class
The JitsiMeetView class is the entry point to the SDK. It a subclass of
UIView which renders a full conference in the designated area.
delegate
Property for getting / setting the JitsiMeetViewDelegate on JitsiMeetView.
welcomePageEnabled
Property for getting / setting whether the Welcome page is enabled. If NO, a black empty view will be rendered when not in a conference. Defaults to NO.
NOTE: Must be set before loadURL:/loadURLString: for it to take effect.
loadURL:NSURL
[meetView loadURL:[NSURL URLWithString:@"https://meet.jit.si/test123"]];
Loads a specific URL which may identify a conference to join. If the specified
URL is nil, the Welcome page is displayed instead.
loadURLString:NSString
[meetView loadURLString:@"https://meet.jit.si/test123"];
Loads a specific URL which may identify a conference to join. If the specified
URL is nil, the Welcome page is displayed instead.
Universal / deep linking
In order to support Universal / deep linking, JitsiMeetView offers 2 class
methods that you app's delegate should call in order for the app to follow those
links.
- (BOOL)application:(UIApplication *)application
continueUserActivity:(NSUserActivity *)userActivity
restorationHandler:(void (^)(NSArray *restorableObjects))restorationHandler
{
return [JitsiMeetView application:application
continueUserActivity:userActivity
restorationHandler:restorationHandler];
}
- (BOOL)application:(UIApplication *)application
openURL:(NSURL *)url
sourceApplication:(NSString *)sourceApplication
annotation:(id)annotation
{
return [JitsiMeetView application:application
openURL:url
sourceApplication:sourceApplication
annotation:annotation];
}
JitsiMeetViewDelegate
This delegate is optional, and can be set on the JitsiMeetView instance using
the delegate property.
It provides information about the conference state: was it joined, left, did it fail?
All methods in this delegate are optional.
conferenceFailed
Called when a joining a conference was unsuccessful or when there was an error while in a conference.
The data dictionary contains an "error" key describing the error and a "url"
key with the conference URL.
conferenceJoined
Called when a conference was joined.
The data dictionary contains a "url" key with the conference URL.
conferenceLeft
Called when a conference was left.
The data dictionary contains a "url" key with the conference URL.
conferenceWillJoin
Called before a conference is joined.
The data dictionary contains a "url" key with the conference URL.
conferenceWillLeave
Called before a conference is left.
The data dictionary contains a "url" key with the conference URL.