@livekit/react-native-expo-plugin
v1.0.2
Published
Expo Plugin for LiveKit React Native SDK
Readme
Expo Plugin for LiveKit React Native SDK
This plugin handles the setup required for Expo projects to use the LiveKit React Native SDK.
Installation for managed Expo projects
npx expo install livekit-client @livekit/react-native @livekit/react-native-expo-plugin @livekit/react-native-webrtc @config-plugins/react-native-webrtcConfigure app.json
After installing this npm package, add the config plugin to the plugins array of your app.json or app.config.js:
{
"expo": {
"plugins": ["@livekit/react-native-expo-plugin", "@config-plugins/react-native-webrtc"]
}
}This plugin optionally takes in an object to customize the configuration:
Android
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| audioType | "media" | "communication" | "communication" | Audio type for the Android audio session. |
| enableScreenShareService | boolean | false | When true, uses a default foreground service to enable screen sharing (requires android.permission.FOREGROUND_SERVICE and android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION permissions). |
iOS
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| enableMultitaskingCameraAccess | boolean | false | When true, prepares the package for background camera access (only on iOS 18+, and requires the voip UIBackgroundMode). |
Example:
{
"expo": {
"plugins": [
[
"@livekit/react-native-expo-plugin",
{
"android": {
"audioType": "communication"
},
"ios": {
"enableMultitaskingCameraAccess": false
}
}
]
]
}
}Installation in React Native projects
Config plugins are not supported in React Native projects. Read the installation guide on the React Native SDK to see how to setup in a React Native project.
