GetPauseStatus

Purpose

This function returns the "pause" status of a specific speaker client (host or host:instance).

Parameters

Parameter: host
Type: string
Description: Leaving this a null string will return the status for the first instance HomeSeer finds, otherwise use the hostname of the computer you are interested in determining the pause status of.  If more than one instance of the Speaker application is running on "host" then you may need to specify the instance as well in the format host:instance.

Returns

Return value: pause status
Type: integer (.NET Short)
Description: Bit encoded value indicating the status as follows:

Bit Values

Status

Bit 1 = 0

No Wavefile Instance

Bit 1 = 1

Wavefile Present

Bit 2 = 0

Wavefile Paused

Bit 2 = 1

Wavefile Playing

Bit 3 = 0

TTS Present

Bit 3 = 1

No TTS Present

Bit 4 = 0

TTS is currently speaking

Bit 4 = 1

TTS is not speaking