EQWatcher Evolution > Scripting  > Audio Functions


List of commands


CD Player

CDPlay, CDStop

WinAMP

GetSyncOption, SetSyncOption, WinampBack, WinampGetMaxVolume, WinampGetMinVolume, WinampSetMaxVolume, WinampSetMinVolume, WinampNext, WinampPause, WinampPlay, WinampRandom, WinampRepeat, WinampStop, WinampWritePlaylist

Text-to-Speech

DisableTTS, EnableTTS, IsAgent, IsTTS, LoadPG, Pronounce, Speak, SpeakPri, SpeakSync, SpeakSyncPri, TTSGetRate, TTSGetVoice, TTSSetRate, TTSSetVoice

.WAV

PlayWAV, PlayWAVPri, PlayWAVSync, PlayWAVSyncPri, SayNumber



The "CDPlay" Command

This command plays a single CD track.

Syntax:

CDPlay([Track])


Track: The track number to play.



The "CDStop" Command

This command stops the CD player.

Syntax:

CDStop()


The "GetSyncOption" Command

This command returns the "Synchronous sounds" option from the EQWatcher Evolution window.

Syntax:

GetSyncOption()

Return Value:

0 - Do nothing to WinAMP
1 - Lower Volume of WinAMP
2 - Pause WinAMP


The "SetSyncOption" Command

This command allows changing the "Synchronous sounds" option from the EQWatcher Evolution window.  The change won't take affect on the window (don't ask) in the current version, but does change the option.

Syntax:

SetSyncOption([Value])


Value: One of the following:

0 - Do nothing to WinAMP
1 - Lower Volume of WinAMP
2 - Pause WinAMP



The "WinampBack" Command

This command hits the "Back" button in WinAMP.

Syntax:

WinampBack()


The "WinampGetMaxVolume" Command

This command returns the Max Volume setting from the EQWatcher Evolution window.

Syntax:

WinampGetMaxVolume()

Return Value:

This command returns the Max Volume setting from the EQWatcher Evolution window (a number between 0 and 100).


The "WinampGetMinVolume" Command

This command returns the Min Volume setting from the EQWatcher Evolution window (from the synchronous sound option).

Syntax:

WinampGetMinVolume()

Return Value:

This command returns the Min Volume setting from the EQWatcher Evolution window (a number between 0 and 100).


The "WinampSetMaxVolume" Command

This command sets the Max Volume setting from the EQWatcher Evolution window (though the change does not take effect on the window from this command).  The WinAMP volume is immediately set to this new value.

Syntax:

WinampSetMaxVolume([Value])

Value: A value between 0 and 100 specifying the desired volume level.


The "WinampSetMinVolume" Command

This command sets the Min Volume setting from the EQWatcher Evolution window (though the change does not take effect on the window from this command).  This is used when the volume is lowered for synchronous sounds.

Syntax:

WinampSetMinVolume([Value])

Value: A value between 0 and 100 specifying the desired volume level.


The "WinampNext" Command

This command hits the "Next" button in WinAMP.

Syntax:

WinampNext()


The "WinampPause" Command

This command hits the "Pause" button in WinAMP.

Syntax:

WinampPause()


The "WinampPlay" Command

This command hits the "Play" button in WinAMP.

Syntax:

WinampPlay()


The "WinampRandom" Command

This command hits the "Random" button in WinAMP.

Syntax:

WinampRandom()


The "WinampRepeat" Command

This command hits the "Repeat" button in WinAMP.

Syntax:

WinampRepeat()


The "WinampStop" Command

This command hits the "Stop" button in WinAMP.

Syntax:

WinampStop()


The "WinampWritePlaylist" Command

This command tells WinAMP to save its playlist.

Syntax:

WinampWritePlaylist()


The "DisableTTS" Command

This command removes EQWatcher's Text-to-Speech access altogether, until the program ends or the EnableTTS command is used.  IsTTS will return false after calling this.

Syntax:

DisableTTS()


The "EnableTTS" Command

This command restores EQWatcher's Text-to-Speech access after it is removed using the DisableTTS command.

CURRENTLY INACTIVE (2.02)

Syntax:

EnableTTS()

Return Value:

This command returns true if Text-to-Speech is active following the call.


The "IsAgent" Command

This command checks if Text-to-Speech is installed and active, and is using Microsoft Agent.

Syntax:

IsAgent()

Return Value:

This command returns true if Text-to-Speech is using Microsoft Agent.


The "IsTTS" Command

This command checks if Text-to-Speech is installed and active.

Syntax:

IsTTS()

Return Value:

This command returns true if Text-to-Speech is active.


The "LoadPG" Command

This command loads a pronunciation guide.

Syntax:

LoadPG([Filename])

Filename: The filename of the pronunciation guide to load.  The .PG extension is not automatically added, it must always be provided.


The "Pronounce" Command

This command instructs EQWatcher to pronounce a word a certain way.

Syntax:

Pronounce([Replace],[With])

Replace: The text to replace for the Text-to-Speech engine. 

With: The text to use instead of Replace for the Text-to-Speech engine.


The "Speak" Command

This command speaks some text, asynchronously.

Syntax:

Speak([Text])

Text: The text to be spoken


The "SpeakPri" Command

This command speaks some text, asynchronously and with a specified priority level.

Syntax:

SpeakPri([Text],[Priority])

Text: The text to be spoken

Priority: A char value (0 to 255 lowest to highest) defining the priority level for this sound.  You are encouraged but not required to use the PRI_xxx identifiers such as PRI_HIGHER


The "SpeakSync" Command

This command speaks some text, synchronously.

Syntax:

SpeakSync([Text])

Text: The text to be spoken


The "SpeakSyncPri" Command

This command speaks some text, synchronously and with a specified priority level.

Syntax:

SpeakSyncPri([Text],[Priority])

Text: The text to be spoken

Priority: A char value (0 to 255 lowest to highest) defining the priority level for this sound.  You are encouraged but not required to use the PRI_xxx identifiers such as PRI_HIGHER


The "TTSGetRate" Command

This command retrieves the current rate of speech.

Syntax:

TTSGetRate()

Return Value:

This command returns the current rate of speech, a number between -10 and 10.


The "TTSGetVoice" Command

This command returns the current voice used for Text-to-Speech.

Syntax:

TTSGetVoice()

Return Value:

This command returns the name of the current voice used for Text-to-Speech.


The "TTSSetRate" Command

This command sets the current rate of speech.

Syntax:

TTSSetRate([Rate])

Rate: The desired rate of speech, a number between -10 (slowest) and 10 (fastest).  This is the absolute rate of speech.  Relative rate can be set by using the value from TTSGetRate


The "TTSSetVoice" Command

This command sets the current voice.

Syntax:

TTSSetVoice([Voice])

Voice: This is a case insensitive search string.  This is NOT the same as the Winamp search, because each word is not searched for independently.  Thus, "Michelle LH" will NOT match "LH Michelle", but "Mary" will match "Microsoft Mary", etc.


The "PlayWAV" Command

This command plays a .WAV file, asynchronously.

Syntax:

PlayWAV([Filename])

Filename: The filename of the .WAV to play.


The "PlayWAVPri" Command

This command plays a .WAV file, asynchronously and with a specified priority level.

Syntax:

PlayWAV([Filename],[Priority])

Filename: The filename of the .WAV to play.

Priority: A char value (0 to 255 lowest to highest) defining the priority level for this sound.  You are encouraged but not required to use the PRI_xxx identifiers such as PRI_HIGHER


The "PlayWAVSync" Command

This command plays a .WAV file, synchronously.

Syntax:

PlayWAVSync([Filename])

Filename: The filename of the .WAV to play.


The "PlayWAVSyncPri" Command

This command plays a .WAV file, synchronously and with a specified priority level.

Syntax:

PlayWAVSync([Filename],[Priority])

Filename: The filename of the .WAV to play.

Priority: A char value (0 to 255 lowest to highest) defining the priority level for this sound.  You are encouraged but not required to use the PRI_xxx identifiers such as PRI_HIGHER


The "SayNumber" Command

This command uses a sequence of .WAV files to "say" a number, the alternative to Text-to-Speech.

Syntax:

SayNumber([Value])

Value: The number to say.  Any number between -999,999,999 and 999,999,999 will have no problem, but I am too lazy to make a .WAV for "billion" to go along with the existing set.