@aculab-com/react-native-aculab-client
v1.5.3
Published
Aculab client for react native applications
Downloads
38
Readme
react-native-aculab-client
This package implements Aculab webRTC services in a React Native project
This package holds
- AculabBaseClass is ideal for coding your own function or class components.
- AcuMobCom a class component that provides all you need for basic call with minimal requirements. As class component it holds all states therefore is less flexible than a function component you can make yourself but it work out of the box.
- AculabCall a class component that on top of basic functionality makes use of react-native-callkeep package and it's perks.
1. AculabBaseClass
AculabBaseClass is an Aculab WebRTC class developed to be used in a react native class or function component allowing iOS and Android devices to use Aculab Services and make peer-to-peer video calls.
AculabBaseClass dependencies
AculabBaseClass README
AcuMobCom as a function component - Example
Demonstrates usage of AculabBaseClass in a simple function component.
Please visit the AcuMobCom-AculabBaseClass-Example App to see it being used in practice.
AcuMobCom-AculabBaseClass-Example app README
AculabCall as a function component - Example
Demonstrates usage of AculabBaseClass and CallKeep in a simple function component.
Please visit the AculabCall-AculabBaseClass-Example App to see it being used in practice.
AculabCall-AculabBaseClass-Example app README
2. AcuMobCom class component
AcuMobCom is a react native class component allowing iOS and Android platforms to use Aculab Services and peer-to-peer video calls.
AcuMobCom dependencies
AcuMobCom README
Please visit the Example App to see it being used in practice.
3. AculabCall class component
AculabCall is a react native class component allowing iOS and Android platforms to use Aculab Services and peer-to-peer video calls with additional features provided by the react-native-callkeep package.
AculabCall dependencies
AculabCall README
Please visit the Example App to see it being used in practice.
Bitcode issue
If you encounter a Bitcode issue coming from WebRTC framework while releasing your app for iOS you have two options:
Disable Bitcode for your app, then release.
Download the bitcode by running this script: node_modules/react-native-webrtc/tools/downloadBitcode.sh, then release.
Disclaimer
Please note this software is released as part of a new product introduction process and this build is of evaluation trial standard. While endeavour has been made to provide a high quality level, we would not except it to be entirely bug-free. Any bugs we have found are documented in the release notes. Aculab would greatly appreciate hearing any that you may find. We would not recommend the use of this or any beta software in business critical applications.
License
MIT
Copyright (c) 2023 Aculab
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.