瀏覽代碼

adjusted JitsiTrack API doc

master
isymchych 10 年之前
父節點
當前提交
4b4b4398b3
共有 1 個檔案被更改,包括 18 行新增11 行删除
  1. 18
    11
      doc/API.md

+ 18
- 11
doc/API.md 查看文件

@@ -213,35 +213,42 @@ The object represents a conference. We have the following methods to control the
213 213
 
214 214
 17. addTrack(track) - Adds JitsiLocalTrack object to the conference.
215 215
     - track - the JitsiLocalTrack
216
-17. removeTrack(track) - Removes JitsiLocalTrack object to the conference.
216
+18. removeTrack(track) - Removes JitsiLocalTrack object to the conference.
217 217
     - track - the JitsiLocalTrack
218
+
219
+
218 220
 JitsiTrack
219 221
 ======
220 222
 The object represents single track - video or audio. They can be remote tracks ( from the other participants in the call) or local tracks (from the devices of the local participant).
221 223
 We have the following methods for controling the tracks:
222 224
 
223
-1.getType() - returns string with the type of the track( "video" for the video tracks and "audio" for the audio tracks)
225
+1. getType() - returns string with the type of the track( "video" for the video tracks and "audio" for the audio tracks)
226
+
227
+
228
+2. mute() - mutes the track.
224 229
 
230
+   Note: This method is implemented only for the local tracks.
225 231
 
226
-2.mute() - mutes the track.
227 232
 
228
-Note: This method is implemented only for the local tracks.
233
+3. unmute() - unmutes the track.
229 234
 
235
+   Note: This method is implemented only for the local tracks.
230 236
 
231
-3.unmute() - unmutes the track.
237
+4. isMuted() - check if track is muted
232 238
 
233
-Note: This method is implemented only for the local tracks.
239
+5. attach(container) - attaches the track to the given container.
234 240
 
241
+6. detach(container) - removes the track from the container.
235 242
 
236
-4. attach(container) - attaches the track to the given container.
243
+7. stop() - stop sending the track to the other participants in the conference.
237 244
 
238
-5. detach(container) - removes the track from the container.
245
+   Note: This method is implemented only for the local tracks.
239 246
 
240
-6. stop() - stop sending the track to the other participants in the conference.
247
+8. getId() - returns unique string for the track.
241 248
 
242
-Note: This method is implemented only for the local tracks.
249
+9. getParticipantId() - returns id(string) of the track owner
243 250
 
244
-7. getId() - returns unique string for the track.
251
+   Note: This method is implemented only for the remote tracks.
245 252
 
246 253
 
247 254
 Getting Started

Loading…
取消
儲存