Use query parameters and data attributes to override player settings – Vidyard Support

What are query parameters and data attributes?

Query parameters and data attributes 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. They can also be used to send information to Vidyard about the viewer, such as their email address.

Do you have a single player embedded in two locations? You might use a data attribute on one of the players to change its size and color. Maybe you have a playlist with multiple videos? Use a query parameter to make the player begin at the second video in the list.

In essence, data attributes and query parameters offer you ad hoc control and customization over how your videos are experienced by viewers.

Add query parameters to a sharing page URL

You can add one or more query parameters to the end of a player sharing page link. Simply specify the parameter and then a value after the ?. Any subsequent parameters/strings should be added using the & character.

The following example includes uses autoplay=1 and quality=1080p. These will force the player to autoplay in 1080p resolution.

http://share.vidyard.com/watch/xbvjhshhshhs?autoplay=1&quality=1080p

Add data attributes to an embed code

Data attributes 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 player to mute the video and show a default french caption.

  <script type="text/javascript" async src="https://play.vidyard.com/embed/v4.js"></script>
  
  <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-muted="1"
  data-cc="fr"
  />

Parameters and values

Player Customization

Parameter	Accepted values	Notes
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
preload	`none` `metadata` `auto`	`none` indicates that video files should not begin to download prior to playback. `metadata` indicates that a small amount of information is downloaded that prepares the video for playback (e.g. video length). `auto` indicates that the video file can begin to download prior to playback.
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.
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

Playback experience

Parameter	Accepted values	Notes
autoplay	0, 1 or 2	0 = disable autoplay 1 = enable autoplay (browsers may block or mute videos with autoplay) 2= autoplay only if the browser will allow autoplay with sound; otherwise, prevent autoplay and display the video thumbnail instead
video (formerly chapter)	Integer	Used for multi-video playlists. The playlist will start playback at the number specified (1 = first video, 2 = second video)
video_id	Integer	Similar to the video parameter. Accepts the Vidyard video ID. The player will search for the video with a matching ID and begin playback at that video.
second	Integer or decimal	Start to play the video at the specified second (e.g. `second=35` or `second=2.3`)
redirect_whole_page	0 or 1	Redirects the viewer to another page when playback ends. Use in combination with `redirect_url` to specify the URL. 0 = redirects to URL inside of the player frame 1 = redirects entire page to a specified URL.
redirect_url	String	Used in combination with `redirect_whole_page` to specify where the viewer is redirected after playback ends. Example: `?redirect_whole_page=1&redirect_url=https://hello.com` URL must include `http(s)://`
loop	0 or 1	Replays current player video upon completion. Analytics are only collected for the first time the video plays through.
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.
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.
speed	Integer or decimal	Sets the speed of playback. Only `2`, `1.5`, `1.25`, `1`, & `0.5` are accepted values.
audio_track	Integer	Tracks are referred to in the order that they appear on the player control menu (for example 0 = default English; 1 = the next track).

Player Analytics

Parameter	Accepted values	Notes
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
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 in Vidyard analytics.
vyetoken	String	When an etoken is provided as a string, the email address is associated with the Vidyard cookie/localstorage allowing the address to be reported in Vidyard analytics. Tokens can be generated using Vidyard's Dashboard API. Using the Vidyardwith some email apps (for example, Gmail, Outlook, etc) adds the token automatically.
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