Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding docs for generateT1Token option #350

Merged
merged 1 commit into from
Mar 24, 2025
Merged

Adding docs for generateT1Token option #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions lib/broadcast.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@
* <li>
* <code>hlsStatus</code> (string) &mdash; The possible states for the "hlsStatus" field are the following:
* <ul>
* <li>'connecting': the opentok server is in the process of starting transcoders. This is the initial state</li>
* <li>'ready': the opentok server has succesfully initialised but CDN is not consuming media</li>
* <li>'live': the opentok server has succesfully initialised and CDN is consuming media</li>
* <li>'connecting': the OpenTok server is in the process of starting transcoders. This is the initial state</li>
* <li>'ready': the OpenTok server has succesfully initialised but CDN is not consuming media</li>
* <li>'live': the OpenTok server has succesfully initialised and CDN is consuming media</li>
* <li>'ended': the source stream has ended (if DVR is enabled and pre-recorded media is requested then status will transition to 'live')</li>
* <li>'error': there is an error in the opentok platform.
* </ul>
Expand Down
6 changes: 4 additions & 2 deletions lib/opentok.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -508,13 +508,13 @@ OpenTok = function (apiKey, apiSecret, env) {


/**
* Starts live captions for an OpenTok Session
* Starts live captions for an OpenTok session.
* <p>
* The maximum allowed duration is 4 hours, after which the audio captioning will stop without
* any effect on the ongoing OpenTok Session. An event will be posted to your callback URL if
* provided when starting the captions.
* <p>
* Each OpenTok Session supports only one audio captioning session.
* Each OpenTok session supports only one audio captioning session.
*
* @param sessionId The session ID of the OpenTok session to archive.
*
Expand Down Expand Up @@ -2138,6 +2138,8 @@ OpenTok.prototype.createSession = function (opts, callback) {
*
* </ul>
*
* @param generateT1Token Connection tokens are now SHA-256 signed JWTs. Set this to <code>true</code> to create a token using the legacy T1 format.
*
* @return The token string.
*/

Expand Down