Interface ISpeechAPI
public interface ISpeechAPI
Public Interface ISpeechAPI
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
Connect(String, String, String, String, String)
Declaration
string Connect(string hostname, string instance, string ipaddr, string user, string pw)
Function Connect(hostname As String, instance As String, ipaddr As String, user As String, pw As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
hostname |
|
| System.String |
instance |
|
| System.String |
ipaddr |
|
| System.String |
user |
|
| System.String |
pw |
|
Returns
| Type |
Description |
| System.String |
|
View Source
ConnectLocal(String, String, String, String, String, IFromSpeaker)
Declaration
string ConnectLocal(string hostname, string instance, string ipaddr, string user, string pw, IFromSpeaker hostapi)
Function ConnectLocal(hostname As String, instance As String, ipaddr As String, user As String, pw As String, hostapi As IFromSpeaker) As String
Parameters
| Type |
Name |
Description |
| System.String |
hostname |
|
| System.String |
instance |
|
| System.String |
ipaddr |
|
| System.String |
user |
|
| System.String |
pw |
|
| IFromSpeaker |
hostapi |
|
Returns
| Type |
Description |
| System.String |
|
View Source
CreateGrammar(String, String, String, String, String, String)
Declaration
string CreateGrammar(string host, string instance, string AttentionWord, string YesWord, string NoWord, string IgnoreWord)
Function CreateGrammar(host As String, instance As String, AttentionWord As String, YesWord As String, NoWord As String, IgnoreWord As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
| System.String |
AttentionWord |
|
| System.String |
YesWord |
|
| System.String |
NoWord |
|
| System.String |
IgnoreWord |
|
Returns
| Type |
Description |
| System.String |
|
View Source
DisconnectLocal(Int64)
Declaration
void DisconnectLocal(long client_id)
Sub DisconnectLocal(client_id As Long)
Parameters
| Type |
Name |
Description |
| System.Int64 |
client_id |
|
View Source
Declaration
string GetAttentionMenu(string host, string instance)
Function GetAttentionMenu(host As String, instance As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
Returns
| Type |
Description |
| System.String |
|
View Source
GetCommandMenu(String, String)
Declaration
string GetCommandMenu(string host, string instance)
Function GetCommandMenu(host As String, instance As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
Returns
| Type |
Description |
| System.String |
|
View Source
GetFileDate(String)
Declaration
DateTime GetFileDate(string fname)
Function GetFileDate(fname As String) As Date
Parameters
| Type |
Name |
Description |
| System.String |
fname |
|
Returns
| Type |
Description |
| System.DateTime |
|
View Source
GetFilePart(String, Int32, Int32)
Declaration
string GetFilePart(string fname, int start, int fsize)
Function GetFilePart(fname As String, start As Integer, fsize As Integer) As String
Parameters
| Type |
Name |
Description |
| System.String |
fname |
|
| System.Int32 |
start |
|
| System.Int32 |
fsize |
|
Returns
| Type |
Description |
| System.String |
|
View Source
GetHostsList(String)
Declaration
Collection<object> GetHostsList(string host_instance)
Function GetHostsList(host_instance As String) As Collection(Of Object)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Collections.ObjectModel.Collection<System.Object> |
|
View Source
GetListenMode(String)
Declaration
int GetListenMode(string host_instance)
Function GetListenMode(host_instance As String) As Integer
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
GetListenStatus(String)
Declaration
bool GetListenStatus(string host_instance)
Function GetListenStatus(host_instance As String) As Boolean
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Boolean |
|
View Source
GetMuteStatus(String)
Declaration
bool GetMuteStatus(string host_instance)
Function GetMuteStatus(host_instance As String) As Boolean
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Boolean |
|
View Source
GetPauseStatus(String)
Declaration
int GetPauseStatus(string host_instance)
Function GetPauseStatus(host_instance As String) As Integer
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
GetRemoteHost(String, String)
Declaration
Collection<object> GetRemoteHost(string host, string instance)
Function GetRemoteHost(host As String, instance As String) As Collection(Of Object)
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
Returns
| Type |
Description |
| System.Collections.ObjectModel.Collection<System.Object> |
|
View Source
GetTestNumber()
Declaration
Function GetTestNumber As Integer
Returns
| Type |
Description |
| System.Int32 |
|
View Source
GetVoiceName(String)
Declaration
string GetVoiceName(string host_instance)
Function GetVoiceName(host_instance As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.String |
|
View Source
GetVolume(String)
Declaration
int GetVolume(string host_instance)
Function GetVolume(host_instance As String) As Integer
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
IsHostConnected(String, String)
Declaration
bool IsHostConnected(string host, string instance)
Function IsHostConnected(host As String, instance As String) As Boolean
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
Returns
| Type |
Description |
| System.Boolean |
|
View Source
IsSpeaking(String)
Declaration
bool IsSpeaking(string host)
Function IsSpeaking(host As String) As Boolean
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
Returns
| Type |
Description |
| System.Boolean |
|
View Source
Declaration
string MEDIAFunction(EMediaOperation operation, string p, string host_instance)
Function MEDIAFunction(operation As EMediaOperation, p As String, host_instance As String) As String
Parameters
| Type |
Name |
Description |
| EMediaOperation |
operation |
|
| System.String |
p |
|
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.String |
|
View Source
Declaration
void MEDIAPlay(string filename, string host_instance)
Sub MEDIAPlay(filename As String, host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
filename |
|
| System.String |
host_instance |
|
View Source
MuteAudio(String)
Declaration
void MuteAudio(string host_instance)
Sub MuteAudio(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
PauseAudio(String)
Declaration
void PauseAudio(string host_instance)
Sub PauseAudio(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
Recognize(String, String, Int32, String, String)
Declaration
string Recognize(string raw_phrase, string parsed_phrase, int id, string host, string instance)
Function Recognize(raw_phrase As String, parsed_phrase As String, id As Integer, host As String, instance As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
raw_phrase |
|
| System.String |
parsed_phrase |
|
| System.Int32 |
id |
|
| System.String |
host |
|
| System.String |
instance |
|
Returns
| Type |
Description |
| System.String |
|
View Source
RecognizeRaw(String, String, String)
Declaration
string RecognizeRaw(string phrase, string host, string instance)
Function RecognizeRaw(phrase As String, host As String, instance As String) As String
Parameters
| Type |
Name |
Description |
| System.String |
phrase |
|
| System.String |
host |
|
| System.String |
instance |
|
Returns
| Type |
Description |
| System.String |
|
View Source
RemoteHostsListCount()
Declaration
int RemoteHostsListCount()
Function RemoteHostsListCount As Integer
Returns
| Type |
Description |
| System.Int32 |
|
View Source
RemoveHost(String, String)
Declaration
void RemoveHost(string host, string instance)
Sub RemoveHost(host As String, instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
View Source
Reset_mDoIt(String, String)
Declaration
void Reset_mDoIt(string host, string instance)
Sub Reset_mDoIt(host As String, instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
View Source
SetAttentionPhrases(String, String, String, String, String, String)
Declaration
void SetAttentionPhrases(string attstr, string attackstr, string ignorestr, string ignoreackstr, string host, string instance)
Sub SetAttentionPhrases(attstr As String, attackstr As String, ignorestr As String, ignoreackstr As String, host As String, instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
attstr |
|
| System.String |
attackstr |
|
| System.String |
ignorestr |
|
| System.String |
ignoreackstr |
|
| System.String |
host |
|
| System.String |
instance |
|
View Source
SetLastVR(String, String, Int32, String, String)
Declaration
void SetLastVR(string raw_phrase, string parsed_phrase, int id, string host, string instance)
Sub SetLastVR(raw_phrase As String, parsed_phrase As String, id As Integer, host As String, instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
raw_phrase |
|
| System.String |
parsed_phrase |
|
| System.Int32 |
id |
|
| System.String |
host |
|
| System.String |
instance |
|
View Source
SetListenMode(Int32, String)
Declaration
int SetListenMode(int mode, string host_instance)
Function SetListenMode(mode As Integer, host_instance As String) As Integer
Parameters
| Type |
Name |
Description |
| System.Int32 |
mode |
|
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
SetSpeaker(String, String)
Declaration
void SetSpeaker(string speaker_name, string host_instance)
Sub SetSpeaker(speaker_name As String, host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
speaker_name |
|
| System.String |
host_instance |
|
View Source
SetSpeakingSpeed(Int32, String)
Declaration
int SetSpeakingSpeed(int speed, string host_instance)
Function SetSpeakingSpeed(speed As Integer, host_instance As String) As Integer
Parameters
| Type |
Name |
Description |
| System.Int32 |
speed |
|
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
SetVoice(String, String)
Declaration
int SetVoice(string voice, string host_instance)
Function SetVoice(voice As String, host_instance As String) As Integer
Parameters
| Type |
Name |
Description |
| System.String |
voice |
|
| System.String |
host_instance |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
SetVolume(Int32, String)
Declaration
void SetVolume(int vol, string host_instance)
Sub SetVolume(vol As Integer, host_instance As String)
Parameters
| Type |
Name |
Description |
| System.Int32 |
vol |
|
| System.String |
host_instance |
|
View Source
SetVRState(String, String)
Declaration
void SetVRState(string state, string host_instance)
Sub SetVRState(state As String, host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
state |
|
| System.String |
host_instance |
|
View Source
Speak(String, Boolean, String, Constants.speak_type_values, Boolean, Int32)
Declaration
Constants.speak_error_values Speak(string txt, bool wait, string host_Specified, Constants.speak_type_values mtype, bool showballoon, int fsize)
Function Speak(txt As String, wait As Boolean, host_Specified As String, mtype As Constants.speak_type_values, showballoon As Boolean, fsize As Integer) As Constants.speak_error_values
Parameters
| Type |
Name |
Description |
| System.String |
txt |
|
| System.Boolean |
wait |
|
| System.String |
host_Specified |
|
| Constants.speak_type_values |
mtype |
|
| System.Boolean |
showballoon |
|
| System.Int32 |
fsize |
|
Returns
View Source
SpeakDone(String, String)
Declaration
void SpeakDone(string host, string instance)
Sub SpeakDone(host As String, instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|
View Source
SpeakFromClient(String, String)
Declaration
void SpeakFromClient(string txt, string host)
Sub SpeakFromClient(txt As String, host As String)
Parameters
| Type |
Name |
Description |
| System.String |
txt |
|
| System.String |
host |
|
View Source
StartListening(String)
Declaration
void StartListening(string host_instance)
Sub StartListening(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
StopListening(String)
Declaration
void StopListening(string host_instance)
Sub StopListening(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
StopSpeaking(String)
Declaration
void StopSpeaking(string host_instance)
Sub StopSpeaking(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
UnMuteAudio(String)
Declaration
void UnMuteAudio(string host_instance)
Sub UnMuteAudio(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
UnPauseAudio(String)
Declaration
void UnPauseAudio(string host_instance)
Sub UnPauseAudio(host_instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host_instance |
|
View Source
version()
Declaration
Function version As Integer
Returns
| Type |
Description |
| System.Int32 |
|
View Source
VRChanged(RemoteHost)
Declaration
void VRChanged(RemoteHost rh)
Sub VRChanged(rh As RemoteHost)
Parameters
View Source
WaveDone(String, String)
Declaration
void WaveDone(string host, string instance)
Sub WaveDone(host As String, instance As String)
Parameters
| Type |
Name |
Description |
| System.String |
host |
|
| System.String |
instance |
|