KaltuaraAPI:Contribution Wizard

From Devwiki

Part of the KalturaAPI

The Contribution Wizard is a flash object that helps add objects to a Collaborative Video.
When placed in an html page the code looks like the following:

<object
 width="680" 
 height="360" 
 data="http://www.kaltura.com/swf/ContributionWizard.swf" 
 allownetworking="all" 
 allowscriptaccess="always" 
 type="application/x-shockwave-flash" 
 id="kaltura_contribution_wizard">
  <param value="always" name="allowScriptAccess"/>
  <param value="all" name="allowNetworking"/>
  <param value="#000000" name="bgcolor"/>
  <param value="http://www.kaltura.com/swf/ContributionWizard.swf" name="movie"/>
  <param name="flashVars" value="
          userId= x
          &sessionId= ks 
          &partnerId= 1
          &subPartnerId= 100
          &kshow_id=123457 
          &afterAddentry=addentry 
          &close=finished 
          &lang=en 
  "/>
</object>

flashVars

The flashVars param is a long string formed as an http query-string (name1=val1&name2=val2...).
It has no spaces and no line breaks (these where only placed in the example for clarity).
Bellow is a short explanation about each param:

userId

the partner's id for the current user

sessionId = ks

a valid kaltura-session returned by the startsession service

partnerId

partner_id

subPartnerId

subp_id

kshow_id=12457 

the id of the Collaborative Video to which the contribution is done

afterAddentry = addentry 

a name of javascript function that will be called once the entry is added.
Not having this function (in the example 'addentry'), will cause a javascript error after the flash object calls the addentry service.

close = finished

a name of javascript function that will be called when the Contribution Wizard is closed
Not having this function (in the example 'finished '), will cause a javascript error when the flash object closes.

lang = en

language in which the text should be displayed

isAnonymous ["true" | "false"]

Determines whether the user is logged in or anonymous.

An anonymous user will be able to supply:

1. A screen name
2. Source url - a reference to where the media was taken from.

Both are optional fields.