Interface SpeakInterface

export: Speak Schnittstelle

Hierarchy

BaseInterface
- SpeakInterface

Index

Methods

Methods

addAudioUnlockEvent

addAudioUnlockEvent(aPluginName: string, aEventFunc: OnSpeakAudioUnlockFunc): number

- Defined in src/speak/speak.interface.ts:54
Eintragen eines Audio-Unlock Events. Hier wird der AudioContext-Zustand zurueckgegeben.

Parameters
- aPluginName: string
  
  Name des Plugins
- aEventFunc: OnSpeakAudioUnlockFunc
  
  Ereignis-Behandlungsfunktion
Returns number

Fehlercode 0 oder -1

addErrorEvent

addErrorEvent(aPluginName: string, aEventFunc: OnSpeechErrorFunc): number

Inherited from BaseInterface.addErrorEvent
- Defined in src/base/base.interface.ts:188
Anmelden einer Ereignis Callback-Funktion fuer die Fehler der Aktion

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
- aEventFunc: OnSpeechErrorFunc
  
  Ereignis Callback Funktion
Returns number

Fehlercode 0 oder -1

addInitEvent

addInitEvent(aPluginName: string, aEventFunc: OnSpeechInitFunc): number

Inherited from BaseInterface.addInitEvent
- Defined in src/base/base.interface.ts:152
Anmelden einer Ereignis Callback-Funktion fuer die Initialisierung

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
- aEventFunc: OnSpeechInitFunc
  
  Ereignis Callback Funktion
Returns number

Fehlercode 0 oder -1

addStartEvent

addStartEvent(aPluginName: string, aEventFunc: OnBaseStartFunc): number

Inherited from BaseInterface.addStartEvent
- Defined in src/base/base.interface.ts:164
Anmelden einer Ereignis Callback-Funktion fuer den Start der Aktion

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
- aEventFunc: OnBaseStartFunc
  
  Ereignis Callback Funktion
Returns number

Fehlercode 0 oder -1

addStopEvent

addStopEvent(aPluginName: string, aEventFunc: OnBaseStopFunc): number

Inherited from BaseInterface.addStopEvent
- Defined in src/base/base.interface.ts:176
Anmelden einer Ereignis Callback-Funktion fuer den Stop der Aktion

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
- aEventFunc: OnBaseStopFunc
  
  Ereignis Callback Funktion
Returns number

Fehlercode 0 oder -1

getAudioContext

getAudioContext(): AudioContext

- Defined in src/speak/speak.interface.ts:120
Rueckgabe des globalen Audiokontext der App.

Returns AudioContext

Gibt den globalen HTML5-Audiokontext zurueck

getAudioFileName

getAudioFileName(): string

- Defined in src/speak/speak.interface.ts:180
Aktuellen Audiodateinamen zurueckgeben

Returns string

Rueckgabe des Dateinamens

getAudioFilePath

getAudioFilePath(): string

- Defined in src/speak/speak.interface.ts:160
Aktuelles Audiodateiverzeichnis zurueckgeben

Returns string

Rueckgabe des Verzeichnisses

getAudioFormat

getAudioFormat(): string

- Defined in src/speak/speak.interface.ts:140
Rueckgabe des aktuell eingestellten Audioformats.

Returns string

gibt MP3 oder WAV zurueck

getLanguage

getLanguage(): string

- Defined in src/speak/speak.interface.ts:244
aktuell eingestellte Sprache zurueckgeben

Returns string

language - Kurzzeichenstring fuer Sprache ( de, en )

getLanguageList

getLanguageList(): Array<string>

- Defined in src/speak/speak.interface.ts:253
Rueckgabe aller vorhandenen Language-Namen

Returns Array<string>

Liste der Language-Namen

getName

getName(): string

Inherited from BaseInterface.getName
- Defined in src/base/base.interface.ts:69
Name der konkreten Komponente zurueckgeben

Returns string

componentName

getServerVersion

getServerVersion(): string

Inherited from BaseInterface.getServerVersion
- Defined in src/base/base.interface.ts:87
Server-Version der Komponente zurueckgeben

Returns string

componentVersion

getSpeakText

getSpeakText(): string

- Defined in src/speak/speak.interface.ts:308
Rueckgabe des aktuell zu sprechenden Textes

Returns string

zu sprechender Text

getTTS

getTTS(): string

- Defined in src/speak/speak.interface.ts:212
Rueckgabe des eingestellten TTS-Namens

Returns string

Name der aktuellen TTS

getTTSList

getTTSList(): Array<string>

- Defined in src/speak/speak.interface.ts:221
Rueckgabe aller vorhandenen TTS-Namen

Returns Array<string>

Liste der TTS-Namen

getType

getType(): string

Inherited from BaseInterface.getType
- Defined in src/base/base.interface.ts:60
Typ des Komponenten-Interfaces zurueckgeben

Returns string

typeName

getVersion

getVersion(): string

Inherited from BaseInterface.getVersion
- Defined in src/base/base.interface.ts:78
Version der Komponente zurueckgeben

Returns string

componentVersion

getVoice

getVoice(): string

- Defined in src/speak/speak.interface.ts:276
aktuell eingestellte Stimme zurueckgeben

Returns string

Rueckgabe fuer Name der Stimme

getVoiceList

getVoiceList(): Array<string>

- Defined in src/speak/speak.interface.ts:285
Rueckgabe aller vorhandenen Voice-Namen

Returns Array<string>

Liste der Voice-Namen

isActive

isActive(): boolean

Inherited from BaseInterface.isActive
- Defined in src/base/base.interface.ts:96
pruefen auf aktive Komponente

Returns boolean

activeFlag

isAudio

isAudio(): boolean

- Defined in src/speak/speak.interface.ts:93
Prueft, ob Audioausgabe oder Sprachsynthese eingeschaltet ist

Returns boolean

True, Audioausgabe eingeschaltet, False die Sprachsynthese ist eingeschaltet

isErrorOutput

isErrorOutput(): boolean

Inherited from BaseInterface.isErrorOutput
- Defined in src/base/base.interface.ts:123
pruefen auf Fehlerausgabe auf die Konsole

Returns boolean

errorOutputFlag

isRunning

isRunning(): boolean

Inherited from BaseInterface.isRunning
- Defined in src/base/base.interface.ts:255
pruefen, ob Komponente gerade beschaeftigt ist

Returns boolean

True, Komponente ist beschaeftigt, False sonst

isTTS

isTTS(): boolean

- Defined in src/speak/speak.interface.ts:192
pruefen auf vorhandene TTS

Returns boolean

True, wenn TTS vorhanden ist, False sonst

isUnlockAudio

isUnlockAudio(): boolean

- Defined in src/speak/speak.interface.ts:84
pruefen auf entsperrten AudioContext

Returns boolean

removeAllEvent

removeAllEvent(aPluginName: string): number

Inherited from BaseInterface.removeAllEvent
- Defined in src/base/base.interface.ts:243
Entfernen aller angemeldeten Ereignisfunktionen

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
Returns number

Fehlercode 0 oder -1

removeAudioUnlockEvent

removeAudioUnlockEvent(aPluginName: string): number

- Defined in src/speak/speak.interface.ts:65
Enfernen eines Audio-Unlock Events.

Parameters
- aPluginName: string
  
  Name des Plugins
Returns number

Fehlercode 0 oder -1

removeErrorEvent

removeErrorEvent(aPluginName: string): number

Inherited from BaseInterface.removeErrorEvent
- Defined in src/base/base.interface.ts:232
Entfernen der Ereignisfunktion fuer die Fehler der Aktion

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
Returns number

Fehlercode 0 oder -1

removeInitEvent

removeInitEvent(aPluginName: string): number

Inherited from BaseInterface.removeInitEvent
- Defined in src/base/base.interface.ts:199
Entfernen der Ereignisfunktion fuer die Initialisierung

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
Returns number

Fehlercode 0 oder -1

removeStartEvent

removeStartEvent(aPluginName: string): number

Inherited from BaseInterface.removeStartEvent
- Defined in src/base/base.interface.ts:210
Entfernen der Ereignisfunktion fuer den Start der Aktion

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
Returns number

Fehlercode 0 oder -1

removeStopEvent

removeStopEvent(aPluginName: string): number

Inherited from BaseInterface.removeStopEvent
- Defined in src/base/base.interface.ts:221
Entfernen der Ereignisfunktion fuer den Stop der Aktion

Parameters
- aPluginName: string
  
  Name des Beobachter-Plugins
Returns number

Fehlercode 0 oder -1

reset

reset(aOption?: any): number

Inherited from BaseInterface.reset
- Defined in src/base/base.interface.ts:51
Komponente auf initialen Zustand zuruecksetzen

Parameters
- Optional aOption: any
  
  optionale Parameter
Returns number

setActiveOff

setActiveOff(): number

Inherited from BaseInterface.setActiveOff
- Defined in src/base/base.interface.ts:114
Komponente daktivieren

Returns number

Fehlercode oder -1

setActiveOn

setActiveOn(): number

Inherited from BaseInterface.setActiveOn
- Defined in src/base/base.interface.ts:105
Komponente aktivieren

Returns number

Fehercode 0 oder -1

setAudioFileName

setAudioFileName(aAudioFileName: string): number

- Defined in src/speak/speak.interface.ts:171
Aktuellen Audiodateinamen ohne Formatangabe eintragen.

Parameters
- aAudioFileName: string
Returns number

Fehlercode 0 oder -1

setAudioFilePath

setAudioFilePath(aAudioFilePath: string): number

- Defined in src/speak/speak.interface.ts:151
Aktuelles Audiodateiverzeichnis eintragen.

Parameters
- aAudioFilePath: string
Returns number

Fehlercode 0 oder -1

setAudioFormat

setAudioFormat(aAudioFormat: string): number

- Defined in src/speak/speak.interface.ts:131
Eintragen des Audioformats (AUDIO_MP3_FORMAT, AUDIO_WAV_FORMAT)

Parameters
- aAudioFormat: string
  
  Name des Formates
Returns number

Fehlercode 0 oder -1

setAudioOff

setAudioOff(): number

- Defined in src/speak/speak.interface.ts:111
Audioausgabe abschalten, dann wird die Sprachsynthese fuer die Sprachausgabe benutzt.

Returns number

Fehlercode 0 oder -1

setAudioOn

setAudioOn(): number

- Defined in src/speak/speak.interface.ts:102
Audioausgabe einschalten, dann werden Audiodateien fuer die Sprachausgabe abgespielt.

Returns number

Fehlercode 0 oder -1

setErrorOutputOff

setErrorOutputOff(): void

Inherited from BaseInterface.setErrorOutputOff
- Defined in src/base/base.interface.ts:137
Fehlerausgabe auf Konsole ausschalten

Returns void

setErrorOutputOn

setErrorOutputOn(): void

Inherited from BaseInterface.setErrorOutputOn
- Defined in src/base/base.interface.ts:130
Fehlerausgabe auf Konsole einschalten

Returns void

setLanguage

setLanguage(aLanguage: string): number

- Defined in src/speak/speak.interface.ts:235
Aendern der Sprache

Parameters
- aLanguage: string
  
  Kurzzeichen fuer Sprache ( de, en )
Returns number

Fehlercode 0 oder -1

setSpeakText

setSpeakText(aText: string): number

- Defined in src/speak/speak.interface.ts:299
Eintragen des zu sprechenden Textes

Parameters
- aText: string
  
  zu sprechenden Text
Returns number

Fehlercode 0 oder -1

setTTS

setTTS(aTTSName: string): number

- Defined in src/speak/speak.interface.ts:203
Setzen der aktuellen TTS ueber ihren Namen

Parameters
- aTTSName: string
  
  Name der TTS
Returns number

Fehlercode 0 oder -1

setVoice

setVoice(aVoice: string): number

- Defined in src/speak/speak.interface.ts:267
Aendern der Stimme

Parameters
- aVoice: string
  
  Name fuer die Stimme
Returns number

Fehlercode 0 oder -1

start

start(): number

Inherited from BaseInterface.start
- Defined in src/base/base.interface.ts:264
Startet die Aufgabe.

Returns number

Fehlercode 0 oder -1

stop

stop(): number

Inherited from BaseInterface.stop
- Defined in src/base/base.interface.ts:273
Stoppt die Aufgabe

Returns number

Fehlercode 0 oder -1

test

test(aTestCommand: string, aTestData?: any): any

Inherited from BaseInterface.test
- Defined in src/base/base.interface.ts:288
Fuehrt Testkommandos aus, um interne Tests ablaufen lassen zu koennen

Parameters
- aTestCommand: string
  
  Testkommando
- Optional aTestData: any
  
  optionale Testdaten
Returns any

Rueckgabe der Testergebnisse

unlockAudio

unlockAudio(): number

- Defined in src/speak/speak.interface.ts:77
AudioContext entsperren

deprecated

Returns number

Generated using TypeDoc