Преглед изворни кода

chore. update RtcEngine#init's doc

matrixbirds пре 5 година
родитељ
комит
9f11663451
2 измењених фајлова са 12 додато и 2 уклоњено
  1. 1
    1
      package.json
  2. 11
    1
      src/types.d.ts

+ 1
- 1
package.json Прегледај датотеку

@@ -1,6 +1,6 @@
1 1
 {
2 2
   "name": "react-native-agora",
3
-  "version": "2.3.3-alpha.6",
3
+  "version": "2.3.3-alpha.7",
4 4
   "description": "React Native around the Agora RTC SDKs for Android and iOS agora",
5 5
   "summary": "agora native sdk for react-native",
6 6
   "main": "lib/index.js",

+ 11
- 1
src/types.d.ts Прегледај датотеку

@@ -10,9 +10,19 @@ export interface VideoEncoderConfig {
10 10
   orientationMode: number,
11 11
 }
12 12
 
13
+/**
14
+ * Option is work for init method
15
+ * @property: string appid Sets the appid
16
+ * @property: number channelProfile Sets the channel mode. 0 is communication mode, 1 is broadcasting mode
17
+ * @property: {@link VideoEncoderConfig} sets video encoding config
18
+ * @property: mode is optional sets only enable video / audio, 0 is audio mode, 1 is video mode
19
+ * @property: clientRole is only work in live mode, 1 is host, 2 is audience
20
+ * @property: dualStream is optional parameter only for enable for detail see {@link https://docs.agora.io/en/Video/API%20Reference/oc/Classes/AgoraRtcEngineKit.html#//api/name/enableDualStreamMode:}
21
+ * @property: audioProfile {@link https://docs.agora.io/en/Video/API%20Reference/oc/Constants/AgoraAudioProfile.html}
22
+ * @property: audioScenario {@link https://docs.agora.io/en/Video/API%20Reference/oc/Constants/AgoraAudioScenario.html}
23
+ */
13 24
 export interface Option {
14 25
   appid: String,
15
-  videoProfile: number
16 26
   channelProfile: number,
17 27
   videoEncoderConfig: VideoEncoderConfig,
18 28
   dualStream: boolean,