ssCore.Flash.allowFullScreen

Allow or disable the ability of the Flash player to enter fullscreen mode. This feature is enabled by default.


Availability:

First available in version 3.5 build 314.


Input Parameters:

flag - A boolean value that determines whether the Flash player is allowed to take over the display and enter fullscreen mode or not. Valid values include: true and false.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Flash.allowFullScreen( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Flash.allowFullScreen( paramsObject );


Notes:

None.


Examples:

ssCore.Flash.allowFullScreen({flag:true});

// Flash.allowFullScreen must be called before the FLV playback
// components enterFullScreenDisplayState() method will work

var vid:FLVPlayback;
vid = new FLVPlayback();
vid.fullScreenTakeOver = true;
...

function onFullscreenButtonClick(e:MouseEvent):void
{
    vid.enterFullScreenDisplayState();
}