agora-rn-uikit
Advanced tools
Weekly downloads
Changelog
5.0.1
Fixed #112 for iOS
Readme
Instantly integrate Agora video calling or streaming into your React Native application.
Expo is supported using custom-dev-clients, for more information read this blog post
To a react-native application generated using react-native-cli, add the following:
npm i react-native-agora agora-react-native-rtm agora-rn-uikit
This VideoUIKit is very simple to use and contains a high level component called AgoraUIKit
. You can check out code explanation here.
A simple sample app integrating Agora UI Kit:
import React, {useState} from 'react';
import AgoraUIKit from 'agora-rn-uikit';
const App = () => {
const [videoCall, setVideoCall] = useState(true);
const connectionData = {
appId: '<Agora App ID>',
channel: 'test',
};
const rtcCallbacks = {
EndCall: () => setVideoCall(false),
};
return videoCall ? (
<AgoraUIKit connectionData={connectionData} rtcCallbacks={rtcCallbacks} />
) : (
<Text onPress={()=>setVideoCall(true)}>Start Call</Text>
);
};
export default App;
Replace the '<Agora App ID>'
with your own appID.
If you created the Agora App in secured mode, you'll need to pass in an rtcToken
and an rtmToken
to the connectionData
prop. Alternatively, you can deploy the one-click token server and pass in the tokenUrl
, the UIKit then automatically fetches and manages the tokens.
There's a React Native VideoUIKit demo here, and one with typescript here.
adb devices
to verify if the device is connected npm start
– This will start the development server npm run android
- This will deploy the app on the Android device. (Now, the app will connect our development server)npx pod-install
to download the necessary pods..xcworkspace
file located in ios
folder using XCode.For full documentation, see our docs page.
You can visit the wiki for other examples and in depth guide.
FAQs
Agora react native UI KIT. Rapidly integrate video calling into your React Native application with built in UI Elements.
The npm package agora-rn-uikit receives a total of 390 weekly downloads. As such, agora-rn-uikit popularity was classified as not popular.
We found that agora-rn-uikit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.