Documentation

FlashVars

From KickApps Documentation

Jump to: navigation, search

You can add any of the following flashVars to the flashVars in a widget's embed code to change its properties at runtime.

  • If you're adding one of these flashVars to the compatible version of widget embed code, you'll need to update the flashVars in the <object> tag. Make sure to prepend &amp; (all spelled out) to each flashVar, like this: 
&amp;clickJSCallback=widgetClicked

var flashvars = {affiliateSiteId:"12345", widgetId:"123456", width:"628", height:"464", revision:"1", clickTAG:escape("http://google.com?bob=4&"), clickTAG302:1}

Contents

Reserved flashVars

showShareMenu

showShareMenu=1

Show the share menu when the widget loads.

mediaURL

mediaURL=http%3A//yourmediaurl.com

Replaces all mediaURLs in the widget with this URL. The URL must be escaped. An easy way to escape URLs is to paste them into Firefox's address bar like this: 

javascript:escape('http://www.yourURL.com/otherStuff...')

Please note: we recommend against using this flashVar in the way depicted above when your widget contains a video player running advertising and a list component attached to that player. Doing so can cause your ad to play twice. Instead please target either the video player or the list, as in the example below, where "Auto List" is the name of component (the name can include a space like this): 

mediaURL=Auto List_http%3A//yourmediaurl.com

Please note: if you pass more than one mediaURL flashVar to the same widget, only one of them will be evaluated. If you need to pass mediaURLs to multiple components in a widget, you can do so by passing multiple values to the mediaURL param, separated by commas: 

mediaURL=Auto List1_http%3A//yourmediaurl1.com,Auto List2_http%3A//yourmediaurl2.com

mediaType_mediaId

mediaType_mediaId=video_2422

Replaces 'all' mediaURLs in the widget with a KIT Cloud Social RSS feed containing the media item specified by the mediaType and mediaId arguments. Please note: we recommend against using this flashVar in the way depicted above when your widget contains a video player running advertising and a list component attached to that player. Doing so can cause your ad to play twice. Instead please target either the video player or the list, as in the example below, where "Component Name" (can include a space like that) is the name of your video or list component: 

mediaType_mediaId=Component Name_video_2422

Please note: if you pass more than one mediaType_mediaId flashVar to the same widget, only one of them will be evaluated. If you need to set the mediaURL for multiple components in a widget, you can do so by passing multiple values to the mediaType_mediaId param, separated by commas: 

mediaType_mediaId=Component1_video_2422,Component2_video_4444

mediaParameters

mediaParameters= bob=1&tom=2

Append the query string specified (e.g., bob=1&tom=2) to all mediaURLs.

varsToAppendToLinks

varsToAppendToLinks=widgetId=$widgetId

Appends the query string specified to all outbound links. Add a regular ampersand after the first key-value pair to include additional ones (widgetId=$widgetId&var2=asf).

clickTag

clickTAG=http://anyurl.com

Override all outbound links to point to the URL you specify.

clickTag302

clickTAG302=1

If clickTAG is set and clickTAG302=1, the URL specified for clickTAG will be treated as a tracking URL that is prepended to outbound URLs instead of replacing them.

autoPlay

autoPlay=1/0/true/false

Overrides the widget's autoPlay setting.

src

src=http://somewhere.com/widget.json

Retrieve the JSON code for this widget from the URL specified.

Overriding media details

These flashVars are only implemented for the audio player. They are usually used to pass in metadata for a media item specified by the mediaURL parameter.

mediaTitle

mediaTitle=California

Specifies the title of the media item.

mediaAuthor

mediaAuthor=John

Specifies the name of the media item's contributor.

mediaAuthorURL

mediaAuthorURL=http://www.john.com/profile

Specifies the URL of the media item's contributor. Usually links to a profile page.

mediaAuthorImage

mediaAuthorImage=http://photos.com/mypic.jpg

Specifies a thumbnail image for the media item's contributor.


JavaScript-related

js

js=1

When js=1, the widget will let JavaScript invoke its functions.

loadedJSCallback

loadedJSCallback="yourJSFunctionName"

yourJSFunctionName will be called when the widget has finished loading all of its internal components. It will pass the object id of the swf.

clickJSCallback

clickJSCallback="yourJSFunctionName"

yourJSFunctionName will be called every time the widget is clicked. It will be passed the object id of the clicked swf and name of the component clicked.

eventCallbackFunc

eventCallbackFunc="yourJSFunctionName"

yourJSFunctionName will be called every time an event occurs in the widget. It will be passed the name of the component on which the event occurs and an Object that looks like this: 

{type: /* event type */, target: /* component name */, data: /* data associated with event */}

Currently (8/17/09) only propertyChange events for selectedItem trigger this callback. This event is triggered when a new piece of media is loaded or selected in a component. We we will be expanding this to cover many more events and event types in the near future.

Single Sign-On (SSO)

These flashVars are passed to enable SSO support in IE7.

st

st=DEC74E2B9A351D95878DD7E949E34969

tid

tid=125223918090715601846955477

Debugging

kaDebug

kaDebug=1
  • Displays a log of the widget's internal activity in Firebug.

debug

debug=true
  • Displays a log of the widget's internal activity in Firebug.
  • Any OSMF plug-ins installed in the OSMF video player will circumvent caching to load in their latest versions.

dumpParams

dumpParams=1

Instead of rendering the widget, display all the variables that were passed to it.

Arbitrary flashVars

In addition to the reserved flashVars listed above, you can also pass in whatever flashVars you like. You'll then be able to access their values in your widgets with the following bracket syntax: 

#{parameters.nameOfYourFlashVar}
Retrieved from "http://www.kickapps.com/documentation/index.php/FlashVars"