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

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

54 
      *
 54 
      *
55 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
 55 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
56 
      * It will occurs event:
 56 
      * It will occurs event:
57 
-     *  Occurs onChannelMediaRelayStateChanged
57 
+     *  Occurs mediaRelayStateChanged
58 
+     *  Occurs receivedChannelMediaRelay when peer channel received this message
58 
      * @param config
 59 
      * @param config
59 
      */
 60 
      */
60 
     static startChannelMediaRelay(config) {
 61 
     static startChannelMediaRelay(config) {
65 
      *
 66 
      *
66 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
 67 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
67 
      * It will occurs event:
 68 
      * It will occurs event:
68 
-     *  Occurs onChannelMediaRelayStateChanged
69 
+     *  Occurs mediaRelayStateChanged
69 
      * @param config
 70 
      * @param config
70 
      */
 71 
      */
71 
     static removeChannelMediaRelay(config) {
 72 
     static removeChannelMediaRelay(config) {
76 
      *
 77 
      *
77 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
 78 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
78 
      * It will occurs event:
 79 
      * It will occurs event:
79 
-     *  Occurs onChannelMediaRelayStateChanged
80 
+     *  Occurs mediaRelayStateChanged
80 
      * @param config
 81 
      * @param config
81 
      */
 82 
      */
82 
     static updateChannelMediaRelay(config) {
 83 
     static updateChannelMediaRelay(config) {
87 
      *
 88 
      *
88 
      * This method will stop relay media stream across specified channels.
 89 
      * This method will stop relay media stream across specified channels.
89 
      * It will occurs event:
 90 
      * It will occurs event:
90 
-     *  Occurs onChannelMediaRelayStateChanged
91 
+     *  Occurs mediaRelayStateChanged
91 
      * @param config
 92 
      * @param config
92 
      */
 93 
      */
93 
     static stopChannelMediaRelay() {
 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 
      *
97 
      *
98 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
 98 
      * This method will start relay media stream across specified channels. (maximum support 4 channels)
99 
      * It will occurs event:
 99 
      * It will occurs event:
100 
-     *  Occurs onChannelMediaRelayStateChanged
100 
+     *  Occurs mediaRelayStateChanged
101 
+     *  Occurs receivedChannelMediaRelay when peer channel received this message
101 
      * @param config
 102 
      * @param config
102 
      */
 103 
      */
103 
     public static startChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
 104 
     public static startChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
109 
      *
110 
      *
110 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
 111 
      * This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels)
111 
      * It will occurs event:
 112 
      * It will occurs event:
112 
-     *  Occurs onChannelMediaRelayStateChanged
113 
+     *  Occurs mediaRelayStateChanged
113 
      * @param config
 114 
      * @param config
114 
      */
 115 
      */
115 
     public static removeChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
 116 
     public static removeChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
121 
      *
122 
      *
122 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
 123 
      * This method will update relay media stream across specified channels. (maximum support 4 channels)
123 
      * It will occurs event:
 124 
      * It will occurs event:
124 
-     *  Occurs onChannelMediaRelayStateChanged
125 
+     *  Occurs mediaRelayStateChanged
125 
      * @param config
 126 
      * @param config
126 
      */
 127 
      */
127 
     public static updateChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
 128 
     public static updateChannelMediaRelay(config: ChannelMediaConfiguration): Promise<any> {
133 
      *
134 
      *
134 
      * This method will stop relay media stream across specified channels.
 135 
      * This method will stop relay media stream across specified channels.
135 
      * It will occurs event:
 136 
      * It will occurs event:
136 
-     *  Occurs onChannelMediaRelayStateChanged
137 
+     *  Occurs mediaRelayStateChanged
137 
      * @param config
 138 
      * @param config
138 
      */
 139 
      */
139 
     public static stopChannelMediaRelay(): Promise<any> {
 140 
     public static stopChannelMediaRelay(): Promise<any> {