simplex Player - Parameters
Using parameters with the Simplex Player is easy. Here we show you the possibilities.
Supported types of parameters:
What are GET parameters?
GET parameters are used to influence functions and representations in the simplex player. The GET parameters described in this article are optional.
How to use GET parameters?
GET parameters are appended to the video link.
If a parameter is not appended to the link, the default value of the respective parameter is automatically used.
Parameters begin with a question mark «?» after the video link.
With «&» several parameters are strung together.
Example Video-Link:https://media10.simplex.tv/content/1/2/3/?parameter1¶meter2
Example Embed-Code:<iframe width="1280" height="720" src="https://media10.simplex.tv/content/1/2/3/?parameter1¶meter2" frameborder="0" allowfullscreen="true" webkitallowfullscreen="true" mozallowfullscreen="true" scrolling="no"></iframe>
Functional parameters
Parameter | Description | Values |
---|---|---|
accessibility |
Prevents hiding the accessibility related controls and enables the back button to use the player with keys. By default it is set to "false". |
true/false |
audioHelp |
Defines the path to an audio file (.mp3) containing the accessibility help. Toggles the visibility of the audio-help button. Requires the parameter accessibility=1. |
audioHelp=path-to-file.mp3 |
autostart |
Automatically starts ondemand video playback after player is loaded. By default it is set to "false". |
true/false |
autostartLive |
Automatically starts live video playback after player is loaded. By default it is set to "true". |
true/false |
embed |
Toggles between the Embed and the Standalone variant. By default it is set to "false". |
true/false |
language |
Selects the language of the labels and descriptions in the player. By default it is set to "en" (English). |
de, fr, it, en |
loopVideo |
For continuous play of the video in a loop, set this parameter to true. By default it is set to "false". |
true/false |
muteVideo |
Allows to mute video on player start. By default it is set to "false". |
true/false |
password |
Fills in the login field "Password" of an authenticated project with the desired password. |
password= |
position |
Desired playback position in seconds. Set this parameter if the playback should start from a specific position of the video timeline. |
position=9 |
quality |
Selects a quality which is available in the quality menu. By default the player displays the best possible quality. By default it is set to "auto". |
quality=240p |
sendEvents |
Allows the iframe integrated player to communicate via the postMessages interface. By default it is set to "false". To be able to send events to the iframe integrated player, additional JavaScript code is required (SimplexController object). |
true/false |
subtitleLanguage |
Selects the language of the subtitles. |
de, fr, it, en, ... |
userName |
Fills out the login field "E-mail or login" of an authenticated project with the desired user name. |
userName= |
view |
Selects a view which is available in the view menu. By default the player displays the view "Large Slide". |
view=sidebyside |
Visual parameters
Parameter | Description | Values |
---|---|---|
hideControls |
Toggles the visibility of the controls (for example Seekbar, Volumebar). By default it is set to "false". |
true/false |
logo |
Changes the logo top left in the Standalone variant. |
logo=https://path/to/the/image.png |
openIndex |
Toggles the visibility of the index panel. |
true/false |
sharing |
Toggles the visibility of the sharing button and its menu. By default it is set to "false". |
true/false |
shareParentPage |
Uses the link of the parent page instead of the direct link to the video for sharing (Twitter, Facebook, E-Mail). Requires the parameter sharing=1. |
true/false |
showTitle |
Toggles the visibility of the title. By default it is set to "false". |
true/false |
themeColor |
Changes the color of the colored controls (for example Seekbar, Volumebar). |
themeColor=FF9900 |
vpdownload |
Toggles the visibility of the download button. By default it is set to "false". |
true/false |
Analytics parameters
Parameter | Description | Values |
---|---|---|
dtmUrl * |
Tracks video events with Adobe DTM. |
dtmUrl=//assets.adobedtm.com/.../satelliteLib-....js |
googleAnalyticsID |
Tracks video events with Google Analytics. |
googleAnalyticsID=UA-XXXXXX-X |
GTMID |
Tracks video events with Google Tag Manager. |
GTMID=GTM-XXXXXXX |
matomoUrl / matomoSiteId |
Tracks video events with Matomo, formerly Piwik. |
matomoUrl=https://accounturl/&matomoSiteId=3 |
tealium * |
Tracks video events with Tealium. |
tealium=account/profile/env |
* Depending on the license model
Further information about analytics tracking with the simplex player: simplex Player - Analytics Tracking
Channel parameters
Parameter | Description | Values |
---|---|---|
cID |
Loads the channel of a customer based on the Customer ID. |
cID=2 |
channelIDs |
Loads one or more channels based on Channel IDs. |
channelIDs=1164,1165 |
channelSortingType |
Selects a sorting type. By default it is set to "createdDate:desc" (Newest). |
channelSortingType=createdDate:desc Newest: createdDate:desc |
firstChannelID |
Selects a channel by Channel ID if multiple channels have been loaded. |
firstChannelID=1165 |
firstProjectID |
Selects a project based on the Project ID. |
firstProjectID=101072 |
videosPerPage |
Desired number of projects. By default it is set to 12. |
videosPerPage=4 |
You weren't able to find whet you were looking for? Contact us now.
Our support team is available
from Monday until Friday
from 9 am until 5 pm.
You will get an answer from us within 24 hours.
In urgent cases (system failure) outside office hours, please call our emergency service: +41 44 580 97 16
Customers who have booked Live Support can use the number assigned to them.
More support articles
simplex Player - Analytics Tracking
05.09.2018
simplex Player - Embed and publish
26.02.2018
simplex Player - Adjusting the default player in simplex Pro
06.11.2017