Skip to content

Commit 56d9774

Browse files
committed
renamed get_render_status to get_render, updated start_render docstring
1 parent feb1d53 commit 56d9774

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

opentok/opentok.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1602,24 +1602,24 @@ def set_broadcast_layout(self, broadcast_id, layout_type, stylesheet=None, scree
16021602

16031603
def start_render(self, session_id, opentok_token, url, max_duration=7200, resolution="1280x720", status_callback_url=None, properties: dict = None):
16041604
"""
1605-
This method starts a render for the specified session.
1605+
Starts an Experience Composer for the specified OpenTok session.
1606+
For more information, see the
1607+
`Experience Composer developer guide <https://tokbox.com/developer/guides/experience-composer>`_.
16061608
1607-
:param String 'session_id': The ID of a session (generated with the same `APIKEY` as specified in the URL) which you wish to start rendering into.
1609+
:param String 'session_id': The session ID of the OpenTok session that will include the Experience Composer stream.
16081610
:param String 'token': A valid OpenTok token with a Publisher role and (optionally) connection data to be associated with the output stream.
16091611
:param String 'url': A publically reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention.
1610-
:param Integer 'maxDuration' Optional: The maximum time allowed for the Render, in seconds. After this time, the Render will be stopped automatically, if it is still running.
1611-
:param String 'resolution' Optional: Resolution of the display area for the composition.
1612-
:param String 'statusCallbackUrl' Optional: URL of the customer service where the callbacks will be received.
1612+
:param Integer 'maxDuration' Optional: The maximum time allowed for the Experience Composer, in seconds. After this time, it is stopped automatically, if it is still running. The maximum value is 36000 (10 hours), the minimum value is 60 (1 minute), and the default value is 7200 (2 hours). When the Experience Composer ends, its stream is unpublished and an event is posted to the callback URL, if configured in the Account Portal.
1613+
:param String 'resolution' Optional: The resolution of the Experience Composer, either "640x480" (SD landscape), "480x640" (SD portrait), "1280x720" (HD landscape), "720x1280" (HD portrait), "1920x1080" (FHD landscape), or "1080x1920" (FHD portrait). By default, this resolution is "1280x720" (HD landscape, the default).
16131614
:param Dictionary 'properties' Optional: Initial configuration of Publisher properties for the composed output stream.
1614-
String name Optional: The name of the composed output stream which will be published to the session.
1615+
String name Optional: The name of the composed output stream which will be published to the session. The name must have a minimum length of 1 and a maximum length of 200.
16151616
"""
16161617
payload = {
16171618
"sessionId": session_id,
16181619
"token": opentok_token,
16191620
"url": url,
16201621
"maxDuration": max_duration,
16211622
"resolution": resolution,
1622-
"statusCallbackUrl": status_callback_url,
16231623
"properties": properties
16241624
}
16251625

@@ -1654,7 +1654,7 @@ def start_render(self, session_id, opentok_token, url, max_duration=7200, resolu
16541654
raise RequestError("An unexpected error occurred", response.status_code)
16551655

16561656

1657-
def get_render_status(self, render_id):
1657+
def get_render(self, render_id):
16581658
"""
16591659
This method allows you to see the status of a render, which can be one of the following:
16601660
['starting', 'started', 'stopped', 'failed']

0 commit comments

Comments
 (0)