Simple Editor

From Kaltura Wiki

Jump to: navigation, search

Contents

[edit] Simple Editor (SE)

The Kaltura Simple Editor (aka SE) is a customizable flash video editor enabling end users to mash up videos and images, add audio tracks and enrich their video mix with transitions.

The SE can be configured using an XML configuration file.
The SE configuration file defines different customization aspects:

  1. Graphical skinning and locale of the different parts of the SE.
  2. Configuration id for the Contributor Wizard (CW) used to add more media.

[edit] Customizing the SE

The configuration file for the SE is an xml file with the following format: 

<SimpleEditor>
 
	<ContributionWizard>
		<UIConfigId>2</UIConfigId>
	</ContributionWizard>
 
	<Welcome>/swf/simpleeditwelcome.swf</Welcome>
 
	<DefaultTransition>None</DefaultTransition>
 
	<UIConfigList>	
    	<UIConfig>
			<target>simpleeditor.swf</target>
		    <cssUrl>/content/uiconf/remixamerica/styles_SimpleEditor_remix_america.swf</cssUrl>
		    <localeUrl>/content/uiconf/remixamerica/en_US_SimpleEditor_remix_america.swf</localeUrl>
		</UIConfig>
	</UIConfigList>
 
</SimpleEditor>

[edit] ContributorWizard

The ContributorWizard section defines parameters related to the Contribtuor Wizard which open from within the Simple Editor.

The UiConfigId node defines the configuration id the CW will use.

[edit] Miscellaneous Settings

The Welcome node sets the url (either full or relative) for the welcome swf which appears when the SE opens.

The DefaultTransition node defines the default selected transition. This transition will be added after each entry. A list of available transitions can be found at [TBD].

[edit] UIConfigList

The UIConfigList section described the skinning and locale used for the editor components. Each component may define its own UIConfig node. Currently the only defined component is the Simple Editor itself. 

<UIConfig>
    <target>simpleeditor.swf</target>
    <cssUrl />
    <localeUrl />
  </UIConfig>

The target defines the flex module the skinning and locale info relates to.
Instead of providing specific skinning for every component, one css swf file may be given to the whole SE. 

<UIConfig>
    	<target>simpleeditor.swf</target>
 
<cssUrl>
/content/uiconf/remixamerica/styles_SimpleEditor_remix_america.swf 
</cssUrl>
 
    	<localeUrl>
/content/uiconf/remixamerica/en_US_SimpleEditor_remix_america.swf
</localeUrl>
</UIConfig>

The cssUrl points to a URL (either relative or full path) containing a compiled css swf file. The localeUrl points to a URL containing a compiled properties file describing translated text strings.

[edit] Notifications

The SE calls javascript functions on the page in several events.
The name of the functions is passed using flashvars (e.g. flashvars contains ”saveF=onSave” ).

[edit] saveF

The function is called after the SE completed saving the roughcut.

[edit] backF

The function is called after the user clicked on the SE back button

[edit] loadedF

The function is called when the SE completed loading and awaiting user input.

[edit] Embedding the SE

The SE is embedded like any regular flash object; however several flashvars should be defined:

Attribute Type Explanation
Host String (optional) – An enumeration used to point the CW to the Kaltura sandbox server.
partner_id Integer The partner id
subp_id Integer The sub partner id
uid String The current user id
ks String The Kaltura Session passed to the SE in order to call the Kaltura servers
kshow_id String The edited kshow.
entry_id String The edited roughcut entry (may be set to -1 in order to use the kshow default roughcut).
Retrieved from "http://corp.kaltura.com/wiki/index.php/Simple_Editor"
Personal tools