This function plays a WAV file out a specific audio device. Also allows playing the WAV file in the background and setting the volume level.
Parameter: filename
Type: string
Description: This is the complete path
to the WAV file to play.
Parameter: deviceid
Type: integer
Description: This parameter is obsolete and remains for backward compatibility
with previous versions of HomeSeer. For
replacement functionality, please see the host
parameter below.
Parameter: volume
(left)
Type: integer
Description: This is the volume level to use when playing. The
range is 0 to 100. Set
the value to -1 if you want to use the currently set volume level. In
previous versions of HomeSeer this was the LEFT volume level only - note
that this is now the one and only volume level.
Parameter: volume
(right)
Type: integer
Description: This parameter is obsolete and remains for backward compatibility
with previous versions of HomeSeer.
Parameter: wait
Type: boolean
Description: Use TRUE to not return until the WAV file has finished playing
and FALSE to play the WAV file in the background. The
function returns immediately.
Parameter:
host (optional)
Type: string
Description: Leaving this a null string will apply the command to the first
instance HomeSeer finds, otherwise use the hostname of the computer for
this command. 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.
None.