OpenTok Python SDK
Installation using Pip (recommended):
Pip helps manage dependencies for Python projects using the PyPI index. Find more info here: http://www.pip-installer.org/en/latest/
opentok package as a dependency in your project. The most common way is to add it to your
Next, install the dependencies:
$ pip install -r requirements.txt
Import the package at the top of any file where you will use it. At the very least you will need the
OpenTok class. Then initialize an OpenTok instance with your own API Key and API Secret.
from opentok import OpenTok opentok = OpenTok(api_key, api_secret)
The create an OpenTok Session, use the
opentok.create_session() method. There are three optional
keyword parameters for this method:
location which can be set to a string containing an IP
media_mode which is a String (defined by the MediaModes class) and
specifies whether the session will be automatically archived (
always) or not (
This method returns a
Session object. Its
session_id attribute is useful when saving to a persistent
store (such as a database).
# Create a session that attempts to send streams directly between clients (falling back # to use the OpenTok TURN server to relay streams if the clients cannot connect): session = opentok.create_session() from opentok import MediaModes # A session that uses the OpenTok Media Router: session = opentok.create_session(media_mode=MediaModes.routed) # An automatically archived session: session = opentok.create_session(media_mode=MediaModes.routed, archive_mode=ArchiveModes.always) # A session with a location hint session = opentok.create_session(location=u'188.8.131.52') # Store this session ID in the database session_id = session.session_id
Once a Session is created, you can start generating Tokens for clients to use when connecting to it.
You can generate a token either by calling the
opentok.generate_token(session_id) method or by
session.generate_token() method on a
Session instance after creating it. There
is a set of optional keyword parameters:
# Generate a Token from just a session_id (fetched from a database) token = opentok.generate_token(session_id) # Generate a Token by calling the method on the Session (returned from create_session) token = session.generate_token() from opentok import Roles # Set some options in a token token = session.generate_token(role=Roles.moderator, expire_time=int(time.time()) + 10, data=u'name=Johnny')
Working with Archives
You can start the recording of an OpenTok Session using the
method. This method takes an optional keyword argument
name to assign a name to the archive.
This method will return an
Archive instance. Note that you can only start an Archive on
a Session that has clients connection.
archive = opentok.start_archive(session_id, name=u'Important Presentation') # Store this archive_id in the database archive_id = archive.id
You can also disable audio or video recording by setting the has_audio or has_video property of the options parameter to false:
archive = opentok.start_archive(session_id, name=u'Important Presentation', has_video=False) # Store this archive_id in the database archive_id = archive.id
By default, all streams are recorded to a single (composed) file. You can record the different
streams in the session to individual files (instead of a single composed file) by setting the
output_mode parameter of the
opentok.start_archive() method OutputModes.individual.
archive = opentok.start_archive(session_id, name=u'Important Presentation', output_mode=OutputModes.individual) # Store this archive_id in the database archive_id = archive.id
You can stop the recording of a started Archive using the
method. You can also do this using the
archive.stop() method of an
# Stop an Archive from an archive_id (fetched from database) opentok.stop_archive(archive_id) # Stop an Archive from an instance (returned from opentok.start_archive) archive.stop()
To get an
Archive instance (and all the information about it) from an archive ID, use the
archive = opentok.get_archive(archive_id)
To delete an Archive, you can call the
opentok.delete_archive(archive_id) method or the
archive.delete() method of an
# Delete an Archive from an archive ID (fetched from database) opentok.delete_archive(archive_id) # Delete an Archive from an Archive instance (returned from opentok.start_archive or opentok.get_archive) archive.delete()
You can also get a list of all the Archives you've created (up to 1000) with your API Key. This is
done using the
opentok.list_archives() method. There are two optional keyword parameters:
offset; they can help you paginate through the results. This method returns an
instance of the
archive_list = opentok.list_archive() # Get a specific Archive from the list archive = archive_list.items[i] # Iterate over items for archive in iter(archive_list): pass # Get the total number of Archives for this API Key total = archive_list.total
Note that you can also create an automatically archived session, by passing in
ArchiveModes.always as the
archive_mode parameter when you call the
opentok.create_session() method (see "Creating Sessions," above).
For more information on archiving, see the OpenTok archiving programming guide.
There are two sample applications included in this repository. To get going as fast as possible, clone the whole repository and follow the Walkthroughs:
Reference documentation is available at <http://www.tokbox.com/opentok/libraries/server/python/reference/index.html> and in the docs directory of the SDK.
You need an OpenTok API key and API secret, which you can obtain at https://dashboard.tokbox.com/
The OpenTok Python SDK requires Python 2.6, 2.7, 3.2, 3.3, or 3.4
See the Releases page for details about each release.
Important changes since v2.2
Changes in v2.2.1:
The default setting for the create_session() method is to create a session with the media mode set to relayed. In previous versions of the SDK, the default setting was to use the OpenTok Media Router (media mode set to routed). In a relayed session, clients will attempt to send streams directly between each other (peer-to-peer); if clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams.
Changes in v2.2.0:
This version of the SDK includes support for working with OpenTok archives.
The OpenTok.create_session() method now includes a media_mode parameter, instead of a p2p parameter.
For details, see the reference documentation at <http://www.tokbox.com/opentok/libraries/server/python/reference/index.html>.
Development and Contributing
See https://support.tokbox.com/ for all our support options.
Find a bug? File it on the Issues page. Hint: test cases are really helpful!