Skip to content

Commit e40ed76

Browse files
committed
Docs edits for selective stream archive/broadcast API enhancements
1 parent 1c30fc4 commit e40ed76

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

opentok/archives.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class StreamModes(Enum):
3131
method."""
3232

3333
auto = u("auto")
34-
"""Streams are automatically added to archive."""
34+
"""Streams are automatically added to the archive."""
3535
manual = u("manual")
3636
"""Streams are included in the archive based on calls to the OpenTok.add_archive_stream()
3737
and OpenTok.remove_archive_stream() methods."""
@@ -70,7 +70,7 @@ class Archive(object):
7070
7171
:ivar streams:
7272
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".
73+
the status set to "started" and the stream_Mode set to "manual".
7474
7575
:ivar partner_id:
7676
The API key associated with the archive.

opentok/broadcast.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ class Broadcast(object):
1313
1414
:ivar streams:
1515
A list of streams currently being broadcast. This is only set for a broadcast with
16-
the status set to "started" and the stream_Mode set to "manual".
16+
the status set to "started" and the stream_Mode set to "manual".
1717
"""
1818

1919
def __init__(self, kwargs):
@@ -39,7 +39,7 @@ class BroadcastStreamModes(Enum):
3939
method."""
4040

4141
auto = u("auto")
42-
"""Streams are automatically added to broadcast."""
42+
"""Streams are automatically added to the broadcast."""
4343
manual = u("manual")
4444
"""Streams are included in the broadcast based on calls to the OpenTok.add_broadcast_stream()
4545
and OpenTok.remove_broadcast_stream() methods."""

opentok/opentok.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -527,9 +527,10 @@ def start_archive(
527527
String 'screenshareType' optional: Layout to use for screenshares. If this is set, you must
528528
set 'type' to 'bestFit'
529529
530-
:param StreamModes stream_mode: Determines the archive stream handling mode. It's set to 'auto' by
531-
default if you want all streams to get added and set to 'manual' if you want to explicitly select
532-
the streams in the archive.
530+
:param StreamModes stream_mode (Optional): Determines the archive stream handling mode.
531+
Set this to StreamModes.auto (the default) to have streams added automatically. Set this to
532+
StreamModes.manual to explicitly select streams to include in the the archive, using the
533+
OpenTok.add_archive_stream() and OpenTok.remove_archive_stream() methods.
533534
534535
:rtype: The Archive object, which includes properties defining the archive,
535536
including the archive ID.
@@ -1246,10 +1247,6 @@ def start_broadcast(self, session_id, options, stream_mode=BroadcastStreamModes.
12461247
String 'screenshareType' optional: Layout to use for screenshares. If this is set, you must
12471248
set 'type' to 'bestFit'
12481249
1249-
:param StreamModes stream_mode: Determines the archive stream handling mode. It's set to 'auto' by
1250-
default if you want all streams to get added and set to 'manual' if you want to explicitly select
1251-
the streams in the broadcast.
1252-
12531250
Integer 'maxDuration' optional: The maximum duration for the broadcast, in seconds.
12541251
The broadcast will automatically stop when the maximum duration is reached. You can
12551252
set the maximum duration to a value from 60 (60 seconds) to 36000 (10 hours). The
@@ -1265,6 +1262,11 @@ def start_broadcast(self, session_id, options, stream_mode=BroadcastStreamModes.
12651262
String 'resolution' optional: The resolution of the broadcast, either "640x480"
12661263
(SD, the default) or "1280x720" (HD)
12671264
1265+
:param BroadcastStreamModes stream_mode (Optional): Determines the broadcast stream handling mode.
1266+
Set this to BroadcastStreamModes.auto (the default) to have streams added automatically. Set this to
1267+
BroadcastStreamModes.manual to explicitly select streams to include in the the broadcast, using the
1268+
OpenTok.add_broadcast_stream() and OpenTok.remove_broadcast_stream() methods.
1269+
12681270
:rtype A Broadcast object, which contains information of the broadcast: id, sessionId
12691271
projectId, createdAt, updatedAt, resolution, status and broadcastUrls
12701272
"""

0 commit comments

Comments
 (0)