Class AbstractSpeakerClient
public abstract class AbstractSpeakerClient : IFromSpeaker
Public MustInherit Class AbstractSpeakerClient
Implements IFromSpeaker
Inheritance
System.Object
AbstractSpeakerClient
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
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.
Constructors
View Source
AbstractSpeakerClient(String, String)
Declaration
public AbstractSpeakerClient(string pluginId, string name)
Public Sub New(pluginId As String, name As String)
Parameters
| Type |
Name |
Description |
| System.String |
pluginId |
|
| System.String |
name |
|
Fields
View Source
_client
Declaration
IScsServiceClient<ISpeechAPI> _client
_client As IScsServiceClient(Of ISpeechAPI)
Field Value
| Type |
Description |
| HSCF.Communication.ScsServices.Client.IScsServiceClient<ISpeechAPI> |
|
View Source
_password
Declaration
Field Value
| Type |
Description |
| System.String |
|
View Source
_username
Declaration
Field Value
| Type |
Description |
| System.String |
|
View Source
ClientName
Declaration
protected readonly string ClientName
Protected ReadOnly ClientName As String
Field Value
| Type |
Description |
| System.String |
|
View Source
HostName
Declaration
protected readonly string HostName
Protected ReadOnly HostName As String
Field Value
| Type |
Description |
| System.String |
|
View Source
SPEAKER_INTERFACE_VERSION
Declaration
protected const int SPEAKER_INTERFACE_VERSION = 10
Protected Const SPEAKER_INTERFACE_VERSION As Integer = 10
Field Value
| Type |
Description |
| System.Int32 |
|
View Source
SpeechHost
Declaration
protected ISpeechAPI SpeechHost
Protected SpeechHost As ISpeechAPI
Field Value
Properties
View Source
IpAddress
Declaration
protected string IpAddress { get; set; }
Protected Property IpAddress As String
Property Value
| Type |
Description |
| System.String |
|
Methods
View Source
Connect(Int32)
Declaration
void Connect(int attempts)
Sub Connect(attempts As Integer)
Parameters
| Type |
Name |
Description |
| System.Int32 |
attempts |
|
View Source
Connect(String, String)
Declaration
public void Connect(string username, string password)
Public Sub Connect(username As String, password As String)
Parameters
| Type |
Name |
Description |
| System.String |
username |
|
| System.String |
password |
|
View Source
Disconnect()
Declaration
Public Function Disconnect As Boolean
Returns
| Type |
Description |
| System.Boolean |
|
View Source
DisconnectNow()
Declaration
View Source
GetListenMode()
Declaration
public virtual int GetListenMode()
Public Overridable Function GetListenMode As Integer
Returns
| Type |
Description |
| System.Int32 |
|
View Source
GetListenStatus()
Declaration
public virtual bool GetListenStatus()
Public Overridable Function GetListenStatus As Boolean
Returns
| Type |
Description |
| System.Boolean |
|
View Source
GetMuteStatus()
Declaration
public virtual bool GetMuteStatus()
Public Overridable Function GetMuteStatus As Boolean
Returns
| Type |
Description |
| System.Boolean |
|
View Source
GetPauseStatus()
Declaration
public virtual short GetPauseStatus()
Public Overridable Function GetPauseStatus As Short
Returns
| Type |
Description |
| System.Int16 |
|
View Source
GetVoiceName()
Declaration
public virtual string GetVoiceName()
Public Overridable Function GetVoiceName As String
Returns
| Type |
Description |
| System.String |
|
View Source
GetVolume()
Declaration
public virtual int GetVolume()
Public Overridable Function GetVolume As Integer
Returns
| Type |
Description |
| System.Int32 |
|
View Source
IsBusy()
Declaration
public abstract bool IsBusy()
Public MustOverride Function IsBusy As Boolean
Returns
| Type |
Description |
| System.Boolean |
|
View Source
Declaration
public virtual string MEDIAFunction(EMediaOperation operation, string p)
Public Overridable Function MEDIAFunction(operation As EMediaOperation, p As String) As String
Parameters
Returns
| Type |
Description |
| System.String |
|
View Source
Declaration
public virtual int MEDIAPlay(string fileName, int fileSize)
Public Overridable Function MEDIAPlay(fileName As String, fileSize As Integer) As Integer
Parameters
| Type |
Name |
Description |
| System.String |
fileName |
|
| System.Int32 |
fileSize |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
MuteAudio()
Declaration
public virtual void MuteAudio()
Public Overridable Sub MuteAudio
View Source
OnClientConnect(Object, EventArgs)
Declaration
protected virtual void OnClientConnect(object sender, EventArgs e)
Protected Overridable Sub OnClientConnect(sender As Object, e As EventArgs)
Parameters
| Type |
Name |
Description |
| System.Object |
sender |
|
| System.EventArgs |
e |
|
View Source
OnClientDisconnect(Object, EventArgs)
Declaration
protected virtual void OnClientDisconnect(object sender, EventArgs e)
Protected Overridable Sub OnClientDisconnect(sender As Object, e As EventArgs)
Parameters
| Type |
Name |
Description |
| System.Object |
sender |
|
| System.EventArgs |
e |
|
View Source
PauseAudio()
Declaration
public virtual void PauseAudio()
Public Overridable Sub PauseAudio
View Source
PlayWaveFile(String, Int32)
Declaration
public abstract void PlayWaveFile(string fileName, int fileSize)
Public MustOverride Sub PlayWaveFile(fileName As String, fileSize As Integer)
Parameters
| Type |
Name |
Description |
| System.String |
fileName |
|
| System.Int32 |
fileSize |
|
View Source
SendMessage(String, Boolean)
Declaration
public virtual int SendMessage(string message, bool showBalloon)
Public Overridable 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
public virtual int SetListenMode(int mode)
Public Overridable Function SetListenMode(mode As Integer) As Integer
Parameters
| Type |
Name |
Description |
| System.Int32 |
mode |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
SetSpeaker(String)
Declaration
public virtual void SetSpeaker(string speakerName)
Public Overridable Sub SetSpeaker(speakerName As String)
Parameters
| Type |
Name |
Description |
| System.String |
speakerName |
|
View Source
SetSpeakingSpeed(Int32)
Declaration
public virtual int SetSpeakingSpeed(int speed)
Public Overridable Function SetSpeakingSpeed(speed As Integer) As Integer
Parameters
| Type |
Name |
Description |
| System.Int32 |
speed |
|
Returns
| Type |
Description |
| System.Int32 |
|
View Source
SetVoice(String)
Declaration
public virtual short SetVoice(string voice)
Public Overridable Function SetVoice(voice As String) As Short
Parameters
| Type |
Name |
Description |
| System.String |
voice |
|
Returns
| Type |
Description |
| System.Int16 |
|
View Source
SetVolume(Int32)
Declaration
public virtual void SetVolume(int vol)
Public Overridable Sub SetVolume(vol As Integer)
Parameters
| Type |
Name |
Description |
| System.Int32 |
vol |
|
View Source
SetVRState(String)
Declaration
public virtual void SetVRState(string state)
Public Overridable Sub SetVRState(state As String)
Parameters
| Type |
Name |
Description |
| System.String |
state |
|
View Source
SpeakText(String, Boolean)
Declaration
public abstract void SpeakText(string speakText, bool shouldWait)
Public MustOverride Sub SpeakText(speakText As String, shouldWait As Boolean)
Parameters
| Type |
Name |
Description |
| System.String |
speakText |
|
| System.Boolean |
shouldWait |
|
View Source
SpeakToFile(String, String, String)
Declaration
public virtual void SpeakToFile(string speakText, string fileName, string voice = "")
Public Overridable Sub SpeakToFile(speakText As String, fileName As String, voice As String = "")
Parameters
| Type |
Name |
Description |
| System.String |
speakText |
|
| System.String |
fileName |
|
| System.String |
voice |
|
View Source
StartListen()
Declaration
public abstract void StartListen()
Public MustOverride Sub StartListen
View Source
StopListen()
Declaration
public abstract void StopListen()
Public MustOverride Sub StopListen
View Source
StopSpeaking()
Declaration
public abstract void StopSpeaking()
Public MustOverride Sub StopSpeaking
View Source
UnMuteAudio()
Declaration
public virtual void UnMuteAudio()
Public Overridable Sub UnMuteAudio
View Source
UnPauseAudio()
Declaration
public virtual void UnPauseAudio()
Public Overridable Sub UnPauseAudio
View Source
VRChanged()
Declaration
public virtual void VRChanged()
Public Overridable Sub VRChanged
Implements