Skip to content

Commit 008f8fe

Browse files
committed
adding more doc info for multi_archive_tag
1 parent fddb2dd commit 008f8fe

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

opentok/archives.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,15 @@ 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.
111120
"""
112121

113122
def __init__(self, sdk, values):

opentok/opentok.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -536,7 +536,13 @@ def start_archive(
536536
StreamModes.manual to explicitly select streams to include in the the archive, using the
537537
OpenTok.add_archive_stream() and OpenTok.remove_archive_stream() methods.
538538
539-
:param String multi_archive_tag (Optional): If specified, triggers a new simultaneous archive on the session.
539+
:param String multi_archive_tag (Optional): Set this to support recording multiple archives for the same
540+
session simultaneously. Set this to a unique string for each simultaneous archive of an ongoing session.
541+
You must also set this option when manually starting an archive that is automatically archived.
542+
Note that the multiArchiveTag value is not included in the response for the methods to list archives and
543+
retrieve archive information. If you do not specify a unique multi_archive_tag, you can only record one archive
544+
at a time for a given session.
545+
For more information, see simultaneous archives: https://tokbox.com/developer/guides/archiving/#simultaneous-archives.
540546
541547
:rtype: The Archive object, which includes properties defining the archive,
542548
including the archive ID.

0 commit comments

Comments
 (0)