Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@pano.video/panortc-react-native-sdk

PanoVideo410BSD1.0.2TypeScript support: included

PanoRtc SDK For React Native

react-native, ios, android, pano, audio, video, chat, live

readme

panortc-react-native-sdk

npm npm npm npm

中文

This SDK is a wrapper for Pano SDK.

Release Note

Changelog

Installation

Installing

Install panortc-react-native-sdk

`shell script yarn add @pano.video/panortc-react-native-sdk


or

```shell script
npm i --save @pano.video/panortc-react-native-sdk

Go to your ios folder and run:

`shell script pod install


## Getting Started

* See the [example](example) directory for a sample about multi-person HD audio and video calls app which using `panortc-react-native-sdk`.

## General Usage

```typescript
import RtcEngineKit { RtcEngineConfig } from '@pano.video/panortc-react-native-sdk';
let config = new RtcEngineConfig('YOUR_APP_ID');
this._engine = await RtcEngineKit.create(config);

Device Permission

Pano SDK requires camera and microphone permission to start video call.

Android

Open the AndroidManifest.xml file and add the required device permissions to the file.

<manifest>
    ...
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
    <uses-permission android:name="android.permission.BLUETOOTH" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-feature android:name="android.hardware.camera" />
    <uses-feature android:name="android.hardware.camera.autofocus" />
    ...
</manifest>

iOS

Open the info.plist and add:

  • Privacy - Microphone Usage Description, and add a note in the Value column.
  • Privacy - Camera Usage Description, and add a note in the Value column.

Your application can still run the voice call when it is switched to the background if the background mode is enabled. Select the app target in Xcode, click the Capabilities tab, enable Background Modes, and check Voice over IP.

Using TypeScript

We suggest you use TypeScript to develop, or use TypeScript eslint to lint your code.

API

Resources

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

BSD

changelog

1.0.2

  • Support Pano SDK to 1.6.1.1
  • Add Whiteboard addDocWithExtHtml api

1.0.1

  • Support Pano SDK to 1.6.0.0
  • Support Whiteboard new apis

1.0.0

  • Support Pano SDK to 1.5.6

0.9.9

  • Support Pano SDK to 1.5.4

0.9.8

  • Support Pano SDK to 1.5.3
  • Support RtcMessageService new apis
  • Add Message ChannelService
  • Change default VideoProfileType to Standard
  • Enhance message service demo code in audio channel example

0.9.7

  • Support Pano SDK to 1.4.4.6
  • Support Whiteboard new apis
  • Add callbacks for startAudio, startVideo and startScreen
  • Add onScreenCaptureStateChanged callback

0.9.6

  • update to pano sdk version 1.4.1
  • supoort screen share
  • add addAudioFile/addVideoFile Whiteboard api
  • recover the sendMessage/broadcast Whiteboard api

0.9.5

  • update to pano sdk version 1.3.7.3
  • add RTM support

0.9.4

  • fix ios setCurrentScaleFactor crash

0.9.3

  • fix android container background color black when use RtcSurfaceView

0.9.2

  • fix android package name error

0.9.1

  • update to pano sdk version 1.2.9