File tree Expand file tree Collapse file tree 2 files changed +19
-15
lines changed Expand file tree Collapse file tree 2 files changed +19
-15
lines changed Original file line number Diff line number Diff line change @@ -27,12 +27,14 @@ class OutputModes(Enum):
27
27
"""Each stream in the archive is recorded to an individual file."""
28
28
29
29
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."""
31
32
32
33
auto = u ("auto" )
33
- """Streams will automatically be selected and added to archive"""
34
+ """Streams are automatically added to archive. """
34
35
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."""
36
38
37
39
class Archive (object ):
38
40
"""Represents an archive of an OpenTok session.
@@ -63,12 +65,12 @@ class Archive(object):
63
65
(OutputModes.composed) or to individual files (OutputModes.individual).
64
66
65
67
: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").
69
70
70
71
: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".
72
74
73
75
:ivar partner_id:
74
76
The API key associated with the archive.
Original file line number Diff line number Diff line change 6
6
7
7
class Broadcast (object ):
8
8
"""
9
- Represents a live streaming broadcast
9
+ Represents a live streaming broadcast.
10
10
11
11
: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").
15
14
16
15
: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".
18
18
"""
19
19
20
20
def __init__ (self , kwargs ):
@@ -36,9 +36,11 @@ def json(self):
36
36
return json .dumps (self , default = lambda o : o .__dict__ , sort_keys = True , indent = 4 )
37
37
38
38
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."""
40
41
41
42
auto = u ("auto" )
42
- """Streams will automatically be selected and added to broadcase """
43
+ """Streams are automatically added to broadcast. """
43
44
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."""
You can’t perform that action at this time.
0 commit comments