Topics:

CMS Integration Guidelines

Document Keys

Document keys, or keys, are unique identifiers that reference individual video packages, playlists or other assets generated by the Manager Application. Each key is comprised of 40 characters. It is not a reference to the URL where the video is hosted, but rather a package of data that contains the source video, other transcoded versions of the source video and meta data describing the video properties.

Example key:

b41ddf4096cb8e628227eac565d6bbd28966dfa9


A method for integrating video into a CMS is to add a key field to your most commonly used content types (Story, Blog, etc.). Content producers can then paste a key into that field when publishing a story.

You will need to add code to verify if the field is populated and is 40 characters long. It is a good practice to add code to your key check that removes any white space. Once verified, you can have the video player display or maybe just the thumbnail image.

Key checking example:

## Set a variable $key
## Trim any white space from the key field
#set($key = $string.trim($story.key))

# If $key is not empty and is 40 characters long, do something

#if($key != "" && $key.length() == 40)

## SOMETHING

#end

Embed Codes

Embed codes are quick and easy ways to view your video or playlist on your website. An embed code is a simple JavaScript tag that can be pasted into a body of a story or blog.

For more advanced implementations, you may want to have your CMS automate the way an embed code is constructed. By doing this, you can allow more control of how your video content is displayed (or not displayed). This is especially valuable when you are re-using your content in RSS or other types of feeds that may not display properly with JavaScript embed codes.

Video Embed Code

The video embed code follows a simple URL pattern and uses the following elements:

  • Player Source URL -  http://player.bimvid.com/v2/vp/
  • User Identification - This will be the identification given to your publishing account and will be the same for all videos and playlists. This should match your BIMvid account name. This data can come from a root-level field that can be manually entered. For broadcast clients, it is usually your call letters. It is not case-sensitive.
  • Key - This is unique for each video.

Example:

<script src='http://player.bimvid.com/v2/vp/YOUR_IDENTIFICATION/YOUR_KEY'></script>


When combined with a key check, the embed code can be scripted to automatically be generated on a page.

Example:

## Set a variable $key

#set($key = $string.trim($story.key))

## Set a variable $ident.

#set($ident = $host.identification)

#if($key != "" && $key.length() == 40)

<script src='http://player.bimvid.com/v2/vp/${ident}/${key}'></script>

#end

Playlists

To embed a playlist on your website is similar to how individual videos are embedded. Both “smart” and “manual” playlist types follow a simple URL pattern and uses the following elements:

  • Player Source URL -  http://player.bimvid.com/v2/playlist/
  • User Identification - This will be the identification given to your publishing account and will be the same for all videos and playlists. This should match your BIMvid account name. This data can come from a root-level field that can be manually entered. For broadcast clients, it is usually your call letters. It is not case-sensitive.
  • Key - This is unique for each playlist. Video keys do not work with playlist keys, so you should make sure you are able to differentiate them in some naming convention in your system.

When combined with a key check, the playlist embed code can be scripted to automatically be generated on a page.

Example:

## Set a variable $key

#set($playlistKey = $string.trim($story.playlistKey))

#set($ident = $host.identification)

<script src='http://player.bimvid.com/v2/playlist/${ident}/${playlistKey}'></script>

MRSS

MRSS is short for Media RSS, an extension of the RSS format used for syndicating multimedia files (audio, video, image) in RSS feeds. When you create a playlist in the BIMvid Manager Application, a MRSS feed is automatically created. It follows a simple URL pattern pattern and uses the following elements:

  • Player Source URL -  http://player.bimvid.com/v2/feed
  • User Identification - This will be the identification given to your publishing account and will be the same for all videos and playlists. This should match your BIMvid account name. This data can come from a root-level field that can be manually entered. For broadcast clients, it is usually your call letters. It is not case-sensitive.
  • Key - This is unique for each playlist.



BIMvid MRSS feeds support RSS version 2.0. Full specifications can be found here: http://video.search.yahoo.com/mrss. MRSS video feeds are a good way for you to syndicate your video to other providers if needed.

Example:

## Set a variable $key

#set($playlistKey = $string.trim($story.playlistKey))

## Set a variable $ident.

#set($ident = $host.identification)

http://player.bimvid.com/v2/feed/${ident}/${playlistKey}