Browse Source

fix. typo

matrixbirds 5 years ago
parent
commit
913c0582f5

+ 1
- 1
android/src/main/java/com/syan/agora/AgoraModule.java View File

1572
     }
1572
     }
1573
 
1573
 
1574
     @ReactMethod
1574
     @ReactMethod
1575
-    public void methodisSpeakerphoneEnabled(Callback callback) {
1575
+    public void isSpeakerphoneEnabled(Callback callback) {
1576
         WritableMap map = Arguments.createMap();
1576
         WritableMap map = Arguments.createMap();
1577
         map.putBoolean("status", AgoraManager.getInstance().mRtcEngine.isSpeakerphoneEnabled());
1577
         map.putBoolean("status", AgoraManager.getInstance().mRtcEngine.isSpeakerphoneEnabled());
1578
         callback.invoke(map);
1578
         callback.invoke(map);

+ 1
- 1
ios/RCTAgora/RCTAgora.m View File

671
 }
671
 }
672
 
672
 
673
 // is speaker phone enabled
673
 // is speaker phone enabled
674
-RCT_EXPORT_METHOD(methodisSpeakerphoneEnabled:(RCTResponseSenderBlock)callback) {
674
+RCT_EXPORT_METHOD(isSpeakerphoneEnabled:(RCTResponseSenderBlock)callback) {
675
   callback(@[@{@"status": @([self.rtcEngine isSpeakerphoneEnabled])}]);
675
   callback(@[@{@"status": @([self.rtcEngine isSpeakerphoneEnabled])}]);
676
 }
676
 }
677
 
677
 

+ 21
- 21
lib/RtcEngine.native.d.ts View File

419
      * @param callback
419
      * @param callback
420
      * @return any
420
      * @return any
421
      */
421
      */
422
-    static methodisSpeakerphoneEnabled(callback: Callback<any>): any;
422
+    static isSpeakerphoneEnabled(callback: Callback<any>): any;
423
     /**
423
     /**
424
      * enable in-ear monitor
424
      * enable in-ear monitor
425
      *
425
      *
566
     /**
566
     /**
567
      * stop play effect for audio mixing
567
      * stop play effect for audio mixing
568
      *
568
      *
569
-     * This methods stops the specified effect for audio mixing file by soundid.
569
+     * This methods stops the specified effect for audio mixing file by soundId.
570
      * @param sounid
570
      * @param sounid
571
      * @return Promise<{success, value}>
571
      * @return Promise<{success, value}>
572
      */
572
      */
581
     /**
581
     /**
582
      * preload effect for audio mixing file.
582
      * preload effect for audio mixing file.
583
      *
583
      *
584
-     * This methods preloads the specified audio mixing file to memory by the soundid
585
-     * @param soundid
586
-     * @param filepath
584
+     * This methods preloads the specified audio mixing file to memory by the soundId
585
+     * @param soundId
586
+     * @param filePath
587
      * @return Promise<{success, value}>
587
      * @return Promise<{success, value}>
588
      */
588
      */
589
-    static preloadEffect(soundId: number, filepath: string): Promise<any>;
589
+    static preloadEffect(soundId: number, filePath: string): Promise<any>;
590
     /**
590
     /**
591
      * unload effect
591
      * unload effect
592
      *
592
      *
593
-     * This methods unload the already loaded audio mixing file from memory by the soundid.
594
-     * @param soundid
593
+     * This methods unload the already loaded audio mixing file from memory by the soundId.
594
+     * @param soundId
595
      * @return Promise<{success, value}>
595
      * @return Promise<{success, value}>
596
      */
596
      */
597
     static unloadEffect(soundId: number): Promise<any>;
597
     static unloadEffect(soundId: number): Promise<any>;
598
     /**
598
     /**
599
-     * pause the specified effect for audio mixing by soundid
599
+     * pause the specified effect for audio mixing by soundId
600
      *
600
      *
601
-     * This method pauses the specified effect for audio mixing by soundid.
602
-     * @param soundid
601
+     * This method pauses the specified effect for audio mixing by soundId.
602
+     * @param soundId
603
      * @return Promise<{success, value}>
603
      * @return Promise<{success, value}>
604
      */
604
      */
605
     static pauseEffect(soundId: number): Promise<any>;
605
     static pauseEffect(soundId: number): Promise<any>;
607
      * pause all effects for audio mixing
607
      * pause all effects for audio mixing
608
      *
608
      *
609
      * This method pause all effects for audio mixing.
609
      * This method pause all effects for audio mixing.
610
-     * @param soundid
610
+     * @param soundId
611
      * @return Promise<{success, value}>
611
      * @return Promise<{success, value}>
612
      */
612
      */
613
     static pauseAllEffects(): Promise<any>;
613
     static pauseAllEffects(): Promise<any>;
614
     /**
614
     /**
615
-     * resume audio mixing effect by the specified soundid
615
+     * resume audio mixing effect by the specified soundId
616
      *
616
      *
617
-     * This method resumes audio mixing effect by the specified soundid
618
-     * @param soundid
617
+     * This method resumes audio mixing effect by the specified soundId
618
+     * @param soundId
619
      * @return Promise<{success, value}>
619
      * @return Promise<{success, value}>
620
      */
620
      */
621
     static resumeEffect(soundId: number): Promise<any>;
621
     static resumeEffect(soundId: number): Promise<any>;
728
      *
728
      *
729
      * @return Promise<{success, value}>
729
      * @return Promise<{success, value}>
730
      */
730
      */
731
-    static removclearVideoWatermarkse(): Promise<any>;
731
+    static clearVideoWatermarks(): Promise<any>;
732
     /**
732
     /**
733
      * set local publish fallback
733
      * set local publish fallback
734
      *
734
      *
897
      *
897
      *
898
      * This method sets the log file generated path and specified the log level.
898
      * This method sets the log file generated path and specified the log level.
899
      *
899
      *
900
-     * @param filepath string
900
+     * @param filePath string
901
      * @param level enum
901
      * @param level enum
902
      * @param maxfileSize integer (KB)
902
      * @param maxfileSize integer (KB)
903
      * @return Promise<{success, value}>
903
      * @return Promise<{success, value}>
904
      */
904
      */
905
-    static setLog(filepath: string, level: number, maxfileSize: number): Promise<any>;
905
+    static setLog(filePath: string, level: number, maxfileSize: number): Promise<any>;
906
     /**
906
     /**
907
      * add publish stream url
907
      * add publish stream url
908
      *
908
      *
1037
      *
1037
      *
1038
      * This method sets the priority of a remote user's media stream.
1038
      * This method sets the priority of a remote user's media stream.
1039
      * @param uid number
1039
      * @param uid number
1040
-     * @param userPriority number | The value range is  [50 is "user's priority is hgih", 100 is "the default user's priority is normal"]
1040
+     * @param userPriority number | The value range is  [50 is "user's priority is high", 100 is "the default user's priority is normal"]
1041
      *
1041
      *
1042
      * @return Promise<any>
1042
      * @return Promise<any>
1043
      */
1043
      */
1044
-    static setRemoteUserPriority(uid: number, userPrority: number): Promise<any>;
1044
+    static setRemoteUserPriority(uid: number, userPriority: number): Promise<any>;
1045
     /**
1045
     /**
1046
      * start an audio call test.
1046
      * start an audio call test.
1047
      *
1047
      *
1048
      * note:
1048
      * note:
1049
      *   Call this method before joining a channel.
1049
      *   Call this method before joining a channel.
1050
-     *   After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinchannel method.
1050
+     *   After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinChannel method.
1051
      *   In the Live-broadcast profile, only a host can call this method.
1051
      *   In the Live-broadcast profile, only a host can call this method.
1052
      * This method will start an audio call test with interval parameter.
1052
      * This method will start an audio call test with interval parameter.
1053
      * In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.
1053
      * In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.

+ 25
- 25
lib/RtcEngine.native.js View File

586
      * @param callback
586
      * @param callback
587
      * @return any
587
      * @return any
588
      */
588
      */
589
-    static methodisSpeakerphoneEnabled(callback) {
590
-        return Agora.methodisSpeakerphoneEnabled(callback);
589
+    static isSpeakerphoneEnabled(callback) {
590
+        return Agora.isSpeakerphoneEnabled(callback);
591
     }
591
     }
592
     /**
592
     /**
593
      * enable in-ear monitor
593
      * enable in-ear monitor
773
     /**
773
     /**
774
      * stop play effect for audio mixing
774
      * stop play effect for audio mixing
775
      *
775
      *
776
-     * This methods stops the specified effect for audio mixing file by soundid.
776
+     * This methods stops the specified effect for audio mixing file by soundId.
777
      * @param sounid
777
      * @param sounid
778
      * @return Promise<{success, value}>
778
      * @return Promise<{success, value}>
779
      */
779
      */
792
     /**
792
     /**
793
      * preload effect for audio mixing file.
793
      * preload effect for audio mixing file.
794
      *
794
      *
795
-     * This methods preloads the specified audio mixing file to memory by the soundid
796
-     * @param soundid
797
-     * @param filepath
795
+     * This methods preloads the specified audio mixing file to memory by the soundId
796
+     * @param soundId
797
+     * @param filePath
798
      * @return Promise<{success, value}>
798
      * @return Promise<{success, value}>
799
      */
799
      */
800
-    static preloadEffect(soundId, filepath) {
801
-        return Agora.preloadEffect(soundId, filepath);
800
+    static preloadEffect(soundId, filePath) {
801
+        return Agora.preloadEffect(soundId, filePath);
802
     }
802
     }
803
     /**
803
     /**
804
      * unload effect
804
      * unload effect
805
      *
805
      *
806
-     * This methods unload the already loaded audio mixing file from memory by the soundid.
807
-     * @param soundid
806
+     * This methods unload the already loaded audio mixing file from memory by the soundId.
807
+     * @param soundId
808
      * @return Promise<{success, value}>
808
      * @return Promise<{success, value}>
809
      */
809
      */
810
     static unloadEffect(soundId) {
810
     static unloadEffect(soundId) {
811
         return Agora.unloadEffect(soundId);
811
         return Agora.unloadEffect(soundId);
812
     }
812
     }
813
     /**
813
     /**
814
-     * pause the specified effect for audio mixing by soundid
814
+     * pause the specified effect for audio mixing by soundId
815
      *
815
      *
816
-     * This method pauses the specified effect for audio mixing by soundid.
817
-     * @param soundid
816
+     * This method pauses the specified effect for audio mixing by soundId.
817
+     * @param soundId
818
      * @return Promise<{success, value}>
818
      * @return Promise<{success, value}>
819
      */
819
      */
820
     static pauseEffect(soundId) {
820
     static pauseEffect(soundId) {
824
      * pause all effects for audio mixing
824
      * pause all effects for audio mixing
825
      *
825
      *
826
      * This method pause all effects for audio mixing.
826
      * This method pause all effects for audio mixing.
827
-     * @param soundid
827
+     * @param soundId
828
      * @return Promise<{success, value}>
828
      * @return Promise<{success, value}>
829
      */
829
      */
830
     static pauseAllEffects() {
830
     static pauseAllEffects() {
831
         return Agora.pauseAllEffects();
831
         return Agora.pauseAllEffects();
832
     }
832
     }
833
     /**
833
     /**
834
-     * resume audio mixing effect by the specified soundid
834
+     * resume audio mixing effect by the specified soundId
835
      *
835
      *
836
-     * This method resumes audio mixing effect by the specified soundid
837
-     * @param soundid
836
+     * This method resumes audio mixing effect by the specified soundId
837
+     * @param soundId
838
      * @return Promise<{success, value}>
838
      * @return Promise<{success, value}>
839
      */
839
      */
840
     static resumeEffect(soundId) {
840
     static resumeEffect(soundId) {
973
      *
973
      *
974
      * @return Promise<{success, value}>
974
      * @return Promise<{success, value}>
975
      */
975
      */
976
-    static removclearVideoWatermarkse() {
976
+    static clearVideoWatermarks() {
977
         return Agora.clearVideoWatermarks();
977
         return Agora.clearVideoWatermarks();
978
     }
978
     }
979
     /**
979
     /**
1180
      *
1180
      *
1181
      * This method sets the log file generated path and specified the log level.
1181
      * This method sets the log file generated path and specified the log level.
1182
      *
1182
      *
1183
-     * @param filepath string
1183
+     * @param filePath string
1184
      * @param level enum
1184
      * @param level enum
1185
      * @param maxfileSize integer (KB)
1185
      * @param maxfileSize integer (KB)
1186
      * @return Promise<{success, value}>
1186
      * @return Promise<{success, value}>
1187
      */
1187
      */
1188
-    static setLog(filepath, level, maxfileSize) {
1189
-        return Agora.setLog(filepath, level, maxfileSize);
1188
+    static setLog(filePath, level, maxfileSize) {
1189
+        return Agora.setLog(filePath, level, maxfileSize);
1190
     }
1190
     }
1191
     /**
1191
     /**
1192
      * add publish stream url
1192
      * add publish stream url
1347
      *
1347
      *
1348
      * This method sets the priority of a remote user's media stream.
1348
      * This method sets the priority of a remote user's media stream.
1349
      * @param uid number
1349
      * @param uid number
1350
-     * @param userPriority number | The value range is  [50 is "user's priority is hgih", 100 is "the default user's priority is normal"]
1350
+     * @param userPriority number | The value range is  [50 is "user's priority is high", 100 is "the default user's priority is normal"]
1351
      *
1351
      *
1352
      * @return Promise<any>
1352
      * @return Promise<any>
1353
      */
1353
      */
1354
-    static setRemoteUserPriority(uid, userPrority) {
1354
+    static setRemoteUserPriority(uid, userPriority) {
1355
         let uint32 = react_native_1.Platform.OS === 'android' ? this.Uint32ToInt32(uid) : uid;
1355
         let uint32 = react_native_1.Platform.OS === 'android' ? this.Uint32ToInt32(uid) : uid;
1356
-        return Agora.setRemoteUserPriority(uint32, userPrority);
1356
+        return Agora.setRemoteUserPriority(uint32, userPriority);
1357
     }
1357
     }
1358
     /**
1358
     /**
1359
      * start an audio call test.
1359
      * start an audio call test.
1360
      *
1360
      *
1361
      * note:
1361
      * note:
1362
      *   Call this method before joining a channel.
1362
      *   Call this method before joining a channel.
1363
-     *   After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinchannel method.
1363
+     *   After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinChannel method.
1364
      *   In the Live-broadcast profile, only a host can call this method.
1364
      *   In the Live-broadcast profile, only a host can call this method.
1365
      * This method will start an audio call test with interval parameter.
1365
      * This method will start an audio call test with interval parameter.
1366
      * In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.
1366
      * In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.

+ 1
- 1
lib/RtcEngine.native.js.map
File diff suppressed because it is too large
View File


+ 25
- 25
src/RtcEngine.native.ts View File

663
      * @param callback
663
      * @param callback
664
      * @return any
664
      * @return any
665
      */
665
      */
666
-    public static methodisSpeakerphoneEnabled(callback: Callback<any>): any {
667
-        return Agora.methodisSpeakerphoneEnabled(callback);
666
+    public static isSpeakerphoneEnabled(callback: Callback<any>): any {
667
+        return Agora.isSpeakerphoneEnabled(callback);
668
     }
668
     }
669
 
669
 
670
     /**
670
     /**
870
      /**
870
      /**
871
       * stop play effect for audio mixing
871
       * stop play effect for audio mixing
872
       *
872
       *
873
-      * This methods stops the specified effect for audio mixing file by soundid.
873
+      * This methods stops the specified effect for audio mixing file by soundId.
874
       * @param sounid
874
       * @param sounid
875
       * @return Promise<{success, value}>
875
       * @return Promise<{success, value}>
876
       */
876
       */
891
      /**
891
      /**
892
       * preload effect for audio mixing file.
892
       * preload effect for audio mixing file.
893
       *
893
       *
894
-      * This methods preloads the specified audio mixing file to memory by the soundid
895
-      * @param soundid
896
-      * @param filepath
894
+      * This methods preloads the specified audio mixing file to memory by the soundId
895
+      * @param soundId
896
+      * @param filePath
897
       * @return Promise<{success, value}>
897
       * @return Promise<{success, value}>
898
       */
898
       */
899
-     public static preloadEffect(soundId: number, filepath: string): Promise<any> {
900
-        return Agora.preloadEffect(soundId, filepath);
899
+     public static preloadEffect(soundId: number, filePath: string): Promise<any> {
900
+        return Agora.preloadEffect(soundId, filePath);
901
      }
901
      }
902
 
902
 
903
      /**
903
      /**
904
       * unload effect
904
       * unload effect
905
       *
905
       *
906
-      * This methods unload the already loaded audio mixing file from memory by the soundid.
907
-      * @param soundid
906
+      * This methods unload the already loaded audio mixing file from memory by the soundId.
907
+      * @param soundId
908
       * @return Promise<{success, value}>
908
       * @return Promise<{success, value}>
909
       */
909
       */
910
      public static unloadEffect(soundId: number): Promise<any> {
910
      public static unloadEffect(soundId: number): Promise<any> {
912
      }
912
      }
913
 
913
 
914
      /**
914
      /**
915
-      * pause the specified effect for audio mixing by soundid
915
+      * pause the specified effect for audio mixing by soundId
916
       *
916
       *
917
-      * This method pauses the specified effect for audio mixing by soundid.
918
-      * @param soundid
917
+      * This method pauses the specified effect for audio mixing by soundId.
918
+      * @param soundId
919
       * @return Promise<{success, value}>
919
       * @return Promise<{success, value}>
920
       */
920
       */
921
      public static pauseEffect(soundId: number): Promise<any> {
921
      public static pauseEffect(soundId: number): Promise<any> {
926
       * pause all effects for audio mixing
926
       * pause all effects for audio mixing
927
       *
927
       *
928
       * This method pause all effects for audio mixing.
928
       * This method pause all effects for audio mixing.
929
-      * @param soundid
929
+      * @param soundId
930
       * @return Promise<{success, value}>
930
       * @return Promise<{success, value}>
931
       */
931
       */
932
      public static pauseAllEffects(): Promise<any> {
932
      public static pauseAllEffects(): Promise<any> {
934
      }
934
      }
935
 
935
 
936
      /**
936
      /**
937
-      * resume audio mixing effect by the specified soundid
937
+      * resume audio mixing effect by the specified soundId
938
       *
938
       *
939
-      * This method resumes audio mixing effect by the specified soundid
940
-      * @param soundid
939
+      * This method resumes audio mixing effect by the specified soundId
940
+      * @param soundId
941
       * @return Promise<{success, value}>
941
       * @return Promise<{success, value}>
942
       */
942
       */
943
      public static resumeEffect(soundId: number): Promise<any> {
943
      public static resumeEffect(soundId: number): Promise<any> {
1089
      *
1089
      *
1090
      * @return Promise<{success, value}>
1090
      * @return Promise<{success, value}>
1091
      */
1091
      */
1092
-    public static removclearVideoWatermarkse(): Promise<any> {
1092
+    public static clearVideoWatermarks(): Promise<any> {
1093
         return Agora.clearVideoWatermarks();
1093
         return Agora.clearVideoWatermarks();
1094
     }
1094
     }
1095
 
1095
 
1317
      *
1317
      *
1318
      * This method sets the log file generated path and specified the log level.
1318
      * This method sets the log file generated path and specified the log level.
1319
      *
1319
      *
1320
-     * @param filepath string
1320
+     * @param filePath string
1321
      * @param level enum
1321
      * @param level enum
1322
      * @param maxfileSize integer (KB)
1322
      * @param maxfileSize integer (KB)
1323
      * @return Promise<{success, value}>
1323
      * @return Promise<{success, value}>
1324
      */
1324
      */
1325
-    public static setLog(filepath: string, level: number, maxfileSize: number): Promise<any> {
1326
-        return Agora.setLog(filepath, level, maxfileSize)
1325
+    public static setLog(filePath: string, level: number, maxfileSize: number): Promise<any> {
1326
+        return Agora.setLog(filePath, level, maxfileSize)
1327
     }
1327
     }
1328
 
1328
 
1329
     /**
1329
     /**
1498
      *
1498
      *
1499
      * This method sets the priority of a remote user's media stream.
1499
      * This method sets the priority of a remote user's media stream.
1500
      * @param uid number
1500
      * @param uid number
1501
-     * @param userPriority number | The value range is  [50 is "user's priority is hgih", 100 is "the default user's priority is normal"]
1501
+     * @param userPriority number | The value range is  [50 is "user's priority is high", 100 is "the default user's priority is normal"]
1502
      *
1502
      *
1503
      * @return Promise<any>
1503
      * @return Promise<any>
1504
      */
1504
      */
1505
-    static setRemoteUserPriority(uid: number, userPrority: number): Promise<any> {
1505
+    static setRemoteUserPriority(uid: number, userPriority: number): Promise<any> {
1506
         let uint32 = Platform.OS === 'android' ? this.Uint32ToInt32(uid) : uid;
1506
         let uint32 = Platform.OS === 'android' ? this.Uint32ToInt32(uid) : uid;
1507
-        return Agora.setRemoteUserPriority(uint32, userPrority);
1507
+        return Agora.setRemoteUserPriority(uint32, userPriority);
1508
     }
1508
     }
1509
 
1509
 
1510
     /**
1510
     /**
1512
      *
1512
      *
1513
      * note:
1513
      * note:
1514
      *   Call this method before joining a channel.
1514
      *   Call this method before joining a channel.
1515
-     *   After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinchannel method.
1515
+     *   After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinChannel method.
1516
      *   In the Live-broadcast profile, only a host can call this method.
1516
      *   In the Live-broadcast profile, only a host can call this method.
1517
      * This method will start an audio call test with interval parameter.
1517
      * This method will start an audio call test with interval parameter.
1518
      * In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.
1518
      * In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.