Represents request options for OpenTok.StartRenderAsync.
More...
|
| const string | MissingSessionId = "SessionId needs to be provided." |
| | Indicates SessionId needs to be provided. More...
|
| const string | MissingToken = "Token needs to be provided." |
| | Indicates Token needs to be provided. More...
|
| const string | InvalidUrl = "Url length should be between 15 and 2048." |
| | Indicates Url length should be between 15 and 2048. More...
|
| const string | InvalidMaxDuration = "MaxDuration value should be between 60s and 36000s." |
| | Indicates MaxDuration value should be between 60s and 36000s. More...
|
| const string | InvalidResolution = "The provided resolution is not supported." |
| | Indicates the provided resolution is not supported. More...
|
|
| string | SessionId [get] |
| | The session ID. More...
|
| string | Token [get] |
| | A valid OpenTok token with a Publisher role and (optionally) connection data to be associated with the output stream. More...
|
| Uri | Url [get] |
| | A publically reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention. The absolute URI should have a minimum length of 15 and maximum length of 2048. More...
|
| int | MaxDuration [get] |
| | The maximum time allowed for the Render, in seconds. After this time, the Render will be stopped automatically, if it is still running. The minimum duration is 1 second, and the maximum is 36000 seconds (10 hours). More...
|
| RenderResolution | Resolution [get] |
| | The esolution of the display area for the composition. Allowed values are 480x640 (SD Portrait), 640x480 (SD Landscape), 720x1280 (HD Portrait), 1280x720 (HD Landscape). The default value is 1280x720 (HD Landscape). More...
|
| PublisherProperties | Properties [get] |
| | The Publisher properties for the composed output stream. More...
|
Represents request options for OpenTok.StartRenderAsync.
◆ StartRenderRequest()
- Parameters
-
| sessionId | The ID of a session (generated with the same APIKEY as specified in the URL) which you wish to start rendering into |
| token | A valid OpenTok token with a Publisher role and (optionally) connection data to be associated with the output stream. |
| url | A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention. The absolute URI should have a minimum length of 15 and maximum length of 2048. |
| resolution | Resolution of the display area for the composition. Allowed values are 480x640 (SD Portrait), 640x480 (SD Landscape), 720x1280 (HD Portrait), 1280x720 (HD Landscape). The default value is 1280x720 (HD Landscape). |
| maxDuration | The maximum time allowed for the Render, in seconds. After this time, the Render will be stopped automatically, if it is still running. The minimum duration is 1s and the maximum one is 36000s (10 hours). |
| properties | The initial configuration of Publisher properties for the composed output stream. The properties object contains the key name (String) which serves as the name of the composed output stream which is published to the session. The name must have a minimum length of 1 and a maximum length of 200. |
◆ ToDataDictionary()
| Dictionary<string, object> OpenTokSDK.Render.StartRenderRequest.ToDataDictionary |
( |
| ) |
|
◆ InvalidMaxDuration
| const string OpenTokSDK.Render.StartRenderRequest.InvalidMaxDuration = "MaxDuration value should be between 60s and 36000s." |
Indicates MaxDuration value should be between 60s and 36000s.
◆ InvalidResolution
| const string OpenTokSDK.Render.StartRenderRequest.InvalidResolution = "The provided resolution is not supported." |
Indicates the provided resolution is not supported.
◆ InvalidUrl
| const string OpenTokSDK.Render.StartRenderRequest.InvalidUrl = "Url length should be between 15 and 2048." |
Indicates Url length should be between 15 and 2048.
◆ MissingSessionId
| const string OpenTokSDK.Render.StartRenderRequest.MissingSessionId = "SessionId needs to be provided." |
Indicates SessionId needs to be provided.
◆ MissingToken
| const string OpenTokSDK.Render.StartRenderRequest.MissingToken = "Token needs to be provided." |
Indicates Token needs to be provided.
◆ MaxDuration
| int OpenTokSDK.Render.StartRenderRequest.MaxDuration |
|
The maximum time allowed for the Render, in seconds. After this time, the Render will be stopped automatically, if it is still running. The minimum duration is 1 second, and the maximum is 36000 seconds (10 hours).
◆ Properties
The Publisher properties for the composed output stream.
◆ Resolution
The esolution of the display area for the composition. Allowed values are 480x640 (SD Portrait), 640x480 (SD Landscape), 720x1280 (HD Portrait), 1280x720 (HD Landscape). The default value is 1280x720 (HD Landscape).
◆ SessionId
| string OpenTokSDK.Render.StartRenderRequest.SessionId |
|
◆ Token
| string OpenTokSDK.Render.StartRenderRequest.Token |
|
A valid OpenTok token with a Publisher role and (optionally) connection data to be associated with the output stream.
◆ Url
| Uri OpenTokSDK.Render.StartRenderRequest.Url |
|
A publically reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention. The absolute URI should have a minimum length of 15 and maximum length of 2048.
