Browse Source

chore. update RtcEngine#init's doc

matrixbirds 5 years ago
parent
commit
9f11663451
2 changed files with 12 additions and 2 deletions
  1. 1
    1
      package.json
  2. 11
    1
      src/types.d.ts

+ 1
- 1
package.json View File

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

+ 11
- 1
src/types.d.ts View File

10
   orientationMode: number,
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
 export interface Option {
24
 export interface Option {
14
   appid: String,
25
   appid: String,
15
-  videoProfile: number
16
   channelProfile: number,
26
   channelProfile: number,
17
   videoEncoderConfig: VideoEncoderConfig,
27
   videoEncoderConfig: VideoEncoderConfig,
18
   dualStream: boolean,
28
   dualStream: boolean,