Kaltura-Interactive-Video Wordpress Plugin Specifications

From Kaltura Wiki

Jump to: navigation, search
Kaltura’s Interactive Video Plugin for WordPress
Release Status: Current Version - 0.9.5

Contents

[edit] Introduction

[edit] General

The Interactive Video plugin for Wordpress allows wordpress blog owners to add an integrated video solution to their blog. The Interactive video plugin includes two types of features:

  • A Video player embedded in a post (can add more than one per post) that allows blog viewers to add content to video (videos, images, audio) and remix the video with an online video editor.
  • Video comments allowing viewers to add their comments as video.

Both options allow viewers to upload content from their computer, record from webcam or import from other sites: (e.g., Kaltura, YouTube, MySpace, Flickr). Viewers can only remix videos that have been embedded in the post by author.
Blog owners can select:

  • who is allowed to add and edit videos embedded in post (Blog Administrators, Blog editors/contributors & authors, subscribers or everybody).
  • to disable video comments.
  • to enable anonymous comments.

Each owner can stream up to 3GB per month for free.

[edit] Terminology

  • Interactive Video Plugin: All files necessary for configuration and display of embedded video player and video comments.
  • Interactive Video Player: Video player allowing users (as defined by owner) to upload and remix content.
  • Video Comments: A video player that allows users to upload or record their comments and display them in a video player that does not offer viewer interaction.
  • Insert in to post:Allows admins to grab existing interactive videos and embed them in to post.
  • Add video comments:Opens uploader with webcam option as default.
  • Add Interactive Video: Creates a player that is embedded in post.
  • Browse interactive videos: Lists all previously created content, both interactive videos and comments and allows admins to insert into posts, delete item, edit video, edit title and description.

[edit] Technical Requirements

[edit] Wordpress version

2.5-2.6

[edit] Compatible Browsers

At development time it was tested using Firefox 2, IE7 & IE6

[edit] User types and permissions

Blog owners can define who can add content, edit interactive video based on wordpress user roles and add comments under settings> Interactive Video:

Adding Content Blog Administrators, Blog editors/contributors & authors, subscribers or everybody
Adding Comments Viewers, anonymous viewers

Users who do not have permission to add or edit content in embedded players will not see the “Upload” and/or “Remix” buttons. Comments:

WP Anon Comments Kaltura Anon comments Button state
No Doesn’t matter Comments form is not visible
Yes No
Yes Yes Visible


[edit] Interactive Video Components

[edit] Player

Figure 1: Small Interactive Video Player
Figure 1: Small Interactive Video Player
Figure 2: Comment Player
Figure 2: Comment Player

[edit] Sizes

The video player when embedded in post can be displayed in two sizes:

  • Large (400x426)
  • Small (268x308)

Admins can change player size by going to: Browse Interactive Video > Insert into post
Comment videos are displayed only in small players.

[edit] Player features

Embedded player includes:

  • Play/Pause button.
  • Scrubber with current time indicator.
  • Volume control.
  • Fullscreen.
  • Upload/Remix buttons – depending on user permissions (see User Types).
  • End of play options: Replay, Share.
  • Link to kaltura site.
  • Before play: placeholder thumbnail.

Comment player includes:

  • Play/Pause button.
  • Play button on top of video area.
  • Scrubber with current time indicator.
  • Volume control.
  • Fullscreen.
  • End of play options: Replay, Share.
  • Link to kaltura site.
  • Before play: placeholder thumbnail.




[edit] Uploader

Figure 3: Uploader / Contribution Wizard
Figure 3: Uploader / Contribution Wizard

The uploader allows users to upload, import and record videos and upload & import audio and photos.
The Uploader opens in two cases:

  • From player, when users click the "Upload" button.
  • From WP post editor, when users click the "Add Interactive Video".

A custom UI for wordpress of Kaltura’s contributor wizard has been designed. Changes in UI: media types appear on top as tabs.

[edit] Sources

  • Video:
    • Upload.
    • Webcam.
    • Kaltura (includes private search).
    • YouTube (includes private search).
    • MySpace (includes private search).
  • Audio:
    • Upload.
    • Kaltura (includes private search).
    • Jamendo.
    • CCMixter.
  • Photos:
    • Upload.
    • Kaltura (includes private search).
    • Flickr (includes private search).
    • NYPL.
    • Any webpage.
Default length of photos: 4 seconds.

[edit] Remixer

The remixer is the default Kaltura editor.

  • "Remix" button on the Interactive Video player
  • "Edit this Video" button in the Browse Interactive Video > Edit > Edit Video.
  • Clip Library contains only entries that have been added to the particular interactive video.
Figure 4: Remixer / Video editor
Figure 4: Remixer / Video editor























[edit] Management of Interactive Videos

[edit] Browse

From the wp admin panel, authors can browse a list of previously created interactive videos and comments. Browse is evoked from:

  • "Add Interactive Video" icon on top of post editor.
  • From the "Manage" tab > "Interactive Video".

The list appears in reverse chronology.
Clicking on the video or comment thumbnail invokes the edit mode. The list also allows users to edit and insert into post.

[edit] Edit

The edit mode includes:

  • Placeholder image of player. When clicked, invokes small player in place.
  • Edit Title (text field); See Adding an Interactive Video to post and Adding a Video Comment.
  • Edit Description (text field).
  • Delete (button).
  • Edit Video (button).
  • Update (button).

[edit] Insert into post

Allows users to insert previously created interactive videos and comments to post.

[edit] Delete

Deletes interactive video content. It does not delete the players that are already embedded; they will show a black screen.

[edit] Edit Video

Opens remixer in place of popup. The "close" button in the remixer reverts to previous state of window.

[edit] Installation

[edit] Installation of plugin

User downloads from Download Center and extracts the plugin zip file to their local machine then pastes the 'interactive_video' directory under the '/wp-content/plugins/' directory.
Users can then activate the plugin through the 'Plugins' page in the wp admin.
They then go to Settings > Interactive Video to setup the Interactive Video plugin. See Settings and Obtaining Partner ID.
Users who are upgrading the plugin need to deactivate the plugin in the wp admin and paste the latest version's folder in the plugins directory on their local computer.

[edit] Obtaining Partner ID

Once the user has activated the plugin, they are requested to get a Kaltura Partner ID from:

  • Add Interactive video flow.
  • Wp-admin settings page.

Required fields:

  • Partner name.
  • Admin name.
  • Email.
  • Description.
  • Agree to terms.

[edit] Adding an Interactive Video to post

Adding an Interactive Video to post is done only via the icon in the "Add Media" icon row from the "write-post" page in the wp-admin interface:

Figure 5: Add Interactive Video Icon
Figure 5: Add Interactive Video Icon

Only users who have access to the wp-admin panel can add a new Interactive Video. Posts can have more than one players.
When a user selects to add an Interactive video, the wp add media window opens with 2 tabs:

  • Add Interactive Video (selected).
  • Browse Interactive Videos.

The user follows the normal flow for adding content via the Uploader (aka Contributor Wizard). This creates a new video.
When the users clicks finish, they are redirected to "Browse > edit" to add description,
When user clicks "Update", they are requested to select player size and click "Insert into post".
This closes the window and a placeholder image appears in the post editor in visual mode. In HTML mode, the player will appear with the following markup:

[kaltura-widget wid="[ ] " size="large/Small alignright/ aligncenter/ alignleft" align="l " /]







[edit] Settings

[edit] If user has Partner ID

Under the settings section of the wp admin, there appears a link: "Interactive Video" containing:

Figure 6: Settings with Default settings checked.
Figure 6: Settings with Default settings checked.

[edit] Info

  • Some explanatory text (needs revision)
  • Partner ID: [num]
  • CMS username:[email]
  • CMS Password: [password]
  • Link to CMS (already logged in)



[edit] Permissions

Blog owners can define the following. (See Figure 6)





[edit] If user does not have Partner ID

Users who do not have a Partner ID will be directed to the Partner ID form.
Upon submission they will be redirected to the Settings page as described in the section above.

[edit] Interacting with an Interactive Video embedded in post

[edit] Viewing

All blog viewers can see Interactive Videos.
Playing the video is done by: Clicking on the video area or the play button.
All players include volume control and fullscreen mode.

Figure 7: Share Window (wire frame draft)
Figure 7: Share Window (wire frame draft)

[edit] Uploading

Viewers can upload videos, photos or audio, depending on the permissions set by the admin.
Clicking on the "Upload" button opens the uploader, with the "Video" tab selected.

[edit] Remixing

Viewers can remix videos, depending on the permissions set by the admin.
Clicking on the "Remix" button opens the Remixer.

[edit] Sharing

A share button appears at end of play of Interactive Videos and comments.
Clicking on share button opens the "Share" window shown on Figure 7.

[edit] Adding a Video Comment

Admins can enable video comments via the "Settings > Interactive Video" page in the wp-admin panel.
Users are allowed to add a video comment, depending on permissions.
If the admin allowed video comments in the wp-admin "Settings" page and the user has permission to add a video comment, the comment form will display "Add Video Comment".
Clicking on "Add Video comment" opens the uploader with Videos > Webcam selected.
Video comments follow the same behavior as regular wp comments (moderation, deletion, edit etc.).
Comments can be edited by admin from the Browse list.

Personal tools