URL Schema
Haivision Play Pro allows the use of custom URLs to play content from HMP and non-HMP sources and stream content to a receiver.
Note
For help setting up and watching SRT streams, Haivision has created Playmaker, a free online tool for configuring and sharing SRT Caller mode URLs and QR codes.
To configure advanced Play Pro parameters, use the following syntax.
Schema
https://play.haivision.com/<action>?<param[=value]>[&<param=value>]
Note
Everything after "<action>?" in the URL must be URL-encoded. To easily URL encode text, use a website such as: https://www.url-encode-decode.com/
Action
load – Load a source or session from HMP.
play – Start the player.
stream – Start the encoder.
lineup – Add an import lineup server or file to Play Mobile Services.
service – Add an import HMP file to Play Mobile Services.
enterprise – Switch to Enterprise local mode and add an imported HMP file to Play Mobile Services.
Parameters
Parameter | Value | Notes |
|---|---|---|
Parameters for Load | ||
url | HMP URL of a source or session | Value must be URL-encoded. |
Parameters for Play | ||
url | Input URL | Each protocol has its own schema. Value must be URL-encoded. |
name | Name | Name displayed when video is playing. |
Parameters for Stream | ||
url | Output URL | Each protocol has its own schema. Value must be URL-encoded. |
name | Name | Value must be URL-encoded. |
vbitrate | Video bitrate in Kbps | |
abitrate | Audio bitrate | Valid values: 128, 192, 256. |
resolution | Video resolution | Valid values: 480p, 720p, 1080p, 2160p. Not all devices support 2160p. In this case, the next lowest resolution available will be used. |
framerate | Encoded framerate | Valid values: 15, 25, 30, 50, 60. Not all devices support all framerates. Unsupported framerates will be rounded down to the nearest supported rate. |
vcodec | Video codec | Valid values: H264, HEVC. Not all devices support HEVC. In this case, it will fallback to H264. |
Parameters for Lineup | ||
url | Server URL | URL to server/file. This is a .haiplay file that has been exported from Play Pro. If it was export locked, then the user cannot edit the lineup and it will be occasionally refreshed from the server file, allowing admins to update lineups. |
Parameters for HMP Service | ||
url | HMP server URL | URL of the HMP server. Value must be URL-encoded. |
name | Nickname of the HMP server | Display name of the HMP server. If present, this overrides the default name and any branding name set on the server side. Value must be URL-encoded. |
Parameters for Enterprise Mode | ||
url | HMP server URL | URL of the HMP server. Value must be URL-encoded. |
name | Nickname of the HMP server | Display name of the HMP server. If present, this overrides the default name and any branding set on the server side. Value must be URL-encoded. |
SRT Query Parameters
The following are SRT parameters when an SRT URL is used in any of the above URL parameters.
The stream is set to Caller mode when there is a host specified, Listener mode if host is not specified, and Rendezvous mode if a host is specified and Rendezvous is set.
Parameter | Value | Notes |
|---|---|---|
Encryption | Encryption on/off | 0=off, 1=128AES, 2=256AES. |
Passphrase | Encryption passphrase | Must be between 10 and 80 characters |
Latency | Set minimum latency | Sets SRTO_PEERLATENCY when sending, or SRTO_RCVLATENCY when receiving. |
StreamID | StreamID string | Only used in Caller mode. 512 characters maximum. |
LocalPort | Port number between 1-65535 | The port number to use locally. Setting it to "0" is the same as not including this parameter. |
Rendezvous | Rendezvous mode on | If a host is specified and this parameter is set, Rendezvous mode is enabled. |
Note
SRT URL query parameters must be encoded first, then the entire SRT URL needs to be encoded when it is a URL query parameter for any of the above actions.
Examples:
Play Pro SRT play in Caller mode, with Encryption mode on and a passphrase of "!@#$%^&*()-":
srt://192.168.1.10:4900?Encryption=2&Passphrase=%21%40%23%24%25%5E%26%2A%28%29-
https://play.haivision.com/play?url=srt%3A%2F%2F192.168.1.10%3A4900%3FEncryption%3D2%26Passphrase%3D%2521%2540%2523%2524%2525%255E%2526%252A%2528%2529-Play Pro SRT stream in Listener mode with Encryption mode on and a passphrase of "!@#$%^&*()-":
srt://192.168.1.10:4900?Encryption=2&Passphrase=%21%40%23%24%25%5E%26%2A%28%29-
https://play.haivision.com/stream?url=srt%3A%2F%2F%3A4900%3FEncryption%3D2%26Passphrase%3D%2521%2540%2523%2524%2525%255E%2526%252A%2528%2529-%26Latency%3D200&vbitrate=2000&abitrate=128&resolution=720&framerate=30&vcodec=h264