Parameters
Key
Read/Write
Available Video Modes
Read only
Video Mode
Read/Write
Current Platform
Read/Write
Current Server
Read/Write
Current Quality Level
Read/Write
Stream Key
Read/Write
Password
Read/Write
Current URL
Read/Write
Customizable URL
Read only
Available Default
Read only
Platforms
Available Custom
Read only
Platforms
Available Servers
Read only
Available Quality Levels Read only
Changing Stream Settings
The stream settings can be changed by providing a stream settings block. The following is an
example of streaming a 1080p59.94 input on Twitch with a medium stream quality.
STREAM SETTINGS: ↵
Video Mode: 1080p59.94 ↵
Current Platform: Twitch ↵
Current Server: US West: Los Angeles, CA ↵
Current Quality Level: Streaming Medium ↵
Stream Key: live_123456789_1aB2cD3eF4gH5iJ6kL7mN8oP9qR0sT ↵
↵
ACK ↵
↵
STREAM SETTINGS: ↵
Video Mode: 1080p59.94 ↵
Current Platform: Twitch ↵
Current Server: US West: Los Angeles, CA ↵
Current Quality Level: Streaming Medium ↵
Stream Key: live_123456789_1aB2cD3eF4gH5iJ6kL7mN8oP9qR0sT ↵
↵
Description
The video modes available in the Web
Presenter
The current video mode
The selected streaming platform
The current server for the streaming platform
The current streaming quality level
The stream key for the streaming platform
The passphrase for an encrypted SRT stream String
The current URL for the streaming platform.
This field is writable if Customizable URL
field is true.
A boolean specifying whether custom URLs
are supported by the streaming platform
The available default streaming platforms
The custom streaming platforms loaded in
the Web Presenter
The available servers for the selected
streaming platform
The available quality levels for the selected
streaming platform
Valid Values
Comma separated list of video
modes
Refer to the video modes from the
Available Video Modes field
Refer to the platforms from the
Available Default Platforms and
Available Custom Platforms fields
Server is dependent on selected
Current Platform
Quality level is dependent on
selected Current Platform
String
String
true - Custom URLs are supported
false - Custom URLs are not
supported
Comma separated list of default
platforms
Comma separated list of custom
platforms
Comma separated list of servers
Comma separated list of quality
levels
Developer Information
38