update. docs

README.md

@@ -46,18 +46,20 @@ Either way, then link with:
 
 [Agora.io API DOCS](https://docs.agora.io/en/Video/API%20Reference/java/index.html)
 
-##### RtcEngine方法
+##### RtcEngine Methods
 
 | Property                         | Arguments                                     | Description                           |
 | -------------------------------- | ---------------------------------------- | ------------------------------------- |
-| init | [Option](#Option) | create and initialize AgoraRtcEngine instance                     
-| Promise<any> joinChannel | String channelName, Number uid | join channel|
-| eventEmitter | [Events](#Events) | registe event emitters|
-| removeEmitter | void | remove event emitter |
+| init | [Option](#Option) | create and initialize AgoraRtcEngine instance, notice: invoke this method, it will start subscribe events |
+| Promise<any> joinChannel | String channelName, Number uid, String? token, String? extraInfo | join channel|
+| on | [Events](#Events), Handler: Function | addEventListener for native module events |
+| off | [Events](#Events) | removeEventListeners for native module events |
+| removeAllListeners | void | remove all event listeners |
+| destroy | void | destroy AgoraRtcEngine instance |
+| getSdkVersion | Function: callback | get sdk version |
 | Promise<any> enableLastmileTest | void | enable network quality test |
 | Promise<any> disableLastmileTest | void | disable network quality test |
 | Promise<any> leaveChannel | void | quit channel |
-| destroy | void | destroy AgoraRtcEngine instance |
 | setupLocalVideo | Number: uid, Number: renderMode, Number: reactTag | setup local video |
 | setupRemoteVideo | Number: uid, Number: renderMode, Number: reactTag | setup remote video |
 | startPreview | void | open video preview |
@@ -70,9 +72,9 @@ Either way, then link with:
 | enableVideo | void | enable video  |
 | disableVideo | void | disable video |
 | setEnableSpeakerphone | Boolean: enabled | set enable speaker phone |
-| setCameraAutoFocusFaceModeEnabled | Boolean: enabled | set camera auto focus face mode |
+| Promise<any> setCameraAutoFocusFaceModeEnabled | Boolean: enabled | set camera auto focus face mode |
 | setDefaultAudioRouteToSpeakerphone | Boolean: enabled | set default audio route to speaker phone |
-| setCameraTorchOn  | Boolean: enabled | set camera torch on |
+| Promise<any> setCameraTorchOn  | Boolean: enabled | set camera torch on |
 | muteLocalAudioStream  | Boolean: enabled | mute/unmute local audio |
 | muteRemoteAudioStream  | Number: uid, Boolean: enabled | mute/unmute remote audio by uid |
 | muteAllRemoteAudioStreams | Boolean: enabled | mute/unmute all remote audio |
@@ -80,10 +82,82 @@ Either way, then link with:
 | enableLocalVideo | Boolean: enabled | set enabled status to local video |
 | muteAllRemoteVideoStreams | void | mute/unmute all remote videos |
 | muteRemoteVideoStream | Number: uid, Boolean: enabled | mute/unmute remote video by uid |
-| getSdkVersion | Function: callback | get sdk version |
-| createDataStream | Boolean: reliable, Boolean: ordered | createDataStream |
-| sendStreamMessage | Number: streamId, String data | send data with uid |
-
+| Promise<any> createDataStream | Boolean: reliable, Boolean: ordered | createDataStream |
+| Promise<any> renewToken | String: token | renew token |
+| Promise<any> getConnectionState | void | return connection state |
+| setClientRole | Number: role(1: host, 2: audience) | change client role |
+| enableAudio | void | enable audio |
+| disableAudio | void | disable audio |
+| enableLocalAudio | Boolean: enable | enable/disable local audio |
+| muteLocalAudioStream | Boolean: mute | enable/disable local audio stream |
+| muteAllRemoteAudioStreams | Boolean: mute | enable/disable all remote audio streams |
+| muteRemoteAudioStream | Number: uid, Boolean: mute | mute/unmute remote audio stream by uid |
+| adjustRecordingSignalVolume | Number: volume | Adjusts the recording volume. |
+| adjustPlaybackSignalVolume | Number: volume | Adjusts the playback volume. |
+| enableAudioVolumeIndication | Number: interval, Number: smooth | Enables the onAudioVolumeIndication callback at a set time interval to report on which users are speaking and the speakers' volume. |
+| Promise<any> startAudioRecording | {filePath: String, quality: int} | start audio recording |
+| Promise<any> stopAudioRecoding | void | stop audio recording |
+| methodisSpeakerphoneEnabled | void | Checks whether the speakerphone is enabled.|| enableInEarMonitoring | Boolean: enabled | enable/disable in-ear monitoring | 
+| setInEarMonitoringVolume | Number: volume | Sets the volume of the in-ear monitor. |
+| setLocalVoicePitch | Number(double): pitch | Changes the voice pitch of the local speaker. |
+| setLocalVoiceEqualization | Number: bandFrequency, Number: bandGain | Sets the local voice equalization effect. |
+| setLocalVoiceReverb | Number: reverbKey, Number: value | Sets the local voice reverberation.|
+| startAudioMixing | {filepath: String, loopback: Boolean, replace: Boolean, cycle: Int} | [android](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#ac56ceea1a143a4898382bce10b04df09)
+ & [ios](https://docs.agora.io/en/Voice/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/startAudioMixing:loopback:replace:cycle:) |
+ | stopAudioMixing | void | stop audio mixing |
+ | pauseAudioMixing | void | [android](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#ab2d4fb72ec3031f59da72b55857e0da7) & [ios](https://docs.agora.io/en/Voice/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/pauseAudioMixing) |
+ | resumeAudioMixing | void | resume audio mixing |
+ | adjustAudioMixingVolume | Number: volume | adjust audio mixing volume, call this method when you are in a channel |
+ | adjustAudioMixingPlayoutVolume | Number: volume | adjust audio mixing playout volume, call this method when you are in a channel |
+ | adjustAudioMixingPublishVolume | Number: volume | Adjusts the volume of audio mixing for publishing (sending to other users). call this method when you are in a channel. |
+ | Promise<any> getAudioMixingDuration | void | Gets the duration (ms) of the music file. Call this method when you are in a channel. |
+ | Promise<any> getAudioMixingCurrentPosition | void | Gets the playback position (ms) of the music file. Call this method when you are in a channel. |
+ | Promise<any> setAudioMixingPosition | Number: pos | Sets the playback position (ms) of the music file to a different starting position (the default plays from the beginning). |
+ | Promise<any> getEffectsVolume | void | Retrieves the volume of the audio effects. |
+ | Promise<any> setEffectsVolume | Number(double): volume | Sets the volume of the audio effects. |
+ | Promise<any> setVolumeOfEffect | Number: soundId, Number(double): volume | Sets the volume of a specified audio effect. |
+ | Promise<any> playEffect | {soundId: Number, filePath: String, loopCount: Number, pitch: Number(double), gain: Boolean, publish: Boolean} | Plays a specified audio effect. [android](https://docs.agora.io/en/Video/API%20Reference/java/interfaceio_1_1agora_1_1rtc_1_1_i_audio_effect_manager.html#a6fd330db3e3e5735f7f8d5c36bc3fea1) & [ios](https://docs.agora.io/en/Voice/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/playEffect:filePath:loopCount:pitch:pan:gain:publish:) |
+ | Promise<any> stopEffect | Number: soundId | Stops playing a specified audio effect. |
+ | Promise<any> stopAllEffects | void | Stops all playing audio effects. |
+ | Promise<any> preloadEffect | Number: soundid, String: filepath | Preloads a specified audio effect file into the memory. Supported audio formats: mp3, aac, m4a, 3gp, wav.|
+ | Promise<any> unloadEffect | Number: soundId | Releases a specified preloaded audio effect from the memory. |
+ | Promise<any> pauseEffect | Number: soundId | Pauses a specified audio effect. |
+ | Promise<any> pauseAllEffects | void | Pauses all audio effects. |
+ | Promise<any> resumeEffect | void | Resumes playing a specified audio effect. |
+ | Promise<any> resumeAllEffects | void | Resumes playing all audio effects. |
+ | setAudioSessionOperationRestriction | void | [ios only](https://docs.agora.io/en/Voice/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/setAudioSessionOperationRestriction:) |
+ | Promise<any> startEchoTest | void | Starts an audio call test. |
+ | Promise<any> stopEchoTest | void | Stop the audio call test. |
+ | Promise<any> setRecordingAudioFrameParameters | {sampleRate: Number, channel: Number, mode: Number, samplesPerCall: Number } | Sets the audio recording format for the RecordFrame callback.  |
+ | Promise<any> setPlaybackAudioFrameParameters | {sampleRate: Number, channel: Number, mode: Number, samplesPerCall: Number } | Sets the audio playback format for the onPlaybackFrame callback. |
+ | Promise<any> addVideoWatermark | {url: String, x: Number, y: Number, width: Number, height: Number } | add video watermark |
+ | clearVideoWatermarks | void | remove the watermark image from the video stream added by addVideoWatermark |
+ | setLocalPublishFallbackOption | Number: [option(0, 1, 2)](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_constants.html#a3e453c93766e783a7e5eca05b1776238)| [android](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#ac8c08e79844a4e62e0670553484cbe90) & [ios](https://docs.agora.io/en/Voice/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/setLocalPublishFallbackOption:) |
+ | setRemoteSubscribeFallbackOption  | Number: [option (0, 1, 2)](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_constants.html#a3e453c93766e783a7e5eca05b1776238)| [android](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#af64301ea1788dad0561aa678f3fe6ad3) & [ios](https://docs.agora.io/en/Voice/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/setRemoteSubscribeFallbackOption:) |
+ | Promise<any> enableDualStreamMode | Boolean: enabled | Enables/disables dual-stream mode. |
+ | setRemoteVideoStreamType | { uid: Number, streamType: Number } | Sets the video stream type of the remotely subscribed video stream. |
+ | setRemoteDefaultVideoStreamType | { streamType: Number } | Sets the default video stream type of the remotely subscribed video stream. |
+ | Promise<any> addInjectStreamUrl | [InjectionStream](#InjectionStream) | Injects an online media stream to a live broadcast. |
+ | Promise<any> removePublishStreamUrl | String: url | Removes a CDN live stream URL address. |
+ | Promise<any> setVideoQualityParameters | Boolean: quality | 
+Sets the preference option for the video quality (Live broadcast only). |
+ | Promise<any> setLocalVideoMirrorMode | Number: mode | Sets the local video mirror mode. |
+ | Promise<any> switchCamera | void | Switches between front and rear cameras. | 
+ | Promise<any> isCameraZoomSupported | void | Checks whether the camera zoom function is supported. |
+ | Promise<any> isCameraTorchSupported	| void | Checks whether the camera flash function is supported. |
+ | Promise<any> isCameraFocusSupported	| void | Checks whether the camera manual focus function is supported. |
+ | Promise<any> isCameraExposurePositionSupported | void |Checks whether the camera exposure function is supported. |
+ | Promise<any> isCameraAutoFocusFaceModeSupported | void | Checks whether the camera face auto-focus function is supported. |
+ | Promise<any> setCameraZoomFactor | Number(float): zoomFactor |	Sets the camera zoom ratio. |
+ | Promise<any> getCameraMaxZoomFactor | void |	Gets the maximum zoom ratio of the camera.[android only](https://docs.agora.io/en/Video/API%20Reference/java/classio_1_1agora_1_1rtc_1_1_rtc_engine.html#a1084b42001cc5c008d58ec938fc0b7f3) |
+ | Promise<any>  setCameraFocusPositionInPreview | {x: Number(double), y: Number(double) } | Sets the camera manual focus position.|
+ | Promise<any>  setCameraExposurePosition | {x: Number(double), y: Number(double) } |	Sets the camera exposure position.|
+ | Promise<any>  setCameraTorchOn | Boolean isOn | Enables the camera flash function. |
+ | Promise<any>  setCameraAutoFocusFaceModeEnabled | Boolean enabled | Enables the camera auto-face focus function. |
+ | Promise<any> getCallId | void | getcalll id |
+ | Promise<any> setLog | filePath: String, level: Number | specifies an SDK output log file. |
+ | addPublishStreamUrl | { url: String, enabled: Boolean } | Adds a CDN live stream URL address. it must be invoked after invoking setLiveTranscoding |
+ | removePublishStreamUrl | { url: String } | Removes a CDN live stream URL address. |
 
 #### Option
 ```typescript
@@ -126,6 +200,25 @@ export interface LiveTranscoding {
 }
 ```
 
+
+#### InjectionStream
+```typescript
+export interface InjectionStream {
+  config: {
+    size: {
+      width: Number,
+      height: Number,
+    },
+    videoGop: Number,
+    videoBitrate: Number,
+    audioBitrate: Number,
+    audioSampleRate: Number,
+    videoFrameRate: Number
+    audioChannels: Number
+  }
+}
+```
+
 #### Events
 
 ```javascript

android/src/main/java/com/syan/agora/AgoraModule.java

@@ -1093,7 +1093,7 @@ public class AgoraModule extends ReactContextBaseJavaModule {
                            Promise promise) {
         try {
             int res = AgoraManager.getInstance().renewToken(token);
-            if (res != 0) throw new ReactNativeAgoraException("renewToken Failed", res);
+            if (res != 0) throw new ReactNativeAgoraException("renew token failed", res);
             WritableMap map = Arguments.createMap();
             map.putBoolean("success", true);
             promise.resolve(map);
@@ -1365,6 +1365,19 @@ public class AgoraModule extends ReactContextBaseJavaModule {
         }
     }
 
+    @ReactMethod
+    public void getCameraMaxZoomFactor(Promise promise) {
+        try {
+            int res = AgoraManager.getInstance().mRtcEngine.getCameraMaxZoomFactor();
+            WritableMap map = Arguments.createMap();
+            map.putBoolean("success", true);
+            map.putInt("value", res);
+            promise.resolve(map);
+        } catch (Exception e) {
+            promise.reject(e);
+        }
+    }
+
     @ReactMethod
     public void setCameraFocusPositionInPreview(ReadableMap options, Promise promise) {
         try {
@@ -1417,7 +1430,7 @@ public class AgoraModule extends ReactContextBaseJavaModule {
     public void setCameraAutoFocusFaceModeEnabled(boolean enabled, Promise promise) {
         try {
             int res = AgoraManager.getInstance().mRtcEngine.setCameraAutoFocusFaceModeEnabled(enabled);
-            if (res != 0) throw new ReactNativeAgoraException("setCameraTorchOn Failed", res);
+            if (res != 0) throw new ReactNativeAgoraException("setCameraAutoFocusFaceModeEnabled Failed", res);
             WritableMap map = Arguments.createMap();
             map.putBoolean("success", true);
             map.putInt("value", res);
@@ -1833,7 +1846,7 @@ public class AgoraModule extends ReactContextBaseJavaModule {
     public void disableLastmileTest(Promise promise) {
         try {
             int res = AgoraManager.getInstance().mRtcEngine
-                    .enableLastmileTest();
+                    .disableLastmileTest();
             if (res != 0) throw new ReactNativeAgoraException("disableLastmileTest Failed", res);
             WritableMap map = Arguments.createMap();
             map.putBoolean("success", true);
@@ -2077,21 +2090,22 @@ public class AgoraModule extends ReactContextBaseJavaModule {
     @ReactMethod
     public void addInjectStreamUrl(ReadableMap options, Promise promise) {
         try {
-            LiveInjectStreamConfig config = new LiveInjectStreamConfig();
-            config.width = options.getInt("width");
-            config.height = options.getInt("height");
-            config.videoGop = options.getInt("videoGop");
-            config.videoBitrate = options.getInt("videoBitrate");
-            config.videoFramerate = options.getInt("videoFramerate");
-            config.audioBitrate = options.getInt("audioBitrate");
-            config.audioSampleRate = getAudioSampleRateEnum(options.getInt("audioSampleRate"));
-            config.audioChannels = options.getInt("audioChannels");
-
+            LiveInjectStreamConfig injectstream = new LiveInjectStreamConfig();
+            ReadableMap config = options.getMap("config");
+            ReadableMap size = config.getMap("size");
+            injectstream.width = size.getInt("width");
+            injectstream.height = size.getInt("height");
+            injectstream.videoGop = config.getInt("videoGop");
+            injectstream.videoBitrate = config.getInt("videoBitrate");
+            injectstream.videoFramerate = config.getInt("videoFramerate");
+            injectstream.audioBitrate = config.getInt("audioBitrate");
+            injectstream.audioSampleRate = getAudioSampleRateEnum(config.getInt("audioSampleRate"));
+            injectstream.audioChannels = config.getInt("audioChannels");
 
             int res = AgoraManager.getInstance().mRtcEngine
                     .addInjectStreamUrl(
                             options.getString("url"),
-                            config
+                            injectstream
                     );
             if (res != 0) throw new ReactNativeAgoraException("addInjectStreamUrl Failed", res);
             WritableMap map = Arguments.createMap();

ios/RCTAgora/RCTAgora.m

@@ -151,9 +151,9 @@ RCT_EXPORT_METHOD(init:(NSDictionary *)options) {
   
   [AgoraConst share].rtcEngine = self.rtcEngine;
   
-  //频道模式
+  //channel mode
   [self.rtcEngine setChannelProfile:[options[@"channelProfile"] integerValue]];
-  //启用双流模式
+  //enable dual stream
   [self.rtcEngine enableDualStreamMode:YES];
   [self.rtcEngine enableVideo];
   
@@ -170,7 +170,7 @@ RCT_EXPORT_METHOD(init:(NSDictionary *)options) {
   [self.rtcEngine setAudioProfile:(AgoraAudioProfile)[options[@"audioProfile"] integerValue]
                          scenario:(AgoraAudioScenario)[options[@"audioScenario"] integerValue]];
   
-  //Agora Native SDK 与 Agora Web SDK 间的互通
+  //Enable Agora Native SDK be Interoperable with Agora Web SDK
   [self.rtcEngine enableWebSdkInteroperability:YES];
 }
 
@@ -219,7 +219,7 @@ RCT_EXPORT_METHOD(getConnectionState
 }
 
 // set client role
-RCT_EXPORT_METHOD(setClientRole:(NSString *) role) {
+RCT_EXPORT_METHOD(setClientRole:(NSInteger) role) {
   [self.rtcEngine setClientRole:(AgoraClientRole)role];
 }
 
@@ -396,16 +396,6 @@ RCT_EXPORT_METHOD(muteRemoteAudioStream:(NSUInteger)uid muted:(BOOL)mute){
   [self.rtcEngine muteRemoteAudioStream:uid mute:mute];
 }
 
-//// start recoding service
-//RCT_EXPORT_METHOD(startAudioRecording:(NSDictionary*)options){
-//  [self.rtcEngine startAudioRecording:options[@"path"] quality:(AgoraAudioRecordingQuality)[options[@"quality"] integerValue]];
-//}
-//
-//// stop recoding service
-//RCT_EXPORT_METHOD(stopAudioRecording:(NSString*)recordingKey){
-//  [self.rtcEngine stopAudioRecording];
-//}
-
 // adjust recorcding signal volume
 RCT_EXPORT_METHOD(adjustRecordingSignalVolume: (NSInteger) volume){
   [self.rtcEngine adjustRecordingSignalVolume:volume];
@@ -692,7 +682,7 @@ RCT_EXPORT_METHOD(playEffect
                                    loopCount:(int)[options[@"loopCount"] integerValue]
                                        pitch:[options[@"pitch"] doubleValue]
                                          pan:[options[@"pan"] doubleValue]
-                                        gain:[options[@"gain"] boolValue]
+                                        gain:[options[@"gain"] doubleValue]
                                      publish:[options[@"publish"] boolValue]];
   if (res != 0) {
     reject(@"131010", @"playEffect failed", [self makeNSError:@{
@@ -1052,7 +1042,7 @@ RCT_EXPORT_METHOD(disableLastmileTest
 }
 
 // set recording audioframe parameters with samplerate
-RCT_EXPORT_METHOD(setRecordingAudioFrameParametersWithSampleRate:(NSDictionary *) options
+RCT_EXPORT_METHOD(setRecordingAudioFrameParameters:(NSDictionary *) options
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject) {
   NSInteger res = [self.rtcEngine setRecordingAudioFrameParametersWithSampleRate:[options[@"sampleRate"] integerValue]
@@ -1061,7 +1051,7 @@ RCT_EXPORT_METHOD(setRecordingAudioFrameParametersWithSampleRate:(NSDictionary *
                                                                   samplesPerCall:[options[@"samplesPerCall"] integerValue]
                    ];
   if (res != 0) {
-    reject(@"131023", @"setRecordingAudioFrameParametersWithSampleRate failed", [self makeNSError:@{
+    reject(@"131023", @"setRecordingAudioFrameParameters failed", [self makeNSError:@{
                                                                                                     @"code": @(131023),
                                                                                                     @"message":@{
                                                                                                         @"success": @(NO),
@@ -1077,7 +1067,7 @@ RCT_EXPORT_METHOD(setRecordingAudioFrameParametersWithSampleRate:(NSDictionary *
 }
 
 // set playback audioframe parameters with samplerate
-RCT_EXPORT_METHOD(setPlaybackAudioFrameParametersWithSampleRate:(NSDictionary *) options
+RCT_EXPORT_METHOD(setPlaybackAudioFrameParameters:(NSDictionary *) options
                   resolve:(RCTPromiseResolveBlock)resolve
                   reject:(RCTPromiseRejectBlock)reject) {
   NSInteger res = [self.rtcEngine setPlaybackAudioFrameParametersWithSampleRate:[options[@"sampleRate"] integerValue]
@@ -1086,7 +1076,7 @@ RCT_EXPORT_METHOD(setPlaybackAudioFrameParametersWithSampleRate:(NSDictionary *)
                                                                  samplesPerCall:[options[@"samplesPerCall"] integerValue]
                    ];
   if (res != 0) {
-    reject(@"131024", @"setPlaybackAudioFrameParametersWithSampleRate failed", [self makeNSError:@{
+    reject(@"131024", @"setPlaybackAudioFrameParameters failed", [self makeNSError:@{
                                                                                                    @"code": @(131024),
                                                                                                    @"message":@{
                                                                                                        @"success":@(NO),
@@ -1472,7 +1462,7 @@ RCT_EXPORT_METHOD(setCameraFocusPositionInPreview
 RCT_EXPORT_METHOD(setCameraExposurePosition
                   :(NSDictionary *)options
                   resolve:(RCTPromiseResolveBlock)resolve) {
-  BOOL res = [self.rtcEngine setCameraFocusPositionInPreview:CGPointMake((CGFloat)[options[@"x"] floatValue], (CGFloat)[options[@"y"] floatValue])];
+  BOOL res = [self.rtcEngine setCameraExposurePosition:CGPointMake((CGFloat)[options[@"x"] floatValue], (CGFloat)[options[@"y"] floatValue])];
   resolve(@{
             @"success": @(YES),
             @"value": @(res)
@@ -1579,7 +1569,6 @@ RCT_EXPORT_METHOD(getSdkVersion
 // add publish stream url
 RCT_EXPORT_METHOD(addPublishStreamUrl:(NSDictionary *)options) {
   [self.rtcEngine addPublishStreamUrl:options[@"url"] transcodingEnabled:[options[@"enable"] boolValue]];
-  [self.rtcEngine setLiveTranscoding:AgoraLiveTranscoding.defaultTranscoding];
 }
 
 // remove publish stream url