Skip to content

Commit 4af1a64

Browse files
committed
Some docs edits
1 parent 35d2f19 commit 4af1a64

File tree

2 files changed

+19
-15
lines changed

2 files changed

+19
-15
lines changed

opentok/archives.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,14 @@ class OutputModes(Enum):
2727
"""Each stream in the archive is recorded to an individual file."""
2828

2929
class StreamModes(Enum):
30-
""""List of valid settings for the stream_mode parameter of the OpenTok.start_archive()"""
30+
""""List of valid settings for the stream_mode parameter of the OpenTok.start_archive()
31+
method."""
3132

3233
auto = u("auto")
33-
"""Streams will automatically be selected and added to archive"""
34+
"""Streams are automatically added to archive."""
3435
manual = u("manual")
35-
"""Customers select which streams get added to archive"""
36+
"""Streams are included in the archive based on calls to the OpenTok.add_archive_stream()
37+
and OpenTok.remove_archive_stream() methods."""
3638

3739
class Archive(object):
3840
"""Represents an archive of an OpenTok session.
@@ -63,12 +65,12 @@ class Archive(object):
6365
(OutputModes.composed) or to individual files (OutputModes.individual).
6466
6567
:ivar streamMode:
66-
Determines the archive stream handling mode. It's set to 'auto' by
67-
default if you want all streams. To explicitly select specific streams
68-
in the archive then set to 'manual'.
68+
Whether streams included in the archive are selected automatically
69+
("auto", the default) or manually ("manual").
6970
7071
:ivar streams:
71-
A list of streams in an archive.
72+
A list of streams currently being archived. This is only set for an archive with
73+
the status set to "started" and the stream_Mode set to "manual".
7274
7375
:ivar partner_id:
7476
The API key associated with the archive.

opentok/broadcast.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66

77
class Broadcast(object):
88
"""
9-
Represents a live streaming broadcast
9+
Represents a live streaming broadcast.
1010
1111
:ivar streamMode:
12-
Determines the broadcast stream handling mode. It's set to 'auto' by
13-
default if you want all streams. To explicitly select specific streams
14-
in the broadcast then set to 'manual'.
12+
Whether streams included in the broadcast are selected automatically
13+
("auto", the default) or manually ("manual").
1514
1615
:ivar streams:
17-
A list of streams in a broadcast.
16+
A list of streams currently being broadcast. This is only set for a broadcast with
17+
the status set to "started" and the stream_Mode set to "manual".
1818
"""
1919

2020
def __init__(self, kwargs):
@@ -36,9 +36,11 @@ def json(self):
3636
return json.dumps(self, default=lambda o: o.__dict__, sort_keys=True, indent=4)
3737

3838
class BroadcastStreamModes(Enum):
39-
""""List of valid settings for the stream_mode parameter of the OpenTok.start_broadcast()"""
39+
""""List of valid settings for the stream_mode parameter of the OpenTok.start_broadcast()
40+
method."""
4041

4142
auto = u("auto")
42-
"""Streams will automatically be selected and added to broadcase"""
43+
"""Streams are automatically added to broadcast."""
4344
manual = u("manual")
44-
"""Customers select which streams get added to broadcast"""
45+
"""Streams are included in the broadcast based on calls to the OpenTok.add_broadcast_stream()
46+
and OpenTok.remove_broadcast_stream() methods."""

0 commit comments

Comments
 (0)