URL Parameters
Overview
There are a lot of options to configure the feature set and behavior during player initialization. The player looks for URL query parameters included in the src of the Player iframe to set these prefences to the whole playback session.
Example
This example shows an iframe in which the player would hide the title bar, the LIVE badge and the viewer numbers from viewers:
<iframe id="PlayerIframe" src="https://video.ibm.com/embed/23935269?hideTitle&hideLiveBadge&hideViewerNumbers" width="640" height="480" allowfullscreen webkitallowfullscreen referrerpolicy="no-referrer-when-downgrade"></iframe>
URL parameters to change the behavior of the Player
The default behavior of the player can be modified by extending the src URL with any of the following parameters:
| Parameter | Effect | Values | Default |
|---|---|---|---|
| allowfullscreen | Enables full-screen. False value makes the full-screen button inactive. | true/false | true |
| api-target-origin | Origin of the page where player api is included. Use encodeURIComponent to URL encode origin. This parameter is only required in case of SSO authentication. | URL encoded origin e.g. output of encodeURIComponent('https://video.ibm.com') | N/A |
| autoplay | Starts video playback automatically. Browser settings are stronger and may override the value of this parameter. | true/false | false |
| controls | When set to false it hides all UI elements. | true/false | true |
| forced-quality | Turns off the automatic quality selection and selects the appropriate quality. Low is the smallest available quality, high is the largest and med is the middlemost choice. | low, med, high | N/A |
| initial-quality | Sets the initial quality for the automatic quality selection. The quality selection logic is still turned on and can switch to another quality after playback is started. | low, med, high | N/A |
| showtitle | Shows title and viewer count information inside the player area. | true/false | true |
| showtheatre | Shows the Theater button in an embedded player. Only works with the video.ibm.com sidebar, used internally. | true/false | false |
| showpopout | Shows the Popout button in the control bar. Viewers can view the player in a browser popout window. | true/false | false |
| volume | Set volume for playback as a percentage of the max volume. Overrides the default volume (100). | 0-100 | 100 |
| slideShowSpeed | Set the duration (in seconds) an off-air image is shown if an off-air image slideshow is set for a channel. | 1,2,3,… | 5 |
| loop | Playback of current video will continue from the beginning after it’s ended, automatically. | nothing | N/A |
Hide individual UI elements with URL parameters
Many UI elements on the player can be hidden from viewers by using URL parameters. These parameters do not need values to work.
| Parameter | Effect |
|---|---|
| hideAudioSwitch | Hides the audio selector icon of multi-language videos |
| hidePlayScreen | Hides the play screen after initial player load (does not cause autoplay) |
| hideCaptionSearch | Hides the magnifying glass icon for Speach Search in Videos with CC |
| hideChapters | Hides the Chapter Selector panel icon and the Chapter Markings from the seekbar |
| hideCustomLogo | Hides the uploaded Custom Branding Logo from the player |
| hideCTA | Disables CTA overlays. Rely on the liveCtaUpdate event to trigger your own CTA. |
| hideLogo | Hides the IBM logo from the player |
| hideShare | Hides the Share icon from the player |
| hideFacebook | Hides the Facebook option from the Share menu |
| hideTwitter | Hides the Twitter option from the Share menu |
| hideCopyLink | Hides the “Copy Link” option from the Share menu |
| hideEmbedCode | Hides the “Embed Code” option from the Share menu |
| hideCC | Hides the CC selector icon from the player controls (does not affect displaying CC set to appear by default) |
| hideTitle | Hides the broadcast/channel title from the top of the player |
| hideViewerNumbers | Hides the display of the current and total viewership from the top of the player |
| hideLiveBadge | Hides the “LIVE” badge from the player |
| hideReplayBadge | Hides the “REPLAY” badge from the player |
| hideFullscreen | Hides the full-screen icon from the controls |
| hidePlaybackSpeed | Hides the playback speed icon from the controls |
| hideSeekbar | Hides the seekbar from video controls, viewers can not seek in videos but can pause/play and control other features |