fusionplayer controllers

The controllers listed below can used to access fusionplayers internal functionality.

 

 

 

47
Name:
buttonTooltipOver()
Control type:
Function
Parameters:
event:
Event

caption:
string
Description:
Displays the tooltip for the current object.
Data returned:
void

 

Example:

thisPluginButton.addEventListener(MouseEvent.ROLL_OVER, addArguments(tooltipOver, ["Switch to fullscreen mode"] ));

function tooltipOver(event:Event, caption:String):void {
  // target fusionplayer
  fusionplayer = MovieClip(stage.getChildAt(0));
  // call to buttonTooltipOver
  fusionplayer.buttonTooltipOver(null, caption);
}

function addArguments(method:Function, additionalArguments:Array):Function {
  return function(event:Event):void {
  method.apply(null, [event].concat(additionalArguments));
 }
}

 

Name:
initialisePlugin()
Control type:
Controller event function
Description:
This is the controller event function that is triggered once the plugin has successfully loaded into fusionplayer.
Data returned:
void

 

Example:

function initialisePlugin():void {
 // enter custom code here
fusionplayer = MovieClip(stage.getChildAt(0));
}

 

Name:
loadingClip
Control type:
Object
Description:
fusionplayer's loading swf MovieClip.
Data returned:
void

 

Example:

fusionplayer = MovieClip(stage.getChildAt(0));
 // Is the loader currently visible?
if (fusionplayer.loadingClip.visible == true) {
 // enter custom code here
}

 

Name:
onFullscreen()
Control type:
Controller event function
Description:
This is the controller event function that is triggered once fusionplayer has entered fullscreen mode.
Data returned:
void

 

Example:

function onFullscreen():void {
 // enter custom code here
}

 

Name:
onChangePano()
Control type:
Controller event function
Description:
This is the controller event function that is triggered once fusionplayer has loaded and transitioned to a panorama.
Data returned:
void

 

Example:

function onChangePano():void {
 // enter custom code here
}

 

Name:
onResetFullscreen()
Control type:
Controller event function
Description:
This is the controller event function that is triggered once fusionplayer has exited fullscreen mode.
Data returned:
void

 

Example:

function onResetFullscreen():void {
 // enter custom code here
}

 

Name:
onClickHotspot()
Control type:
Controller event function
Description:
This is the controller event function that is triggered once a fusionplayer hotspot is clicked.
Data returned:
void

 

Example:

function onClickHotspot():void {
fusionplayer = MovieClip(stage.getChildAt(0));
// if hotspot action is api and the hotspot id clicked is hs_3
 if (fusionplayer.thisHotspotAction == "api" && fusionplayer.hsClicked == "hs_3") {
  // enter custom code here
 }
}

 

Name:
getTotalRooms()
Control type:
Function
Parameters:
none
Description:
Returns the total number of panoramas in the tour.
Data returned:
int

 

Example:

  // target fusionplayer
  fusionplayer = MovieClip(stage.getChildAt(0));
  // call to getTotalRooms
   var totalPanoramas:int = fusionplayer.getTotalRooms();

 

Name:
getCurrentVR()
Control type:
Function
Parameters:
none
Description:
Returns the current panorama number loaded.
Data returned:
int

 

Example:

  // target fusionplayer
  fusionplayer = MovieClip(stage.getChildAt(0));
  // call to getCurrentVR
   var currentVR:int = fusionplayer.getCurrentVR();

 

Name:
getTitles()
Control type:
Function
Parameters:
none
Description:
Returns a list of panorama titles as an array.
Data returned:
Array

 

Example:

  // target fusionplayer
  fusionplayer = MovieClip(stage.getChildAt(0));
  // call to getTitles
   var panoTitles:Array = fusionplayer.getTitles();