Skip to content

Commit bd60d1a

Browse files
committed
updated multiBroadcastTag doc, added doc for attributes on Broadcast class
1 parent 008f8fe commit bd60d1a

File tree

3 files changed

+48
-12
lines changed

3 files changed

+48
-12
lines changed

opentok/archives.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -108,15 +108,6 @@ class Archive(object):
108108
"available"; for other archives, (including archives with the status "uploaded") this property is
109109
set to null. The download URL is obfuscated, and the file is only available from the URL for
110110
10 minutes. To generate a new URL, call the Archive.listArchives() or OpenTok.getArchive() method.
111-
112-
:ivar multi_archive_tag:
113-
Set this to support recording multiple archives for the same session simultaneously.
114-
Set this to a unique string for each simultaneous archive of an ongoing session.
115-
You must also set this option when manually starting an archive that is automatically archived.
116-
Note that the multiArchiveTag value is not included in the response for the methods to list archives and
117-
retrieve archive information. If you do not specify a unique multi_archive_tag, you can only record one archive
118-
at a time for a given session.
119-
For more information, see simultaneous archives: https://tokbox.com/developer/guides/archiving/#simultaneous-archives.
120111
"""
121112

122113
def __init__(self, sdk, values):

opentok/broadcast.py

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,53 @@ class Broadcast(object):
77
"""
88
Represents a live streaming broadcast.
99
10+
:ivar id:
11+
The broadcast ID.
12+
13+
:ivar session_id:
14+
The session ID of the OpenTok session associated with this broadcast.
15+
16+
:ivar project_id:
17+
Your OpenTok API key.
18+
19+
:ivar created_at:
20+
The time at which the broadcast was created, in milliseconds since the UNIX epoch.
21+
22+
:ivar updated_at:
23+
The time at which the broadcast was last updated, in milliseconds since the UNIX epoch.
24+
25+
:ivar resolution:
26+
The resolution of the broadcast (either "640x480", "1280x720", "1920x1080", "480x640", "720x1280", or "1920x1080").
27+
28+
:ivar status:
29+
The status of the broadcast.
30+
31+
:ivar broadcastUrls:
32+
An object containing details about the HLS and RTMP broadcasts.
33+
34+
If you specified an HLS endpoint, the object includes an hls property, which is set to the URL for the HLS broadcast.
35+
Note this HLS broadcast URL points to an index file, an .M3U8-formatted playlist that contains a list of URLs
36+
to .ts media segment files (MPEG-2 transport stream files).
37+
While the URLs of both the playlist index file and media segment files are provided as soon as the HTTP response
38+
is returned, these URLs should not be accessed until 15 - 20 seconds later,
39+
after the initiation of the HLS broadcast, due to the delay between the HLS broadcast and the live streams
40+
in the OpenTok session.
41+
See https://developer.apple.com/library/ios/technotes/tn2288/_index.html for more information about the playlist index
42+
file and media segment files for HLS.
43+
44+
If you specified RTMP stream endpoints, the object includes an rtmp property.
45+
This is an array of objects that include information on each of the RTMP streams.
46+
Each of these objects has the following properties: id (the ID you assigned to the RTMP stream),
47+
serverUrl (the server URL), streamName (the stream name), and status property (which is set to "connecting").
48+
You can call the OpenTok REST method to check for status updates for the broadcast:
49+
https://tokbox.com/developer/rest/#get_info_broadcast
50+
1051
:ivar streamMode:
1152
Whether streams included in the broadcast are selected automatically
1253
("auto", the default) or manually ("manual").
13-
54+
1455
:ivar streams:
15-
A list of streams currently being broadcast. This is only set for a broadcast with
56+
A list of streams currently being broadcasted. This is only set for a broadcast with
1657
the status set to "started" and the stream_Mode set to "manual".
1758
"""
1859

opentok/opentok.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1324,7 +1324,11 @@ def start_broadcast(self, session_id, options, stream_mode=BroadcastStreamModes.
13241324
String 'resolution' optional: The resolution of the broadcast, either "640x480"
13251325
(SD, the default) or "1280x720" (HD)
13261326
1327-
String 'multiBroadcastTag' optional: If specified, triggers a new simultaneous broadcast on the session.
1327+
String 'multiBroadcastTag' optional: Set this to support multiple broadcasts for the same session simultaneously.
1328+
Set this to a unique string for each simultaneous broadcast of an ongoing session.
1329+
Note that the multiBroadcastTag value is not included in the response for the methods to list live streaming
1330+
broadcasts and get information about a live streaming broadcast.
1331+
For more information, see https://tokbox.com/developer/guides/broadcast/live-streaming#simultaneous-broadcasts.
13281332
13291333
:param BroadcastStreamModes stream_mode (Optional): Determines the broadcast stream handling mode.
13301334
Set this to BroadcastStreamModes.auto (the default) to have streams added automatically. Set this to

0 commit comments

Comments
 (0)