REFERENCE
U.SOUND
Summary
Speaks the specified text, or if the text provided is the path to a sound file will play the sound file
Syntax
Parameters
| Parameter | Required | Description |
|---|---|---|
to_play |
Yes | The file to be played or text to be spoken. Passing a boolean value FALSE will clear current queue of sounds to play |
[max_delay] |
No | The max amount of time in seconds a sound will wait for other sounds to finish playing before it gives up. Default is 60 seconds |
[voice] |
No | The Windows voice that will be used to speak text; If set to TRUE then other params are ignored and a list of installed windows voices is returned unless to_play is a valid Web address in which case TRUE will prevent use of previously downloaded sound file; If a row of values is provided, the 2nd value is the speaking rate (-10 to 10) and the 3rd value is the volume (0 to 100); Set to "WMP" to force use of Windows Media Player even for .wav files |
[block] |
No | If set to TRUE then method will not be calculated unless triggered by user interaction or calculated as a step in a script; If set to a number then will be throttled to not calculate more frequently than the specified number of seconds; make number negative to prevent auto recalc of blocked methods |
Behavior
The documented public interface is supported by the current U Add-in source signature and the maintained Usage Examples workbook. Optional parameters are shown in square brackets in the syntax above; omit the brackets when entering a formula.
Return Value
Returns the function result or action status described by the formula and parameters above. The maintained sources do not define a narrower, stable return contract for this function.
Examples
Notes
- Formula examples are preserved from maintained workbook usage and normalized to the current
U.prefix. - Complete formulas demonstrate working patterns; they do not imply that undocumented option values are supported.
- Where maintained sources do not specify every accepted value, default, or error message, this page does not infer one.
- For functions that perform actions, use a visible trigger or supported block/throttle parameter to avoid unintended repetition during recalculation.
Related
- Concept: Workbook Automation
- How-to: Respond to Clicks and Notifications
- Example: Click-Driven Script