What are query strings?
Query strings are a way to pass information back to Vidyard's web servers about how an embedded player should look, feel, and behave on a case-by-case basis.
Do you have a single player embedded in two locations? You might use a query string on one of the players to change its size and color. Maybe you have a player with multiple videos? Use a query string to make the player begin at the second video in the list.
In essence, query strings offer you ad hoc control and customization over how your videos are experienced by viewers.
Add query strings to a sharing page URL
You can add one or more query strings to the end of a player sharing page link. Simply specific the parameter and then a value after the
?. Any subsequent strings should be added using the
The following example includes uses
quality=1080p. These will force the player to autoplay in 1080p resolution.
Add query strings to an embed code
Query strings are added to an embed code as a list of parameters and values. Simply add
data-[theparameter]=[thevalue] inside the image <img> tag of the embed code.
The example below sets the height and width of the player to 640 by 360 pixels.
<img style="width: 100%; margin: auto; display: block;" class="vidyard-player-embed" src="https://play.vidyard.com/U9TXHnmU2QDq9f5aKppsXx.jpg" data-uuid="xXSPPkA5F9Qdqu2" data-v="4" data-type="inline" data-height="640" data-width="360" />
Query parameters and values
|width||Integer (in pixels)||Overrides the width of the player.|
|height||Integer (in pixels)||Overrides the height of the player.|
|name_overlay||0 or 1||Overlays the name of the player on the player during playback.|
|disable_ctas||0 or 1||A value of 1 prevents Events from loading when the player loads.|
|hide_playlist||1||A value of 1 removes the playlist icon on the player. The playlist still exists, but can not be accessed.|
|hidden_controls||0 or 1||A value of 1 hides the player controls from viewers. Player controls include the time slider, play/pause button, quality settings, volume slider, and expand option.|
|hide_html5_playlist||0 or 1||A value of 1 prevents the playlist from appearing on the HTML5 fallback player.|
|viral_sharing||0 or 1||A value of 0 removes the social networks sharing button from the player.|
|embed_button||0 or 1||A value of 0 removes the embed button from the player.|
|color||6-digit color hex code||Changes the color that appears when interacting with playback controls (play, pause, closed caption, fullscreen, sound settings), as well as the time/seek bar|
|playlist_color||6-digit color hex code||Changes the background color of the playlist when open|
|play_button_color||6-digit color hex code||Changes the color of the play button|
|playlist_always_open||0 or 1||A value of 1 will force the playlist to always display.|
|playlist_start_open||0 or 1||A value of 1 will set the playlist to display when the player starts.|
|disable_redirect||0 or 1||A value of 1 will force any redirects to not function.|
|disable_preroll_flash||0 or 1||A value of 1 will force the preroll not to display on flash players|
|no_html5_fullscreen||0 or 1||A value of 1 disables full screen when using the HTML5 player|
|custom_id||String||This sets a fixed custom_id for personalization campaigns|
|muted||0 or 1||A value of 1 will mute the Player|
|autoplay||0, 1 or 2||A value of "1" enables the video to play automatically after the page has loaded (although the browser may prevent autoplay with audio). A value of "2" enables the video to autoplay if the browser will allow audio; otherwise autoplay is prevented and the thumbnail displays instead.|
|chapter||Integer||Used for multi-chapter players. The player will begin at the chapter number specified beginning at 1.|
|video_id||Integer||Similar to the chapter parameter. Accepts the Vidyard video ID. The player will search for the video with a matching ID and begin playback at that chapter.|
|second||Integer||The player will begin playing at the second set|
|flash_first||0 or 1||A value of 1 forces the flash player to be loaded.|
|redirect_url||String||Redirects a viewer to a URL inside the player when the player completes.|
|loop||0 or 1||Replays current player chapter upon completion. Analytics are only collected for the first time the chapter plays through.|
|redirect_whole_page||String||Redirects the viewer's whole browser window to a specified URL.|
|cc||String||Automatically start the player with the closed captioning of the requested language using ISO 639-1 codes (e.g. en=English, fr=French, etc. More details.)|
|quality||360p, 480p, 720p, 1080p||Force the viewer to stream at the given resolution. The viewer will still have the ability to change to a higher or lower resolution using the player controls. The player will also still use intelligent resolution selection to automatically lower the resolution in the case of extended buffering.|
|force_https||0 or 1||Forces the player to be played through secure-http|
|force_http||0 or 1||Forces the player to be played through non secure-http|
|first_frame||0 or 1||
This plays and then instantly pauses the player so that it sits on the first frame of the video without a splash screen.
Sets the speed of playback. Only
Tracks are referred to in the order that they appear on the player control menu (for example 0 = default English; 1 = the next track).
|new_visitor||0 or 1||Forces a new Vidyard cookie to be generated each time a player is loaded.|
|disable_analytics||1||Disable analytics prevents the player from collecting data about viewers|
|referring_url||String||Sets a fixed refferal URL for every view|
|vyemail||String||When an email address is provided as a string, the email address is associated with the Vidyard cookie/localstorage allowing the address to be reported on in Vidyard analytics.|
|pardot_id||String||Sets a fixed Pardot ID for every view|
|hubspot_id||String||Sets a fixed Hubspot ID for every view|
|vysfid||String||Sets a fixed Vidyard Salesforce ID for every view|
|eloqua_contact_id||String||Sets a fixed Eloqua Contact ID for every view|
|eloqua_id||String||Sets a fixed Eloqua ID for every view|
|marketo_id||String||Sets a fixed Marketo ID for every view|