Player SDK

Description

The Player SDK is a JavaScript module that allows developers to interact with movingimage embedded videos, allowing for further customization and automation of the player.

Usage

To use the Player SDK in your application, follow these steps:

1. Add the iframe embed from VMPro to your HTML page. Example:

   <iframe
     style="border: none; width: 100%; aspect-ratio: 16/9;"
     src="//e.video-cdn.net/watch?video-id=123&player-id=123&channel-id=123"
     allowfullscreen
     allow="autoplay; clipboard-write; encrypted-media; picture-in-picture; web-share;"
     frameborder="0"
   ></iframe>
   Copy

2. Import the SDK and initialize the Player:

   <script type="module">
     import { Player } from 'https://e.video-cdn.net/mi-player-sdk/mi-player-sdk.js';
   
     const player = new Player('mi-embedded-video');
   
     // Now you can use the player object to interact with the embedded video player
   </script>
   Copy

3. Now you can use the player object to interact with the embedded video player. For example:

   // Add event handler to know when video is playing
   player.on('play', () => {
     console.log('Video play requested!');
   });
   
   // Play the video
   player.play().then(() => {
     console.log('Video is now playing!');
   });
   Copy

Alternatively, you can also interact with all players at once, using Player.allPlayers(). Here's an example on how to enable full analytics for all players in your page:

const players = Player.allPlayers();

for (const player of players) {
  const videoId = player.getVideoId();

  player
    .setAnalytics('full')
    .then(() => {
      console.log('Full analytics enabled for video ' + videoId);
    })
    .catch((error) => {
      console.error('Error setting full analytics for video ' + videoId, error);
    });
}
Copy