| Package | com.javactionscript.client |
| Class | public class JavactionscriptSettings |
| Method | Defined by | ||
|---|---|---|---|
|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
| JavactionscriptSettings | ||
|
disableNetworkFeedback():void
[static] Hides the progress discs that appear when downloading or uploading data.
| JavactionscriptSettings | ||
|
hasEventListener(type:String):Boolean
[static] Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
| JavactionscriptSettings | ||
|
initialize($root:DisplayObject, $width:int, $height:int):void
[static] Specifies the root MovieClip and the document size (required in order to allow Javactionscript to work properly).
| JavactionscriptSettings | ||
|
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
[static] Removes a listener from the EventDispatcher object.
| JavactionscriptSettings | ||
|
setDebugMode($whenLocal:Boolean, $whenNetwork:Boolean):void
[static] Specifies in which circumstances the debug mode (more tracing information) will be used.
| JavactionscriptSettings | ||
|
setDefaultFont($font:String):void
[static] Specifies the font to be used when creating TextFields (for notifications messages, loading progress statuses etc.).
| JavactionscriptSettings | ||
|
setRtmpURL($whenLocal:String, $whenNetwork:String):void
[static] Specifies the address of the streaming server.
| JavactionscriptSettings | ||
|
setServicesURL($whenLocal:String, $whenNetwork:String, $pollingPeriod:Number):void
[static] Specifies the address of the Java Servlet (or JSP page) that provides the Javactionscript services (see Java documentation).
| JavactionscriptSettings | ||
|
setStatusNotification($adminOnlineMessage:String, $adminOfflineMessage:String):void
[static] Specify the notification messages that will appear when the administrator goes online or offline.
| JavactionscriptSettings | ||
|
setVolume($volume:Number):void
[static] Changes the sound volume level.
| JavactionscriptSettings | ||
| Constant | Defined by | ||
|---|---|---|---|
| ADMIN_OFFLINE : String = "ADMIN_OFFLINE" [static] Dispatched at start if the admin is offline and also every time the admin goes offline (delay that depends on the keep-alive defined when specifying the service address).
| JavactionscriptSettings | ||
| ADMIN_ONLINE : String = "ADMIN_ONLINE" [static] Dispatched at start if the admin is online and also every time the admin arrives online (delay that depends on the keep-alive defined when specifying the service address).
| JavactionscriptSettings | ||
| AUTHENTICATED_AS_ADMIN : String = "AUTHENTICATED_AS_ADMIN" [static] Dispatched when the user has successfully authenticated himself as the administrator.
| JavactionscriptSettings | ||
| WEBCAM_CAPTURE : String = "WEBCAM_CAPTURE" [static] Dispatched when the webcam is capturing data.
| JavactionscriptSettings | ||
| addEventListener | () | method |
public static function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):voidRegisters an event listener object with an EventDispatcher object so that the listener receives notification of an event. Just calls the native Actionscript method, see Adobe documentation for more details.
Parameterstype:String |
|
listener:Function |
|
useCapture:Boolean (default = false) |
|
priority:int (default = 0) |
|
useWeakReference:Boolean (default = false) |
| disableNetworkFeedback | () | method |
public static function disableNetworkFeedback():voidHides the progress discs that appear when downloading or uploading data.
| hasEventListener | () | method |
public static function hasEventListener(type:String):BooleanChecks whether the EventDispatcher object has any listeners registered for a specific type of event. Just calls the native Actionscript method, see Adobe documentation for more details.
Parameterstype:String |
Boolean |
| initialize | () | method |
public static function initialize($root:DisplayObject, $width:int, $height:int):voidSpecifies the root MovieClip and the document size (required in order to allow Javactionscript to work properly).
Parameters$root:DisplayObject — the root MovieClip.
|
|
$width:int — the width of the Flash document.
|
|
$height:int — the height of the Flash document. |
| removeEventListener | () | method |
public static function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):voidRemoves a listener from the EventDispatcher object. Just calls the native Actionscript method, see Adobe documentation for more details.
Parameterstype:String |
|
listener:Function |
|
useCapture:Boolean (default = false) |
| setDebugMode | () | method |
public static function setDebugMode($whenLocal:Boolean, $whenNetwork:Boolean):voidSpecifies in which circumstances the debug mode (more tracing information) will be used.
Parameters$whenLocal:Boolean — if true, the debug mode will be enabled when the Flash movie runs from the local machine.
|
|
$whenNetwork:Boolean — if true, the debug mode will be enabled when the Flash movie runs from the network. |
| setDefaultFont | () | method |
public static function setDefaultFont($font:String):voidSpecifies the font to be used when creating TextFields (for notifications messages, loading progress statuses etc.). The default font is "tahoma".
Parameters$font:String — the font name |
| setRtmpURL | () | method |
public static function setRtmpURL($whenLocal:String, $whenNetwork:String):voidSpecifies the address of the streaming server.
Parameters$whenLocal:String — the address to use when the Flash movie runs from the local machine.
|
|
$whenNetwork:String — the address to use when the Flash movie runs from the network. |
| setServicesURL | () | method |
public static function setServicesURL($whenLocal:String, $whenNetwork:String, $pollingPeriod:Number):voidSpecifies the address of the Java Servlet (or JSP page) that provides the Javactionscript services (see Java documentation).
Parameters$whenLocal:String — the address to use when the Flash movie runs from the local machine.
|
|
$whenNetwork:String — the address to use when the Flash movie runs from the network.
|
|
$pollingPeriod:Number — the period of time between each keep-alive signal that is sent to the server (in order to update the user status and to retreive the server status), in seconds. If specified, it requires the user services to be registered by the factory on the server-side (see Java documentation). |
| setStatusNotification | () | method |
public static function setStatusNotification($adminOnlineMessage:String, $adminOfflineMessage:String):voidSpecify the notification messages that will appear when the administrator goes online or offline. The default is null (no messages)
Parameters$adminOnlineMessage:String — the message that will be displayed when the administrator goes online
|
|
$adminOfflineMessage:String — the message that will be displayed when the administrator goes offline |
| setVolume | () | method |
public static function setVolume($volume:Number):voidChanges the sound volume level.
Parameters$volume:Number — the volume ratio (from 0.0 to 1.0). |
| ADMIN_OFFLINE | constant |
public static const ADMIN_OFFLINE:String = "ADMIN_OFFLINE"Dispatched at start if the admin is offline and also every time the admin goes offline (delay that depends on the keep-alive defined when specifying the service address).
| ADMIN_ONLINE | constant |
public static const ADMIN_ONLINE:String = "ADMIN_ONLINE"Dispatched at start if the admin is online and also every time the admin arrives online (delay that depends on the keep-alive defined when specifying the service address).
| AUTHENTICATED_AS_ADMIN | constant |
public static const AUTHENTICATED_AS_ADMIN:String = "AUTHENTICATED_AS_ADMIN"Dispatched when the user has successfully authenticated himself as the administrator.
| WEBCAM_CAPTURE | constant |
public static const WEBCAM_CAPTURE:String = "WEBCAM_CAPTURE"Dispatched when the webcam is capturing data.