Skip to content

Commit 08fea9d

Browse files
committed
Docs edits
1 parent 7115b0d commit 08fea9d

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

opentok/opentok.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1120,15 +1120,14 @@ def dial(self, session_id, token, sip_uri, options=[]):
11201120
}
11211121
11221122
Boolean 'secure': A Boolean flag that indicates whether the media must be transmitted
1123-
encrypted (true) or not (false, the default)
1123+
encrypted (true) or not (False, the default)
11241124
1125-
Boolean 'observeForceMute': A Boolean flag that determines whether the SIP endpoint should
1126-
honor the force mute action. The force mute action allows a moderator to force clients to
1127-
mute audio in streams they publish. It defaults to False if moderator does not want to observe
1128-
force mute a stream and set to True if the moderator wants to observe force mute a stream.
1125+
Boolean 'observeForceMute': Whether the SIP endpoint should honor a force mute action
1126+
(True) or not (False, the default). A force mute action allows a moderator to force clients to
1127+
mute audio in streams they publish.
11291128
1130-
Boolean 'video': A Boolean flag that indicates whether the SIP call will include video(true)
1131-
or not(false, which is the default). With video included, the SIP client's video is included
1129+
Boolean 'video': Whether the SIP call will include video (true)
1130+
or not (False, the default). With video included, the SIP client's video is included
11321131
in the OpenTok stream that is sent to the OpenTok session. The SIP client will receive a single
11331132
composed video of the published streams in the OpenTok session.
11341133
@@ -1650,6 +1649,10 @@ def mute_all(self,
16501649
16511650
You can include an optional list of streams IDs to exclude from being muted.
16521651
1652+
In addition to existing streams, any streams that are published after the call to
1653+
this method are published with audio muted. You can remove the mute state of a session
1654+
by calling the OpenTok.disableForceMute() method.
1655+
16531656
:param session_id The session ID
16541657
16551658
:param excludedStreamIds A list of stream IDs for streams that should not be muted.
@@ -1683,7 +1686,13 @@ def mute_all(self,
16831686

16841687
def disable_force_mute(self, session_id: str) -> requests.Response:
16851688
"""
1686-
Disables the mute all streams in an OpenTok session.
1689+
Disables the active mute state of the session. After you call this method, new streams
1690+
published to the session will no longer have audio muted.
1691+
1692+
After you call the mute_all() method, any streams published after
1693+
the call are published with audio muted. Call the OpenTok.disable_force_mute() method
1694+
to remove the mute state of a session, so that new published streams are not
1695+
automatically muted.
16871696
16881697
:param session_id The session ID.
16891698
"""
@@ -1715,7 +1724,7 @@ def mute_stream(self, session_id: str, stream_id: str) -> requests.Response:
17151724
17161725
:param session_id The session ID.
17171726
1718-
:param stream_id The stream iD.
1727+
:param stream_id The stream ID.
17191728
"""
17201729

17211730
try:

0 commit comments

Comments
 (0)