Trees       Indices       Help   
SUE - Revision 232
Package AccessEngine :: Package AccessEngineAPI :: Module Output
[hide private]
[frames] | no frames]

Module Output

source code

Defines AccessEngineAPI for doing output. Provides methods for doing output on any AEOutput device.

Authors:
Peter Parente, Pete Brunet, Brett Clippingdale, Frank Zenker, Nicole Anacker, Ramona Bunk, Martina Weicht
Organizations: Copyright:

License: The BSD License All rights reserved. This program and the accompanying materials are made available under the terms of the BSD license which accompanies this distribution, and is available at http://www.opensource.org/licenses/bsd-license.php

Functions [hide private]
 
setScriptIdealOutput(script, *capabilities)
Sets the ideal device capabilities to be used to locate a device for all output methods invoked from the caller's AEScript module.		 source code
list of string
getScriptIdealOutput(script)
Gets the ideal device capabilities to locate a device to be used by all output methods invoked from the caller's AEScript module.		 source code
AEOutput
getOutputDevice(name=None, *capabilities)
Gets an AEOutput device from the AEDeviceManager given its name or its capabilities.		 source code
 
stopNow(script, cap, role, dev=None, sem=None, reset=True, **kwargs)
Tells the referenced or matching output devices to interrupt current output and clear buffered data.		 source code
boolean
mayStop(script, cap, role, dev=None, sem=None, **kwargs)
Stops the device if may_stop is zero.		 source code
 
inhibitMayStop()
Prevents the next call to mayStop from stopping the device provided to that call.		 source code
 
stopAll(script, dev=None)
Tells the referenced output device to interrupt current output and clear buffered data.		 source code
 
play(self, script, layer, filename, sem=None, dev=None, talk=True)
Outputs the contents of a file.		 source code
 
say(script, cap, role, text, layer, por=None, sem=None, dev=None, talk=True)
Sends a string of text to a device that supports string display.		 source code
 
_chooseOutputDevices(cap, role, dev=None)
Convenience method to choose the appropriate output devices according to the given capability and role.		 source code
object
send(script, layer, name, value, sem=None, dev=None, cap=None, role=None)
Sends arbitrary data to a device.		 source code
AccessEngine.AEOutput.AEOutput.Style
getStyle(script, layer, dev=None, sem=None)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer.		 source code
AEState.Setting
getStyleSetting(script, name, dev=None, sem=None, **kwargs)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately fetches the AEState.Setting object with the given name.		 source code
object
getStyleVal(script, name, dev=None, sem=None, **kwargs)
Gets the AEOutput object for the given device, semantic tag, and event layer, then immediately fetches the value of the AEState.Setting object with the given name.		 source code
 
setStyleVal(script, name, val, dev=None, sem=None, **kwargs)
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately sets the value of the AEState.Setting object with the given name.		 source code
boolean
sayTextAttrs(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccAllTextAttrs and outputs the result.		 source code
boolean
sayWord(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getWordText and outputs the result.		 source code
boolean
sayChar(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getCharText and outputs the result.		 source code
boolean
sayName(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccName and outputs the result.		 source code
boolean
sayLabel(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccLabel and outputs the result.		 source code
boolean
sayItem(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getItemText and outputs the result.		 source code
boolean
sayWindow(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getWindowTitle and outputs the result.		 source code
boolean
saySection(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccLabel and outputs the result.		 source code
boolean
sayApp(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAppName and outputs the result.		 source code
boolean
sayFont(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccTextAttr and outputs the value associated with the "family-name" property.		 source code
boolean
sayCount(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccCount and outputs the result.		 source code
boolean
sayIndex(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccIndex and outputs the result.		 source code
boolean
sayColor(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccTextAttr and outputs the value associated with the "fg-color" property.		 source code
boolean
sayRole(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccRoleName and outputs the result.		 source code
boolean
sayLevel(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccLevel and outputs the result.		 source code
boolean
sayStatus(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getItemText and outputs the result.		 source code
boolean
sayState(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getStateText and outputs the result.		 source code
boolean
sayDesc(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccDesc and outputs the result.		 source code
boolean
sayHotkey(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccClickKey and outputs the result after replacing <> characters.		 source code
boolean
sayError(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Outputs an SUE system error message.		 source code
boolean
sayInfo(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Outputs an informational SUE system message.		 source code
boolean
sayConfirm(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Outputs a confirmation message for a user action.		 source code
boolean
sayValue(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccFloatValue and outputs the result.		 source code
boolean
sayValueExtents(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)
Calls View.getAccFloatValueExtents and outputs the result.		 source code
 
setBrlCaretPosition(script, layer, value, cap, role, sem=None, dev=None)
Sets caret location on the device.		 source code
object
setBrlTruncate(script, layer, value, cap, role, sem=None, dev=None)
Sets a two-item tuple (left, right) to the device indicating if a line of text has been truncated either on the left or right side.		 source code
tuple
getBrlEllipsisSizes(script, layer, cap, role, sem=None, dev=None)
Gets a two-item tuple (left and right) containing the ellipsis length.		 source code
integer
getBrlMissingCellCount(script, layer, cap, role, sem=None, dev=None)
Gets the number of missing/broken cells defined by the "missing cell string" user setting.		 source code
 
setMagGoto(script, layer, value, cap, role, sem=None, dev=None)
Sets the viewport of the magnifier		 source code
tuple
getMagROI(script, layer, cap, role, sem=None, dev=None)
Get the region of interest from magnifier device.		 source code
string
getClosestLang(script, layer, tag, cap, role, sem=None, dev=None)
Get the closest language supported by the device to the one given by the IANA tag.		 source code
Variables [hide private]
integer may_stop = 0
Count of the number of calls to inhibitMayStop.
Function Details [hide private]

setScriptIdealOutput(script, *capabilities)

source code 
Sets the ideal device capabilities to be used to locate a device for all output methods invoked from the caller's AEScript module. The capabilities list should include strings naming AEOutput interfaces ("audio" and/or "braille") at present.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • capabilities (list of string) - Names of capabilities required on the device

getScriptIdealOutput(script)

source code 
Gets the ideal device capabilities to locate a device to be used by all output methods invoked from the caller's AEScript module.
Parameters:
Returns: list of string
Names of capabilities set as ideal for a default output device

getOutputDevice(name=None, *capabilities)

source code 

Gets an AEOutput device from the AEDeviceManager given its name or its capabilities. The capabilities list may include strings naming AEOutput interfaces ("audio" and/or "braille" at present).

If neither is specified, the first available output device in the AEDeviceManager is returned.
Parameters:
  • name (string) - Class (UIE) name of the AEOutput device to get
  • capabilities (list of string) - Names of capabilities required on the device
Returns: AEOutput
The named output device
Raises:

stopNow(script, cap, role, dev=None, sem=None, reset=True, **kwargs)

source code 
Tells the referenced or matching output devices to interrupt current output and clear buffered data.
Parameters:
  • script (AEScript) - The AEScript that calls this method
  • cap (string) - The target device's capability
  • role (string) - The target device's role
  • dev (AEOutput) - The device to send the stop to; defaults to None for the default output device
  • sem (integer) - The semantic information to stop; defaults to None for the default semantic
  • reset (boolean) - Reset the may_stop count (True) or leave it as-is when sending the stop?
  • kwargs (dictionary) - this method need EventLayer
Raises:
  • KeyError - when the kwargs don't contain the key 'layer'

mayStop(script, cap, role, dev=None, sem=None, **kwargs)

source code 
Stops the device if may_stop is zero. When non-zero, decrements the count.
Parameters:
  • script (AEScript) - The AEScript that calls this method
  • cap (string) - The target device's capability
  • role (string) - The target device's role
  • dev (AEOutput) - The device to send the stop to; defaults to None for the default output device
  • sem (integer) - The semantic information to stop; defaults to None for the default semantic
  • kwargs (dictionary) - need EventLayer
Returns: boolean
Was the stop processed (True) or inhibited (False)?
Raises:
  • KeyError - when the kwargs don't contain the key 'layer'

inhibitMayStop()

source code 
Prevents the next call to mayStop from stopping the device provided to that call. Adds one to the may_stop flag.

stopAll(script, dev=None)

source code 
Tells the referenced output device to interrupt current output and clear buffered data. Unlike stopNow, this ignores the layer on which the method was called and any semantic information. Everything on the device is stopped, even when AETierManager.SUEState stopping setting is False.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • dev (AEOutput) - The device to send the stop to; defaults to None for the default output device

play(self, script, layer, filename, sem=None, dev=None, talk=True)

source code 
Outputs the contents of a file. The device used to do the output gets to decide what to do with the file based on its contents and the semantic tag and event layer information given.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • filename (string) - Name of the file to be output
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • layer (integer) - Layer on which the event occurred
  • dev (AEOutput) - The device to send the filename to; defaults to None for the default output device
  • talk (boolean) - Send a talk command immediately following the filename?

Note: MW: Wenn sich ein passender UseCase findet, muss hier geprueft werden, ob hier auch das device anhand von cap und role ausgewaehlt werden muss.

say(script, cap, role, text, layer, por=None, sem=None, dev=None, talk=True)

source code 
Sends a string of text to a device that supports string display. If talk is False, the device should buffer the text until another method call occurs which sends a Talk to the device.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occured
  • text (string) - Text to output
  • cap (string) - The target device's capability
  • role (string) - The target device's role
  • por (AEPor) - The point of regard of the start of text, or None when the text is not from the screen
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - The device to send the text to; defaults to None for the default output device
  • talk (boolean) - Send a talk command immediately following the string?

_chooseOutputDevices(cap, role, dev=None)

source code 
Convenience method to choose the appropriate output devices according to the given capability and role.
Parameters:
  • cap (string) - The desired target device's capability
  • role (string) - The desired target device's role
  • dev (AEOutput) - The device to send the text to; defaults to None for the default output device

Note: MW: With role == None, all output devices with the given capability will receive the output (need for braille output, where both the device and the monitor want to receive the output). Be careful when setting capability to 'audio': Always provide a role. If not, it might get messy!

send(script, layer, name, value, sem=None, dev=None, cap=None, role=None)

source code 

Sends arbitrary data to a device. The device must recognize the name in order to decide what to do with the value data.

This is a generic method which receives all content and commands to be rendered and executed on a device. Standard name identifiers should be used whenever possible. For instance, CMD_STOP and CMD_TALK. However, device specific names and values are certainly possible.

Only use this method if no other output method is suitable for your purposes.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • name (object) - Descriptor of the data value sent
  • value (object) - Content value
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command
  • cap (string) - The target device's capability; defaults to None
  • role (string) - The target device's role; defaults to None
Returns: object
Return value specific to the given command

Note: MW: defaults to None for cap and role might not be a good choice here. We should make sure we always values for them!

getStyle(script, layer, dev=None, sem=None)

source code 
Gets the AEOutput.Style object for the given device, semantic tag, and event layer. This is a low level method that allows direct access to AEOutput.Style style objects.
Parameters:
  • script (AEScript) - The AEScript that call the method
  • layer (integer) - Layer on which the event occured
  • dev (AEOutput) - The device on which to get the value; defaults to None for the default output device.
  • sem (integer) - The semantic on which to get the value.
Returns: AccessEngine.AEOutput.AEOutput.Style
The style object or None if one does not exist.

See Also: getStyleSetting

getStyleSetting(script, name, dev=None, sem=None, **kwargs)

source code 
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately fetches the AEState.Setting object with the given name. This is a low level method that allows direct access to AEState.Settings on the style. It is permissible to read/write the value property of settings fields and register for change notifications.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • name (string) - Name of the setting object to fetch
  • dev (AEOutput) - The device on which this setting should be changed. Defaults to the default output device established by setScriptIdealOutput.
  • sem (integer) - The semantic on which to change the value. Defaults to None meaning the default style
  • kwargs (dictionary) - this method need EventLayer
Returns: AEState.Setting
The setting object
Raises:
  • InvalidStyleError - When the style or the setting name is not valid
  • KeyError - when the kwargs don't contain the key 'layer'

getStyleVal(script, name, dev=None, sem=None, **kwargs)

source code 
Gets the AEOutput object for the given device, semantic tag, and event layer, then immediately fetches the value of the AEState.Setting object with the given name.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • name (string) - Name of the setting value to fetch
  • dev (AEOutput) - The device on which this setting should be changed. Defaults to the default output device established by setScriptIdealOutput.
  • sem (integer) - The semantic on which to change the value. Defaults to None meaning the default style
  • kwargs (dictionary) - this method need EventLayer
Returns: object
The setting value
Raises:
  • InvalidStyleError - When the style or the setting name is not valid
  • KeyError - when the kwargs don't contain the key 'layer'

setStyleVal(script, name, val, dev=None, sem=None, **kwargs)

source code 
Gets the AEOutput.Style object for the given device, semantic tag, and event layer, then immediately sets the value of the AEState.Setting object with the given name.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • name (string) - Name of the setting value to fetch
  • val (object) - The setting value
  • dev (AEOutput) - The device on which this setting should be changed. Defaults to the default output device established by setScriptIdealOutput.
  • sem (integer) - The semantic on which to change the value. Defaults to None meaning the default style
  • kwargs (dictionary) - this method need EventLayer
Raises:
  • InvalidStyleError - When the style or the setting name is not valid
  • KeyError - when the kwargs don't contain the key 'layer'

sayTextAttrs(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccAllTextAttrs and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • cap (string) - The target device's capability
  • role (string) - The target device's role
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayWord(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getWordText and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayChar(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getCharText and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayName(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccName and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayLabel(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccLabel and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor and EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayItem(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getItemText and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor and EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayWindow(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getWindowTitle and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?

saySection(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccLabel and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayApp(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAppName and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayFont(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccTextAttr and outputs the value associated with the "family-name" property.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayCount(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccCount and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayIndex(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccIndex and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayColor(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccTextAttr and outputs the value associated with the "fg-color" property.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayRole(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccRoleName and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayLevel(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccLevel and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayStatus(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getItemText and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayState(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getStateText and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayDesc(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccDesc and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayHotkey(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccClickKey and outputs the result after replacing <> characters.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayError(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Outputs an SUE system error message.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayInfo(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Outputs an informational SUE system message.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayConfirm(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Outputs a confirmation message for a user action. AEPor ignored.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayValue(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccFloatValue and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

sayValueExtents(script, cap, role, text=None, template=u'%s', dev=None, talk=True, **kwargs)

source code 
Calls View.getAccFloatValueExtents and outputs the result.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • text (string) - Manually provided text fetched from the AEPor
  • template (string) - Template for text to be spoken. Defaults to %s indicating the text or value retrieved from the AEPor is spoken by it
  • dev (AEOutput) - The device to use for output. Defaults to the default output device established by setScriptIdealOutput.
  • talk (boolean) - Send a CMD_TALK immediately after this string is sent?
  • kwargs (dictionary) - this method need AEPor, EventLayer
Returns: boolean
Was anything sent for output (True) or was text None (False)?
Raises:
  • KeyError - when the kwargs don't contain the keys 'layer' and 'por'

setBrlCaretPosition(script, layer, value, cap, role, sem=None, dev=None)

source code 
Sets caret location on the device.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • value (integer) - Caret position
  • cap (string) - The target device's capability
  • role (string) - The target device's role
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command

setBrlTruncate(script, layer, value, cap, role, sem=None, dev=None)

source code 
Sets a two-item tuple (left, right) to the device indicating if a line of text has been truncated either on the left or right side.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • value (tuple) - Two-item tuple of booleans (left, right) indicating trucation
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command
Returns: object
Return value specific to the given command

getBrlEllipsisSizes(script, layer, cap, role, sem=None, dev=None)

source code 
Gets a two-item tuple (left and right) containing the ellipsis length.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command
Returns: tuple
(left, right) ellipsis length

getBrlMissingCellCount(script, layer, cap, role, sem=None, dev=None)

source code 
Gets the number of missing/broken cells defined by the "missing cell string" user setting.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command
Returns: integer
Number of missing/broken cells

setMagGoto(script, layer, value, cap, role, sem=None, dev=None)

source code 
Sets the viewport of the magnifier
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • value (tuple) - viewport settings in the form (x1, y1, x2, y2)
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command

getMagROI(script, layer, cap, role, sem=None, dev=None)

source code 
Get the region of interest from magnifier device.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • sem (integer) - The semantic stream on which to send output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command
Returns: tuple
ROI as a four-item tuple in the form (x1, y1, x2, y2)

getClosestLang(script, layer, tag, cap, role, sem=None, dev=None)

source code 
Get the closest language supported by the device to the one given by the IANA tag. See the Devices.Audio.AudioStyle comment about languages for help on formatting a proper IANA tag.
Parameters:
  • script (AEScript) - The AEScript that call this method
  • layer (integer) - Layer on which the event occurred
  • tag (string) - IANA tag name
  • sem (integer) - Semantic tag indicating the kind of output; defaults to None for the default semantic.
  • dev (AEOutput) - Device that should receive the command
Returns: string
IANA tag name closest to the one given or None meaning no supported language makes sense

Variables Details [hide private]

may_stop

Count of the number of calls to inhibitMayStop. When greater than zero, the next call to mayStop will decrement the count. When zero, mayStop will send a stop to the output device.
Type:
integer
Value:
0

   Trees       Indices       Help   
SUE - Revision 232
Generated by Epydoc 3.0beta1 on Mon Jun 30 13:05:48 2008 http://epydoc.sourceforge.net