Interface IFromSpeaker
public interface IFromSpeaker
Public Interface IFromSpeaker
PLEASE NOTE: Code related to the Speech components in HomeSeer were ported from the HS3 plugin API and
have not been fully tested to verify full functionality from the new SDK. The Speech API may undergo
significant changes in the near future. Please use with caution.
Methods
View Source
Disconnect()
Declaration
Function Disconnect As Boolean
Returns
Type |
Description |
System.Boolean |
|
View Source
GetListenMode()
Declaration
Function GetListenMode As Integer
Returns
Type |
Description |
System.Int32 |
|
View Source
GetListenStatus()
Declaration
Function GetListenStatus As Boolean
Returns
Type |
Description |
System.Boolean |
|
View Source
GetMuteStatus()
Declaration
Function GetMuteStatus As Boolean
Returns
Type |
Description |
System.Boolean |
|
View Source
GetPauseStatus()
Declaration
Function GetPauseStatus As Short
Returns
Type |
Description |
System.Int16 |
|
View Source
GetVoiceName()
Declaration
Function GetVoiceName As String
Returns
Type |
Description |
System.String |
|
View Source
GetVolume()
Declaration
Function GetVolume As Integer
Returns
Type |
Description |
System.Int32 |
|
View Source
IsBusy()
Declaration
Function IsBusy As Boolean
Returns
Type |
Description |
System.Boolean |
|
View Source
Declaration
string MEDIAFunction(EMediaOperation operation, string p)
Function MEDIAFunction(operation As EMediaOperation, p As String) As String
Parameters
Returns
Type |
Description |
System.String |
|
View Source
Declaration
int MEDIAPlay(string filename, int fsize)
Function MEDIAPlay(filename As String, fsize As Integer) As Integer
Parameters
Type |
Name |
Description |
System.String |
filename |
|
System.Int32 |
fsize |
|
Returns
Type |
Description |
System.Int32 |
|
View Source
MuteAudio()
Declaration
View Source
PauseAudio()
Declaration
View Source
PlayWaveFile(String, Int32)
Declaration
void PlayWaveFile(string fname, int fsize)
Sub PlayWaveFile(fname As String, fsize As Integer)
Parameters
Type |
Name |
Description |
System.String |
fname |
|
System.Int32 |
fsize |
|
View Source
SendMessage(String, Boolean)
Declaration
int SendMessage(string message, bool showballoon)
Function SendMessage(message As String, showballoon As Boolean) As Integer
Parameters
Type |
Name |
Description |
System.String |
message |
|
System.Boolean |
showballoon |
|
Returns
Type |
Description |
System.Int32 |
|
View Source
SetListenMode(Int32)
Declaration
int SetListenMode(int mode)
Function SetListenMode(mode As Integer) As Integer
Parameters
Type |
Name |
Description |
System.Int32 |
mode |
|
Returns
Type |
Description |
System.Int32 |
|
View Source
SetSpeaker(String)
Declaration
void SetSpeaker(string speaker_name)
Sub SetSpeaker(speaker_name As String)
Parameters
Type |
Name |
Description |
System.String |
speaker_name |
|
View Source
SetSpeakingSpeed(Int32)
Declaration
int SetSpeakingSpeed(int speed)
Function SetSpeakingSpeed(speed As Integer) As Integer
Parameters
Type |
Name |
Description |
System.Int32 |
speed |
|
Returns
Type |
Description |
System.Int32 |
|
View Source
SetVoice(String)
Declaration
short SetVoice(string voice)
Function SetVoice(voice As String) As Short
Parameters
Type |
Name |
Description |
System.String |
voice |
|
Returns
Type |
Description |
System.Int16 |
|
View Source
SetVolume(Int32)
Declaration
Sub SetVolume(vol As Integer)
Parameters
Type |
Name |
Description |
System.Int32 |
vol |
|
View Source
SetVRState(String)
Declaration
void SetVRState(string state)
Sub SetVRState(state As String)
Parameters
Type |
Name |
Description |
System.String |
state |
|
View Source
SpeakText(String, Boolean)
Declaration
void SpeakText(string speaktxt, bool wait)
Sub SpeakText(speaktxt As String, wait As Boolean)
Parameters
Type |
Name |
Description |
System.String |
speaktxt |
|
System.Boolean |
wait |
|
View Source
SpeakToFile(String, String, String)
Declaration
void SpeakToFile(string txt, string fname, string voice = "")
Sub SpeakToFile(txt As String, fname As String, voice As String = "")
Parameters
Type |
Name |
Description |
System.String |
txt |
|
System.String |
fname |
|
System.String |
voice |
|
View Source
StartListen()
Declaration
View Source
StopListen()
Declaration
View Source
StopSpeaking()
Declaration
View Source
UnMuteAudio()
Declaration
View Source
UnPauseAudio()
Declaration
View Source
VRChanged()
Declaration