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
The following example includes uses
quality=1080p. These will force the player to autoplay in 1080p resolution.
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.
<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
|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.|
|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||
|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|
|0 or 1||
Redirects the viewer to another page when playback ends. Use in combination with
Used in combination with
URL must include
|loop||0 or 1||Replays current player chapter upon completion. Analytics are only collected for the first time the chapter 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.
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 referral 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|