@@ -200,20 +200,6 @@ ending all peers, and stopping the local screen stream
200200
201201### Methods
202202
203- ` leaveRoom() ` - leaves the currently joined room and stops local screen share
204-
205- ` disconnect() ` - calls ` disconnect ` on the signaling connection and deletes it
206-
207- ` shareScreen(callback) ` - initiates screen capture request to browser, then
208- adds the stream to the conference
209-
210- ` getLocalScreen() ` - returns the local screen stream
211-
212- ` stopScreenShare() ` - stops the screen share stream and removes it from the room
213-
214- ` testReadiness() ` - tests that the connection is ready and that (if media is
215- enabled) streams have started
216-
217203` createRoom(name, callback) ` - emits the ` create ` event on the connection with
218204` name ` and (if provided) invokes ` callback ` on response
219205
@@ -224,12 +210,53 @@ by the connection on the `join` event. See signalmaster for more details.
224210` startLocalVideo() ` - starts the local media with the ` media ` options provided
225211in the config passed to the constructor
226212
213+ ` testReadiness() ` - tests that the connection is ready and that (if media is
214+ enabled) streams have started
215+
216+ ` mute() ` - mutes the local audio stream for all peers (pauses sending audio)
217+
218+ ` unmute() ` - unmutes local audio stream for all peers (resumes sending audio)
219+
220+ ` pauseVideo() ` - pauses sending video to peers
221+
222+ ` resumeVideo() ` - resumes sending video to all peers
223+
224+ ` pause() ` - pauses sending audio and video to all peers
225+
226+ ` resume() ` - resumes sending audio and video to all peers
227+
228+ ` sendToAll(messageType, payload) ` - broadcasts a message to all peers in the
229+ room via the signaling channel (websocket)
230+
231+ - ` string messageType ` - the key for the type of message being sent
232+ - ` object payload ` - an arbitrary value or object to send to peers
233+
234+ ` sendDirectlyToAll(channelLabel, messageType, payload) ` - broadcasts a message
235+ to all peers in the room via a dataChannel
236+
237+ - ` string channelLabel ` - the label for the dataChannel to send on
238+ - ` string messageType ` - the key for the type of message being sent
239+ - ` object payload ` - an arbitrary value or object to send to peers
240+
241+ ` getPeers(sessionId, type) ` - returns all peers by ` sessionId ` and/or ` type `
242+
243+ ` shareScreen(callback) ` - initiates screen capture request to browser, then
244+ adds the stream to the conference
245+
246+ ` getLocalScreen() ` - returns the local screen stream
247+
248+ ` stopScreenShare() ` - stops the screen share stream and removes it from the room
249+
227250` stopLocalVideo() ` - stops all local media streams
228251
229252` setVolumeForAll(volume) ` - used to set the volume level for all peers
230253
231254- ` volume ` - the volume level, between 0 and 1
232255
256+ ` leaveRoom() ` - leaves the currently joined room and stops local screen share
257+
258+ ` disconnect() ` - calls ` disconnect ` on the signaling connection and deletes it
259+
233260` handlePeerStreamAdded(peer) ` - used internally to attach media stream to the
234261DOM and perform other setup
235262
0 commit comments