File tree Expand file tree Collapse file tree 2 files changed +16
-1
lines changed Expand file tree Collapse file tree 2 files changed +16
-1
lines changed Original file line number Diff line number Diff line change @@ -108,6 +108,15 @@ class Archive(object):
108
108
"available"; for other archives, (including archives with the status "uploaded") this property is
109
109
set to null. The download URL is obfuscated, and the file is only available from the URL for
110
110
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.
111
120
"""
112
121
113
122
def __init__ (self , sdk , values ):
Original file line number Diff line number Diff line change @@ -536,7 +536,13 @@ def start_archive(
536
536
StreamModes.manual to explicitly select streams to include in the the archive, using the
537
537
OpenTok.add_archive_stream() and OpenTok.remove_archive_stream() methods.
538
538
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.
540
546
541
547
:rtype: The Archive object, which includes properties defining the archive,
542
548
including the archive ID.
You can’t perform that action at this time.
0 commit comments