User Guide

Accessibility.isActive() 93

Accessibility.isActive()

Availability

Flash Player 6.

Usage

Accessibility.isActive() : Boolean

Parameters

None.

Returns

A Boolean value: true if the Flash Player is communicating with an accessibility aid (usually a

screen reader);

false otherwise.

Description

Method; indicates whether an accessibility aid is currently active and the player is communicating

with it. Use this method when you want your application to behave differently in the presence of

a screen reader or other accessibility aid.

Note: If you call this method within one or two seconds of the first appearance of the Flash window in

which your document is playing, you might get a return value of

false even if there is an active

Microsoft Active Accessibility (MSAA) client. This is because of an asynchronous communication

mechanism between Flash and MSAA clients. You can work around this limitation by ensuring a

delay of one to two seconds after loading your document before calling this method.

Example

The following example checks whether an accessibility aid is currently active:

if (Accessibility.isActive()) {

trace ("An accessibility aid is currently active");

} else {

trace ("There is currently no active accessibility aid");

}