Skip to content

iOSInstallation.md

Latest commit

 

History

History
90 lines (64 loc) · 3.18 KB

iOSInstallation.md

File metadata and controls

90 lines (64 loc) · 3.18 KB
Raw

iOS Installation

Starting with React Native 0.60 due to a new auto linking feature you no longer need to follow manual linking steps but you will need to follow the other steps below if you plan on releasing your app to production.

See a sample app in the examples/GumTestApp directory.

Adjusting the supported platform version

IMPORTANT: Make sure you are using CocoaPods 1.10 or higher.
You may have to change the platform field in your podfile.
@livekit/react-native-webrtc doesn't support iOS < 12 Set it to '12.0' or above or you'll get an error when running pod install.

platform :ios, '12.0'

Pod source

The native module depends on the LiveKitWebRTC pod, which is published on the CocoaPods trunk, so no extra source lines are needed in your Podfile.

If a LiveKitWebRTC version has not reached the trunk CDN yet, the livekit/podspecs repository serves the same podspecs and can be added as an additional source:

source 'https://cdn.cocoapods.org/'
source 'https://github.com/livekit/podspecs.git'

Declaring Permissions

Navigate to <ProjectFolder>/ios/<ProjectName>/ and edit Info.plist, add the following lines.

<key>NSCameraUsageDescription</key>
<string>Camera permission description</string>
<key>NSMicrophoneUsageDescription</key>
<string>Microphone permission description</string>

CallKit

If your app uses a CallKit integration to handle incoming calls, then your CXProviderDelegate should call through to LKRTCAudioSession.sharedInstance.audioSessionDidActivate/Deactivate accordingly.

#import <LiveKitWebRTC/RTCAudioSession.h>

- (void) provider:(CXProvider *) provider didActivateAudioSession:(AVAudioSession *) audioSession {
    [[LKRTCAudioSession sharedInstance] audioSessionDidActivate:[AVAudioSession sharedInstance]];
}

- (void) provider:(CXProvider *) provider didDeactivateAudioSession:(AVAudioSession *) audioSession {
    [[LKRTCAudioSession sharedInstance] audioSessionDidDeactivate:[AVAudioSession sharedInstance]];
}

Javascript methods are also provided to call these methods:

import { RTCAudioSession } from '@livekit/react-native-webrtc'

// Call as needed.
RTCAudioSession.audioSessionDidActivate();
RTCAudioSession.audioSessionDidDeactivate();

Background Camera Access

Background camera access on supported devices can be enabled through setting the enableMultitaskingCameraAccess flag on WebRTCModuleOptions. This will require the voip background mode capability on iOS 18 or later devices.

In your AppDelegate.m file:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  [WebRTCModuleOptions sharedInstance].enableMultitaskingCameraAccess = YES;
  
  // ...
}

Library not loaded/Code signature invalid

This is an issue with iOS 13.3.1.
All dynamic frameworks being compiled to the newest release of iOS 13.3.1 are experiencing this issue when run on a personal provisioning profile/developer account.
Use a non-Personal Team provisioning profile (paid developer account) to resolve the issue.
You can find more information here.