npm
/
react-native-agora
Watch 11
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

chore. update comments

matrixbirds 4 years ago
parent
b013b6d64e
commit
92c604cfb0
4 changed files with 16 additions and 13 deletions
Split View Show Diff Stats
  1. 5
    4
      lib/RtcEngine.native.d.ts
  2. 5
    4
      lib/RtcEngine.native.js
  3. 1
    1
      lib/RtcEngine.native.js.map
  4. 5
    4
      src/RtcEngine.native.ts

+ 5
- 4
lib/RtcEngine.native.d.ts View File 

@@ -51,7 +51,8 @@ declare class RtcEngine {
51 51 
      *
52 52 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
53 53 
      * It will occurs event:
54 
-     *  Occurs onChannelMediaRelayStateChanged
54 
+     *  Occurs mediaRelayStateChanged
55 
+     *  Occurs receivedChannelMediaRelay when peer channel received this message
55 56 
      * @param config
56 57 
      */
57 58 
     static startChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any>;
 
@@ -60,7 +61,7 @@ declare class RtcEngine {
60 61 
      *
61 62 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
62 63 
      * It will occurs event:
63 
-     *  Occurs onChannelMediaRelayStateChanged
64 
+     *  Occurs mediaRelayStateChanged
64 65 
      * @param config
65 66 
      */
66 67 
     static removeChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any>;
 
@@ -69,7 +70,7 @@ declare class RtcEngine {
69 70 
      *
70 71 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
71 72 
      * It will occurs event:
72 
-     *  Occurs onChannelMediaRelayStateChanged
73 
+     *  Occurs mediaRelayStateChanged
73 74 
      * @param config
74 75 
      */
75 76 
     static updateChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any>;
 
@@ -78,7 +79,7 @@ declare class RtcEngine {
78 79 
      *
79 80 
      * This method will stop relay media stream across specified channels.
80 81 
      * It will occurs event:
81 
-     *  Occurs onChannelMediaRelayStateChanged
82 
+     *  Occurs mediaRelayStateChanged
82 83 
      * @param config
83 84 
      */
84 85 
     static stopChannelMediaRelay(): Promise<any>;

+ 5
- 4
lib/RtcEngine.native.js View File 

@@ -54,7 +54,8 @@ class RtcEngine {
54 54 
      *
55 55 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
56 56 
      * It will occurs event:
57 
-     *  Occurs onChannelMediaRelayStateChanged
57 
+     *  Occurs mediaRelayStateChanged
58 
+     *  Occurs receivedChannelMediaRelay when peer channel received this message
58 59 
      * @param config
59 60 
      */
60 61 
     static startChannelMediaRelay(config) {
 
@@ -65,7 +66,7 @@ class RtcEngine {
65 66 
      *
66 67 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
67 68 
      * It will occurs event:
68 
-     *  Occurs onChannelMediaRelayStateChanged
69 
+     *  Occurs mediaRelayStateChanged
69 70 
      * @param config
70 71 
      */
71 72 
     static removeChannelMediaRelay(config) {
 
@@ -76,7 +77,7 @@ class RtcEngine {
76 77 
      *
77 78 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
78 79 
      * It will occurs event:
79 
-     *  Occurs onChannelMediaRelayStateChanged
80 
+     *  Occurs mediaRelayStateChanged
80 81 
      * @param config
81 82 
      */
82 83 
     static updateChannelMediaRelay(config) {
 
@@ -87,7 +88,7 @@ class RtcEngine {
87 88 
      *
88 89 
      * This method will stop relay media stream across specified channels.
89 90 
      * It will occurs event:
90 
-     *  Occurs onChannelMediaRelayStateChanged
91 
+     *  Occurs mediaRelayStateChanged
91 92 
      * @param config
92 93 
      */
93 94 
     static stopChannelMediaRelay() {

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


+ 5
- 4
src/RtcEngine.native.ts View File 

@@ -97,7 +97,8 @@ class RtcEngine {
97 97 
      *
98 98 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
99 99 
      * It will occurs event:
100 
-     *  Occurs onChannelMediaRelayStateChanged
100 
+     *  Occurs mediaRelayStateChanged
101 
+     *  Occurs receivedChannelMediaRelay when peer channel received this message
101 102 
      * @param config
102 103 
      */
103 104 
     public static startChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
 
@@ -109,7 +110,7 @@ class RtcEngine {
109 110 
      *
110 111 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
111 112 
      * It will occurs event:
112 
-     *  Occurs onChannelMediaRelayStateChanged
113 
+     *  Occurs mediaRelayStateChanged
113 114 
      * @param config
114 115 
      */
115 116 
     public static removeChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
 
@@ -121,7 +122,7 @@ class RtcEngine {
121 122 
      *
122 123 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
123 124 
      * It will occurs event:
124 
-     *  Occurs onChannelMediaRelayStateChanged
125 
+     *  Occurs mediaRelayStateChanged
125 126 
      * @param config
126 127 
      */
127 128 
     public static updateChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
 
@@ -133,7 +134,7 @@ class RtcEngine {
133 134 
      *
134 135 
      * This method will stop relay media stream across specified channels.
135 136 
      * It will occurs event:
136 
-     *  Occurs onChannelMediaRelayStateChanged
137 
+     *  Occurs mediaRelayStateChanged
137 138 
      * @param config
138 139 
      */
139 140 
     public static stopChannelMediaRelay(): Promise<any> {