react-native-zoom-us-ext
v1.0.3
Published
React-native bridge for ZoomUs SDK
Downloads
10
Readme
react-native-zoom-us
This is a bridge for ZoomUS SDK.
| Platform | Version | SDK Url | Changelog | | :-----------: |:------------| :----------------------------------------------------------------------: | :------------------------------------------------------------------: | | iOS | 5.11.3.4099 | ZoomSDK | https://marketplace.zoom.us/docs/changelog#labels/client-sdk-i-os | | Android | 5.10.3.5614 | jitpack-zoom-us | https://marketplace.zoom.us/docs/changelog#labels/client-sdk-android |
Tested on Android and iOS: (See details)
Pull requests are welcome.
Docs
Getting started
$ npm install react-native-zoom-us
Installation
If you have react-native < 0.60
, check Full Linking Guide
Android
- Set
pickFirst
rules inandroid/app/build.gradle
android {
packagingOptions {
pickFirst 'lib/arm64-v8a/libc++_shared.so'
pickFirst 'lib/x86/libc++_shared.so'
pickFirst 'lib/x86_64/libc++_shared.so'
pickFirst 'lib/armeabi-v7a/libc++_shared.so'
}
}
- Declare permissions
Depending on how you will use the lib, you will need to declare permissions in /android/app/src/main/AndroidManifest.xml. This is the minimum set of permissions you need to add in order to use audio and video:
<manifest xmlns:android="http://schemas.android.com/apk/res/android" xmlns:tools="http://schemas.android.com/tools">
<uses-permission android:name="android.permission.READ_PHONE_STATE"/>
<uses-permission android:name="android.permission.CAMERA"/>
<uses-permission android:name="android.permission.RECORD_AUDIO"/>
...
</manifest>
- Add this to /android/app/src/debug/AndroidManifest.xml
<application
...
tools:remove="android:networkSecurityConfig"
tools:replace="android:usesCleartextTraffic"
>
This is needed because ZoomSDK declares android:networkSecurityConfig
iOS
- Make sure you have appropriate description in
Info.plist
:
<key>NSBluetoothPeripheralUsageDescription</key>
<string>We will use your Bluetooth to access your Bluetooth headphones.</string>
<key>NSCameraUsageDescription</key>
<string>For people to see you during meetings, we need access to your camera.</string>
<key>NSMicrophoneUsageDescription</key>
<string>For people to hear you during meetings, we need access to your microphone.</string>
<key>NSPhotoLibraryUsageDescription</key>
<string>For people to share, we need access to your photos.</string>
Update pods using
cd ios/ && pod install && cd ..
Make sure to set
ENABLE_BITCODE = NO;
for both Debug and Release because bitcode is not supported by Zoom iOS SDKOptional: Implement custom UI See docs for more details.
Note that M1 chip is not supported by Zoom SDK.
Usage
import ZoomUs from 'react-native-zoom-us';
// initialize minimal
await ZoomUs.initialize({
clientKey: '...',
clientSecret: '...',
})
// initialize using JWT
await ZoomUs.initialize({
jwtToken: '...',
})
// initialize with extra config
await ZoomUs.initialize({
clientKey: '...',
clientSecret: '...',
domain: 'zoom.us'
}, {
disableShowVideoPreviewWhenJoinMeeting: true,
enableCustomizedMeetingUI: true
})
// Start Meeting
await ZoomUs.startMeeting({
userName: 'Johny',
meetingNumber: '12345678',
userId: 'our-identifier',
zoomAccessToken: zak,
userType: 2, // optional
})
// Join Meeting
await ZoomUs.joinMeeting({
userName: 'Johny',
meetingNumber: '12345678',
})
// Join Meeting with extra params
await ZoomUs.joinMeeting({
userName: 'Johny',
meetingNumber: '12345678',
password: '1234',
noAudio: true,
noVideo: true,
})
// Leave Meeting
await ZoomUs.leaveMeeting()
// Connect Audio
await ZoomUs.connectAudio()
// you can also use autoConnectAudio: true in `ZoomUs.joinMeeting`
Events Api
Hook sample for listening events:
import ZoomUs from 'react-native-zoom-us'
useEffect(() => {
const listener = ZoomUs.onMeetingStatusChange(({ event }) => {
console.log('onMeetingStatusChange', event)
})
const joinListener = ZoomUs.onMeetingJoined(() => {
console.log('onMeetingJoined')
})
return () => {
listener.remove()
joinListener.remove()
}
}, [])
If you need more events, take a look Events
Testing
The plugin has been tested for joinMeeting
using smoke test procedure:
- react-native-zoom-us: 6.15.1
- react-native: 0.70.5
- node: 16.18.1
- macOS: 13.0
- XCode: 14.1
- Android minSdkVersion: 21
FAQ
Does library support Expo?
You have to eject your expo project to use this library.