Developer Documentation

Software developers can integrate the Vidyome HTML5 player into their systems with the specified parameters with developer documentation. If site owners want to use their video advertising products during site registration, they can add them to their sites with Package Purchase. 10K video playing are described as gifts in the first recordings.
You can email info@vidyome.com for more information and technical support.

  • video-id & video-source

    Publishers using the Vidyome CDN service for their videos must use the video-id parameter. Publishers that host their videos at different server addresses should use the video-source parameter. The video-source parameter is used with the full directory path.
    How do I learn Video ID?

  • site-id

    Site specific code given during site registration. you do not need to use with the video-id parameter. is mandatory for publishers using the video-source parameter.
    How do I know the site ID?

  • video-poster

    The parameter used for video poster use. Video images will not appear when not in use.

  • video-embed

    It is necessary for creating video embed code in desktop views.

  • video-url

    Used to send the link address published by the video.

  • video-type

    FB Instant Articles are required for use. The available type parameters are ‘fbia’.

  • video-live

    if the Player is to be used for Live Streaming the parameter should be set to true . The live stream code is used with the video-source parameter. Default is false.

  • video-ads

    Controls the display of ads for video. Used as true / false. Default is true.

  • video-logo

    Used to display the logo on the player. The full directory path of the logo to be displayed must be entered.

  • video-play

    Used to control the video autoplay status. Used as true / false. Default is true.

  • video-volume

    Used for volume control of the video. 0 should be used in silent startup situations. Values between 0 and 1 can be given as dots.

  • video-debug

    The parameter for debug use can be set to true. Restricts the display of advertisements. Default is false.

Creating Embed Code for Facebook Instant Articles

Things to do for Vidyome Player’s use in FB Instant Articles.

Copy the embed code generated for your video FBIA.

Sample Embed Code:

<figure class="op-interactive"><iframe class="no-margin" width="320" height="360">
<div id="vidyome-container"></div>
<script src="https://player.vidyome.com/vidyome/builds/player.js?v=177973153" id="vidyome-player" video-type="fbia" video-id="O1YyreL5hyP"></script>

It works differently in order to support the embed code you add to your web site and the FBIA internal embed code advertising feature. If you have a software team, you can use the following PHP code example to automatically edit the embed code you added on your website for FBIA use.

Sample PHP CODE:

$embedCode = '<iframe src="https://publishers.vidyome.com/video/O1YyreL5hyP/embed" width="100%" height="380" frameborder="0" scrolling="no" webkitallowfullscreen allowfullscreen></iframe>';
$fbiaEmbed = '<iframe class="no-margin" width="320" height="360"><div id="vidyome-container"></div>';
$pattern = '/(?:vidyome.com/(?:[^/]+/.+/|(?:video)/|.*[?&]v=)|vidyome.com/)([^"&?/ ]{11})/i';
preg_match($pattern,$embedCode, $matches);
$fbiaEmbed.='<script src="https://player.vidyome.com/vidyome/builds/player.js" id="vidyome-player" video-type="fbia" video-id="'.$matches[1].'"></script>';
$fbiaEmbed.= '</iframe>';

If you want to manually add the resulting Vidyome embed code to your FBIA content.

Enter the Quick Makaler publishing tools on the FBIA page.
Click the edit icon to add the embed code.
Copy the embed code you copied </header> then paste from the label.
Click the Save button to save your changes.

After saving the related content will be removed from the published. Select the content from the list and click the publish button to publish.

* FB Instant Articles are automatically changed by the system for Vidyome video portal and Vidyome news system owners. Contact us at info@vidyome.com email address or Free Site Setup page for portal installations.

Sample Player Usage