Metadata in url

Metadata in URL using parameters

Metadata in URL using parameters

There are ways to give extra information to the interactive video from external information sources. One of these ways is to add some code (parameters) behind the project link to add meta-data. This way you can add personalization and variables, but also start times and other extras.


How to add

1. First you need the embed codes. These codes are only visible for published projects, so only published projects can have these extra parameters added.
2. After the link, you add a question mark (?). These means that the browsers know that everything behind this is not part of the link, but comes in as meta-data.
3. If you then want to add the code, add an ampersand (&) and then the code. If you have multiple pieces of code, just add an ampersand (&) in between the extra bits of code


Example
Direct link: https://projects.ivorystudio.net/embed/projects/ffb2d50a37800e188741a07c
Now with extra code (variable (var=10) and start time (iv_start=120000 milliseconds): https://projects.ivorystudio.net/embed/projects/ffb2d50a37800e188741a07c?&var=10&iv_start=120000

This now means that when the player starts, there is immediatly one variable called 'var' with a value of 10 in it. Besides that the video doesn't start at the beginning, but immediatly jumps to 120000 milliseconds, which is timecode 02:00:00.

Parameters

Here are the possible pieces of code you can put behind the url for extra functionality.

 var=10
This can be any variable and any value. The moment the video starts, this variable is now already in the video. For example, this can help with personalisation.
iv_start=120000
This is to have a timecode where the video automatically jumps to. Be aware that this is in milliseconds. In this example when the play buttons has been pressed, the interactive video starts at 2 minutes in the video (02:00:00).
forced_resolution=720
When you want to do a quality check, or you know the video is mainly played at places with a bad internet reception, you can always try this parameter.
iv_dnt=1
This is to hide your viewing from the statistics. This is to make sure you have clean statistics (and all your tests are not added up).
You can also use this function to create a 'cookeless embed' if there are problems on the website where the viewer first needs to allow the cookies.
iv_player_overlay_opacity=0
This parameter is usefull when you have other web elements (for example iFrames or external chat engines) in your video. Because it is going to another iframe, it should actually pause, but with this parameter in the url it just keeps on playing while the viewer is inside the other iframe.
iv_noblur=1
Normally when you click away from the player, the video stops. When this parameter is added it continues playing even if the viewer is in another tab
A second reason to use this is when you are using embedded iframes within your project. It means the player keeps on playing even when the viewer clicked on functionality within the iframe.
iv_force_subtitle=fr
If you have a video with multiple subtitles, you can put this parameter behind it to make sure it starts in the language you want, in this example in French. Of course, if you added a subtitle selector or Player Control Bar the viewer can always switch to another language or turn the subtitles off. 
More information about how to add subtitles and the country codes here: https://support.ivorystudio.net/portal/en/kb/articles/adding-subtitles
iv_player_playbutton_color=33AA33
On top of the thumbnail there is normally a white play button. Which this parameter you can change its color by changing the hexadecimal value. By adding two more number (00 till 99) you can even adjust the opacity of it, with 00 behind completely hidden.
iv_thumbnail=
Use an external online image as your thumbnail. This way one and the same project can have multiple thumbnails.
iv_load_db_translations=1
This parameters tell the player that a database is attached to the video where the player can find the data for all the variables. This is usefull for personalisation or translations.




    • Related Articles

    • Using Email Gate

      The Email Gate component allows you to collect email addresses from viewers. Viewers can submit their emailadres by way of a simple form. The contact details will be sent to a mailbox of your choice. This direct method of lead generation adds to an ...
    • Animate using keyframes

      Keyframes are the set-up positions of elements on their specific moments on the timeline. By using more than one keyframe, it is possible to linearly animate elements. Working with keyframes allows you to have elements move over the screen on the ...
    • Using Input Field

      The Input Field component allows you to create and edit variables. Variables are elements that can assume a certain value. A variable consists of a key and a value. The key is the ‘label’ of the variable, and is used to identify the variable. The ...
    • Using Contact Form

      The Contact Form component is a user-friendly and flexibly deployable contact form. With this ‘form builder’, you can create form for different purposes. You can for example have your target audience make contact, but you can also use this feature to ...
    • Personalize using postMessage

      PostMessage is a safe method to communicate between different domains, for example between a website and an embedded Ivory player (iFrame). This allows you to personalize video’s realtime. The data is sent directly from a webpage to the iFrame, ...