Module Audio :: Class AudioStyle
[hide private]
[frames] | no frames]

Class AudioStyle

source code

          AccessEngine.AEState.AEState --+    
                                         |    
AccessEngine.AEDevice.AEOutput.Style.Style --+
                                             |
                                    ??-293 --+
                                             |
                                            AudioStyle

Defines the basic style attributes for all AEOutput.Audio devices. Most attributes documented below do not exist in this base class. It is the job for a specific output device definition to add new settings to its own style class class if it supports any of the missing concepts. Only those settings related to text parsing are pre-defined here for use by the default implementation of parseString in AEOutput.Audio.

CapString (string): Set to the string that should be presented prior to the spelling of capitalized letters and presented twice before spelling fully capitalized words. Defaults to 'cap'.

Volume (range): Current volume

Rate (range): Current speech rate

Pitch (range): Current baseline pitch

Voice (enum): Current voice number

PosX (integer): Current spatial position x-coordinate, left negative

PosY (integer): Current spatial position y-coordinate, down negative

PosZ (integer): Current spatial position z-coordinate, behind negative

Language (choice): Current language in use by the speech synthesizer formatted according to the syntax set forth in RFC 4646 and drawn from the registry created by RFC 4645. See http://www.ietf.org/rfc/rfc4646.txt and http://www.iana.org/assignments/language-subtag-registry. If an engine implements some unknown derivation, use the 'x' private marker in the name and continue with additional designations. See IBMSpeech for an example implementation. The device is responsible for case-insensitive comparisons.

Instrument (enum): Current MIDI instrument number

Continuous (bool): Is output continuous (i.e. looping)?

Channel (integer): Channel number indicating concurrency of output. Styles sharing a channel number are output sequentially. Styles having different channel numbers are played concurrently if possible.

Stoppable (bool): Can output be stopped?

Speakable (bool): Can output be spoken?

Soundable (bool): Can output be played as a non-speech sound?

Gender (enum): Speech vocal tract gender

Aspiration (range): Speech breathiness

Frication (range): Emphasis of fricatives in speech

Intonation (range): Speech pitch variation

HeadSize (range): Speech speaker head size for reverberation

SpellCaps (bool): When set to True, fully capitalized words will be spelled for presentation if the device supports spelling.

Blank (string): String to substitute for blank output. Defaults to 'blank' localized.

CapExpand (bool): When set to True, a space will be inserted before embedded capital letters in the presentation of a word. Defaults to True.

NumExpand (bool): When set to True, a space will be inserted before embedded numbers in the presentation of a word. Defaults to False.

SpellFormat (enum): Set to FORMAT_TEXT to present words without additional spelling. Set to FORMAT_PRONOUNCE to spell punctuation characters for presentation. Set to FORMAT_SPELL to spell all characters for presentation. Set to FORMAT_PHONETIC to spell all characters phonetically for presentation. Defaults to FORMAT_TEXT. Any values other than FORMAT_TEXT may be ignored by a device.

Instance Methods [hide private]
 
_initDefault(self)
Called automatically by the Style base class when this style is a default.
source code
AEState.Setting.Group
_newWordGroup(self, group)
Builds a group containing settings that should be available for all audio devices given that the Word parser and the Audio.parseString methods support them without any extra work on the part of the device.
source code

Inherited from AccessEngine.AEDevice.AEOutput.Style.Style: __init__, copy, getDefault, init, isDefault, isDirty, iterDirty, makeClean, newRelNumeric, newRelPercent, newRelRange

Instance Variables [hide private]

Inherited from AccessEngine.AEDevice.AEOutput.Style.Style: parent_style

Method Details [hide private]

_initDefault(self)

source code 
Called automatically by the Style base class when this style is a default. Initializes all default audio parsing options. If you want these settings created, be sure to call this base class implementation if you override in a subclass. Defaults to creating all AccessEngine.AEDevice.AEOutput.Word.WordState settings.
Overrides: AccessEngine.AEDevice.AEOutput.Style.Style._initDefault

_newWordGroup(self, group)

source code 
Builds a group containing settings that should be available for all audio devices given that the Word parser and the Audio.parseString methods support them without any extra work on the part of the device.
Parameters:
Returns: AEState.Setting.Group
Group containing the word settings, can be extended as needed