Skip to content

Commit 0780490

Browse files
committed
add auto archive improvements
1 parent f4cb1fe commit 0780490

File tree

3 files changed

+299
-148
lines changed

3 files changed

+299
-148
lines changed

README.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,15 @@ keyword parameters for this method:
6262
* ``archive_mode`` which specifies whether the session will be automatically archived (``always``)
6363
or not (``manual``).
6464

65+
* ``archive_name`` which indicates the archive name for all the archives in auto archived session.
66+
A session that begins with archive mode 'always' will be using this archive name for all archives of that session.
67+
Passing 'archive_name' with archive mode 'manual' will cause an error response.
68+
69+
* ``archive_resolution`` which indicates the archive resolution for all the archives in auto archived session.
70+
Valid values are '640x480', '480x640', '1280x720', '720x1280', '1920x1080' and '1080x1920'.
71+
A session that begins with archive mode 'always' will be using this resolution for all archives of that session.
72+
Passing 'archive_resolution' with archive mode 'manual' will cause an error response.
73+
6574
* ``e2ee`` which is a boolean. This specifies whether to enable
6675
`end-to-end encryption <https://tokbox.com/developer/guides/end-to-end-encryption/>`_
6776
for the OpenTok session.
@@ -82,6 +91,14 @@ store (such as a database).
8291
# An automatically archived session:
8392
session = opentok.create_session(media_mode=MediaModes.routed, archive_mode=ArchiveModes.always)
8493
94+
# An automatically archived session with the archive name and resolution specified:
95+
session = opentok.create_session(
96+
media_mode=MediaModes.routed,
97+
archive_mode=ArchiveModes.always,
98+
archive_name='my_archive',
99+
archive_resolution='1920x1080'
100+
)
101+
85102
# A session with a location hint
86103
session = opentok.create_session(location=u'12.34.56.78')
87104

0 commit comments

Comments
 (0)