diff --git a/CHANGELOG.md b/CHANGELOG.md index f23e77b..937f005 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,6 @@ +## 5.9.11+1 +* Documentation supplements, update README.md file. + ## 5.9.11 * New features: - Set video streaming mode. `setVideoStreamLayerCount` diff --git a/README.md b/README.md index cb7a2e6..7237f15 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,36 @@ [![build Status](https://github.com/netease-im/NERTC-Flutter-SDK/workflows/build/badge.svg)](https://github.com/netease-im/NERTC-Flutter-SDK/actions) [![pub package](https://img.shields.io/pub/v/nertc.svg)](https://pub.dev/packages/nertc) -Flutter plugin for NetEase RTC SDK. +Flutter plugin for NetEase RTC SDK, currently supports Android/iOS/macOS/Windows platforms. + +## Introduce + +NetEase Real-Time Communication (NERTC) is a Real-Time Communication development platform designed for efficient audio and video communication services. Based on Netease's years of technical accumulation of instant communication and Real-Time Communication capabilities, NERTC provides you with stable, smooth, high-quality, full-platform point-to-point and multi-person Real-Time Communication services. + +For more product descriptions, please see [homepage](https://doc.yunxin.163.com/nertc/guide/Dc0NTg0NzM?platform=flutter). + +## Installation + +Run this command at your project root path: + +``` + $ flutter pub add nertc_core +``` + +For more information, please see `Installing`. ## Usage -Add `nertc_core` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/). + +Now in your Dart code, you can use: + +```dart +import 'package:nertc_core/nertc_core.dart'; +``` + +Import it into your project. + +To ensure that your project can function properly with the SDK, you need to add the following configuration to your project. + ### iOS @@ -30,3 +56,29 @@ Change the minimum Android sdk version to 21 (or higher) in your `android/app/bu ``` minSdkVersion 21 ``` + +### macOS + +Add two rows to the `macOS/Runner/Info.plist`: + +* one with the key `Privacy - Camera Usage Description` and a usage description. +* and one with the key `Privacy - Microphone Usage Description` and a usage description. + +Or in text format add the key: + +```xml +NSCameraUsageDescription +Can I use the camera please? +NSMicrophoneUsageDescription +Can I use the mic please? +``` + +For more usage, please refer to the samplecode provided on github, [click it](https://github.com/netease-im/NERTC-Flutter-SDK). + +## Contact us + +- If you are having trouble, you can read the [Documentation Center](https://doc.yunxin.163.com/). +- If you need after-sales technical support, you can submit a ticket in the [Netease cloud console](https://app.yunxin.163.com/index#/issue/submit). + + + diff --git a/pubspec.yaml b/pubspec.yaml index 0851232..5fd1adc 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,8 @@ name: nertc_core -description: A Flutter plugin for NetEase RTC SDK. +description: A Flutter plugin for NetEase RTC SDK, It can help you integrate SDK quickly and realize basic functions of Real-Time Communication. homepage: https://doc.yunxin.163.com/nertc/guide/Dc0NTg0NzM?platform=flutter repository: https://github.com/netease-im/NERTC-Flutter-SDK -version: 5.9.11 +version: 5.9.11+1 #publish_to: 'none' environment: