Package | flash.system |
Class | public final class Capabilities |
Inheritance | Capabilities ![]() |
You can send capabilities information, which is stored in the
Capabilities.serverString
property as a URL-encoded string, using the
GET
or POST
HTTP method. The following example shows a server
string for a computer that has MP3 support and 1600 x 1200 pixel resolution and that is
running Windows XP with an input method editor (IME) installed:
A=t&SA=t&SV=t&EV=t&MP3=t&AE=t&VE=t&ACC=f&PR=t&SP=t& SB=f&DEB=t&V=WIN%209%2C0%2C0%2C0&M=Adobe%20Windows& R=1600x1200&DP=72&COL=color&AR=1.0&OS=Windows%20XP& L=en&PT=External&AVD=f&LFD=f&WD=f&IME=t
The following table lists the properties of the Capabilities class and corresponding server strings:
Capabilities class property | Server string |
---|---|
avHardwareDisable | AVD |
hasAccessibility | ACC |
hasAudio | A |
hasAudioEncoder | AE |
hasEmbeddedVideo | EV |
hasIME | IME |
hasMP3 | MP3 |
hasPrinting | PR |
hasScreenBroadcast | SB |
hasScreenPlayback | SP |
hasStreamingAudio | SA |
hasStreamingVideo | SV |
hasTLS | TLS |
hasVideoEncoder | VE |
isDebugger | DEB |
language | L |
localFileReadDisable | LFD |
manufacturer | M |
os | OS |
pixelAspectRatio | AR |
playerType | PT |
screenColor | COL |
screenDPI | DP |
screenResolutionX | R |
screenResolutionY | R |
version | V |
All properties of the Capabilities class are read-only.
Property | Defined By | ||
---|---|---|---|
avHardwareDisable : Boolean
[static] [read-only]
Specifies whether access to the user's camera and microphone has
been administratively prohibited (true) or allowed (false).
| Capabilities | ||
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
hasAccessibility : Boolean
[static] [read-only]
Specifies whether the system supports
(true) or does not support (false) communication
with accessibility aids.
| Capabilities | ||
hasAudio : Boolean
[static] [read-only]
Specifies whether the system has audio
capabilities.
| Capabilities | ||
hasAudioEncoder : Boolean
[static] [read-only]
Specifies whether the system can (true) or cannot (false)
encode an audio stream, such as that coming from a microphone.
| Capabilities | ||
hasEmbeddedVideo : Boolean
[static] [read-only]
Specifies whether the system supports
(true) or does not support (false)
embedded video.
| Capabilities | ||
hasIME : Boolean
[static] [read-only]
Specifies whether the system does (true)
or does not (false) have an input method editor (IME) installed.
| Capabilities | ||
hasMP3 : Boolean
[static] [read-only]
Specifies whether the system does (true)
or does not (false) have an MP3 decoder.
| Capabilities | ||
hasPrinting : Boolean
[static] [read-only]
Specifies whether the system does (true)
or does not (false) support printing.
| Capabilities | ||
hasScreenBroadcast : Boolean
[static] [read-only]
Specifies whether the system does (true) or does not (false)
support the development of screen broadcast applications to be run through Flash Media
Server.
| Capabilities | ||
hasScreenPlayback : Boolean
[static] [read-only]
Specifies whether the system does (true) or does not
(false) support the playback of screen broadcast applications
that are being run through Flash Media Server.
| Capabilities | ||
hasStreamingAudio : Boolean
[static] [read-only]
Specifies whether the system can (true) or cannot (false)
play streaming audio.
| Capabilities | ||
hasStreamingVideo : Boolean
[static] [read-only]
Specifies whether the system can (true) or cannot
(false) play streaming video.
| Capabilities | ||
hasTLS : Boolean
[static] [read-only]
Specifies whether the system supports native SSL sockets through NetConnection
(true) or does not (false).
| Capabilities | ||
hasVideoEncoder : Boolean
[static] [read-only]
Specifies whether the system can (true) or cannot
(false) encode a video stream, such as that coming
from a web camera.
| Capabilities | ||
isDebugger : Boolean
[static] [read-only]
Specifies whether the system is a special debugging version
(true) or an officially released version (false).
| Capabilities | ||
language : String
[static] [read-only]
Specifies the language code of the system on which the content is running.
| Capabilities | ||
localFileReadDisable : Boolean
[static] [read-only]
Specifies whether read access to the user's hard disk has been
administratively prohibited (true) or allowed
(false).
| Capabilities | ||
manufacturer : String
[static] [read-only]
Specifies the manufacturer of the running version of
Flash Player or the AIR runtime, in the format "Adobe
OSName".
| Capabilities | ||
os : String
[static] [read-only]
Specifies the current operating system.
| Capabilities | ||
pixelAspectRatio : Number
[static] [read-only]
Specifies the pixel aspect ratio of the screen.
| Capabilities | ||
playerType : String
[static] [read-only]
Specifies the type of runtime environment.
| Capabilities | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
screenColor : String
[static] [read-only]
Specifies the screen color.
| Capabilities | ||
screenDPI : Number
[static] [read-only]
Specifies the dots-per-inch (dpi) resolution of the screen, in pixels.
| Capabilities | ||
screenResolutionX : Number
[static] [read-only]
Specifies the maximum horizontal resolution of the screen.
| Capabilities | ||
screenResolutionY : Number
[static] [read-only]
Specifies the maximum vertical resolution of the screen.
| Capabilities | ||
serverString : String
[static] [read-only]
A URL-encoded string that specifies values for each Capabilities
property.
| Capabilities | ||
version : String
[static] [read-only]
Specifies the Flash Player or Adobe® AIR
platform and version information.
| Capabilities |
avHardwareDisable | property |
avHardwareDisable:Boolean
[read-only]
Specifies whether access to the user's camera and microphone has
been administratively prohibited (true
) or allowed (false
).
The server string is AVD
.
For content in Adobe AIR™, this property applies only to content in security sandboxes other than the application security sandbox. Content in the application security sandbox can always access the user's camera and microphone.
public static function get avHardwareDisable():Boolean
See also
hasAccessibility | property |
hasAccessibility:Boolean
[read-only]
Specifies whether the system supports
(true
) or does not support (false
) communication
with accessibility aids.
The server string is ACC
.
public static function get hasAccessibility():Boolean
See also
hasAudio | property |
hasAudio:Boolean
[read-only]
Specifies whether the system has audio
capabilities. This property is always true
. The server
string is A
.
public static function get hasAudio():Boolean
hasAudioEncoder | property |
hasAudioEncoder:Boolean
[read-only]
Specifies whether the system can (true
) or cannot (false
)
encode an audio stream, such as that coming from a microphone.
The server string is AE
.
public static function get hasAudioEncoder():Boolean
hasEmbeddedVideo | property |
hasEmbeddedVideo:Boolean
[read-only]
Specifies whether the system supports
(true
) or does not support (false
)
embedded video. The server string is EV
.
public static function get hasEmbeddedVideo():Boolean
hasIME | property |
hasIME:Boolean
[read-only]
Specifies whether the system does (true
)
or does not (false
) have an input method editor (IME) installed.
The server string is IME
.
public static function get hasIME():Boolean
See also
hasMP3 | property |
hasMP3:Boolean
[read-only]
Specifies whether the system does (true
)
or does not (false
) have an MP3 decoder.
The server string is MP3
.
public static function get hasMP3():Boolean
hasPrinting | property |
hasPrinting:Boolean
[read-only]
Specifies whether the system does (true
)
or does not (false
) support printing.
The server string is PR
.
public static function get hasPrinting():Boolean
hasScreenBroadcast | property |
hasScreenBroadcast:Boolean
[read-only]
Specifies whether the system does (true
) or does not (false
)
support the development of screen broadcast applications to be run through Flash Media
Server.
The server string is SB
.
public static function get hasScreenBroadcast():Boolean
hasScreenPlayback | property |
hasScreenPlayback:Boolean
[read-only]
Specifies whether the system does (true
) or does not
(false
) support the playback of screen broadcast applications
that are being run through Flash Media Server.
The server string is SP
.
public static function get hasScreenPlayback():Boolean
hasStreamingAudio | property |
hasStreamingAudio:Boolean
[read-only]
Specifies whether the system can (true
) or cannot (false
)
play streaming audio.
The server string is SA
.
public static function get hasStreamingAudio():Boolean
hasStreamingVideo | property |
hasStreamingVideo:Boolean
[read-only]
Specifies whether the system can (true
) or cannot
(false
) play streaming video.
The server string is SV
.
public static function get hasStreamingVideo():Boolean
hasTLS | property |
hasTLS:Boolean
[read-only]
Specifies whether the system supports native SSL sockets through NetConnection
(true
) or does not (false
).
The server string is TLS
.
public static function get hasTLS():Boolean
See also
hasVideoEncoder | property |
hasVideoEncoder:Boolean
[read-only]
Specifies whether the system can (true
) or cannot
(false
) encode a video stream, such as that coming
from a web camera.
The server string is VE
.
public static function get hasVideoEncoder():Boolean
isDebugger | property |
isDebugger:Boolean
[read-only]
Specifies whether the system is a special debugging version
(true
) or an officially released version (false
).
The server string is DEB
. This property is set to true
when running in the debug version of Flash Player or
the AIR Debug Launcher (ADL).
public static function get isDebugger():Boolean
language | property |
language:String
[read-only]
Specifies the language code of the system on which the content is running. The language is
specified as a lowercase two-letter language code from ISO 639-1. For Chinese, an additional
uppercase two-letter country code from ISO 3166 distinguishes between Simplified and
Traditional Chinese. The languages codes are based on the English names of the language: for example,
hu
specifies Hungarian.
On English systems, this property returns only the language code (en
), not
the country code. On Microsoft Windows systems, this property returns the user interface (UI)
language, which refers to the language used for all menus, dialog boxes, error messages, and help
files. The following table lists the possible values:
Language | Value |
---|---|
Czech | cs |
Danish | da |
Dutch | nl |
English | en |
Finnish | fi |
French | fr |
German | de |
Hungarian | hu |
Italian | it |
Japanese | ja |
Korean | ko |
Norwegian | no |
Other/unknown | xu |
Polish | pl |
Portuguese | pt |
Russian | ru |
Simplified Chinese | zh-CN |
Spanish | es |
Swedish | sv |
Traditional Chinese | zh-TW |
Turkish | tr |
The server string is L
.
public static function get language():String
The Capabilities.language
property returns the ISO 639-1 language code
(for example, "en" for English). The switch
statement checks for the language code and sets
the content of the myTextField
text field to a greeting specific to the
language. If the language code is not supported by the example, the default error string
is returned.
package { import flash.display.Sprite; import flash.text.TextField; import flash.text.TextFieldAutoSize; import flash.system.Capabilities; public class Capabilities_languageExample extends Sprite { public function Capabilities_languageExample() { var myTextField:TextField = new TextField(); myTextField.x = 10; myTextField.y = 10; myTextField.background = true; myTextField.autoSize = TextFieldAutoSize.LEFT; var greetingEnglish:String = "Hello World"; var greetingGerman:String = "Hallo Welt"; var greetingFrench:String = "Bonjour Monde"; var greetingSpanish:String = "Hola Mundo"; var lang:String = Capabilities.language; switch (lang) { case "en": myTextField.text = greetingEnglish; break; case "de": myTextField.text = greetingGerman; break; case "fr": myTextField.text = greetingFrench; break; case "es": myTextField.text = greetingSpanish; break; default: myTextField.text = "Sorry your system's language is not supported at this time."; } this.addChild(myTextField); } } }
localFileReadDisable | property |
localFileReadDisable:Boolean
[read-only]
Specifies whether read access to the user's hard disk has been
administratively prohibited (true
) or allowed
(false
). For content in Adobe AIR, this property
applies only to content in security sandboxes other
than the application security sandbox. (Content in the application
security sandbox can always read from the file system.)
If this property is true
,
Flash Player cannot read files (including the first file that
Flash Player launches with) from the user's hard disk.
If this property is true
, AIR content outside of the
application security sandbox cannot read files from the user's
hard disk. For example, attempts to read a file on the user's
hard disk using load methods will fail if this property
is set to true
.
Reading runtime shared libraries is also blocked
if this property is set to true
, but reading local shared objects
is allowed without regard to the value of this property.
The server string is LFD
.
public static function get localFileReadDisable():Boolean
See also
manufacturer | property |
manufacturer:String
[read-only]
Specifies the manufacturer of the running version of
Flash Player or the AIR runtime, in the format "Adobe
OSName"
. The value for OSName
could be "Windows"
, "Macintosh"
,
"Linux"
, or another operating system name. The server string is M
.
public static function get manufacturer():String
os | property |
os:String
[read-only]
Specifies the current operating system. The os
property
can return the following strings: "Windows XP"
, "Windows 2000"
,
"Windows NT"
, "Windows 98/ME"
, "Windows 95"
,
"Windows CE"
(available only in Flash Player SDK, not in the desktop version),
"Linux"
, and "MacOS"
.
The server string is OS
.
public static function get os():String
pixelAspectRatio | property |
pixelAspectRatio:Number
[read-only]
Specifies the pixel aspect ratio of the screen. The server string
is AR
.
public static function get pixelAspectRatio():Number
playerType | property |
playerType:String
[read-only] Specifies the type of runtime environment. This property can have one of the following values:
"ActiveX"
for the Flash Player ActiveX control used by Microsoft Internet Explorer"Desktop"
for the Adobe AIR runtime (except for SWF content loaded by an HTML page, which
has Capabilities.playerType
set to "PlugIn"
)"External"
for the external Flash Player"PlugIn"
for the Flash Player browser plug-in (and for SWF content loaded by
an HTML page in an AIR application)"StandAlone"
for the stand-alone Flash PlayerThe server string is PT
.
public static function get playerType():String
screenColor | property |
screenColor:String
[read-only]
Specifies the screen color. This property can have the value
"color"
, "gray"
(for grayscale), or
"bw"
(for black and white).
The server string is COL
.
public static function get screenColor():String
screenDPI | property |
screenDPI:Number
[read-only]
Specifies the dots-per-inch (dpi) resolution of the screen, in pixels.
The server string is DP
.
public static function get screenDPI():Number
screenResolutionX | property |
screenResolutionX:Number
[read-only]
Specifies the maximum horizontal resolution of the screen.
The server string is R
(which returns both the width and height of the screen).
This property does not update with a user's screen resolution and instead only indicates the resolution
at the time Flash Player or an Adobe AIR application started.
Also, the value only specifies the main monitor.
public static function get screenResolutionX():Number
screenResolutionY | property |
screenResolutionY:Number
[read-only]
Specifies the maximum vertical resolution of the screen.
The server string is R
(which returns both the width and height of the screen).
This property does not update with a user's screen resolution and instead only indicates the resolution
at the time Flash Player or an Adobe AIR application started.
Also, the value only specifies the main monitor.
public static function get screenResolutionY():Number
serverString | property |
serverString:String
[read-only] A URL-encoded string that specifies values for each Capabilities property.
The following example shows a URL-encoded string:
A=t&SA=t&SV=t&EV=t&MP3=t&AE=t&VE=t&ACC=f&PR=t&SP=t& SB=f&DEB=t&V=WIN%208%2C5%2C0%2C208&M=Adobe%20Windows& R=1600x1200&DP=72&COL=color&AR=1.0&OS=Windows%20XP& L=en&PT=External&AVD=f&LFD=f&WD=f
public static function get serverString():String
version | property |
version:String
[read-only]
Specifies the Flash Player or Adobe® AIR
platform and version information. The format of the version number is:
platform majorVersion,minorVersion,buildNumber,internalBuildNumber.
Possible values for platform are "WIN"
,
"MAC"
, and "UNIX"
. Here are some examples of
version information:
WIN 9,0,0,0 // Flash Player 9 for Windows MAC 7,0,25,0 // Flash Player 7 for Macintosh UNIX 5,0,55,0 // Flash Player 5 for UNIX
The server string is V
.
public static function get version():String
trace()
.
package { import flash.display.Sprite; import flash.system.Capabilities; public class CapabilitiesExample extends Sprite { public function CapabilitiesExample() { showCapabilities(); } private function showCapabilities():void { trace("avHardwareDisable: " + Capabilities.avHardwareDisable); trace("hasAccessibility: " + Capabilities.hasAccessibility); trace("hasAudio: " + Capabilities.hasAudio); trace("hasAudioEncoder: " + Capabilities.hasAudioEncoder); trace("hasEmbeddedVideo: " + Capabilities.hasEmbeddedVideo); trace("hasMP3: " + Capabilities.hasMP3); trace("hasPrinting: " + Capabilities.hasPrinting); trace("hasScreenBroadcast: " + Capabilities.hasScreenBroadcast); trace("hasScreenPlayback: " + Capabilities.hasScreenPlayback); trace("hasStreamingAudio: " + Capabilities.hasStreamingAudio); trace("hasVideoEncoder: " + Capabilities.hasVideoEncoder); trace("isDebugger: " + Capabilities.isDebugger); trace("language: " + Capabilities.language); trace("localFileReadDisable: " + Capabilities.localFileReadDisable); trace("manufacturer: " + Capabilities.manufacturer); trace("os: " + Capabilities.os); trace("pixelAspectRatio: " + Capabilities.pixelAspectRatio); trace("playerType: " + Capabilities.playerType); trace("screenColor: " + Capabilities.screenColor); trace("screenDPI: " + Capabilities.screenDPI); trace("screenResolutionX: " + Capabilities.screenResolutionX); trace("screenResolutionY: " + Capabilities.screenResolutionY); trace("serverString: " + Capabilities.serverString); trace("version: " + Capabilities.version); } } }