Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpeakService

export

SpeakService Klasse

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected mComponentName

mComponentName: string = ""

Protected mErrorEvent

mErrorEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Protected mErrorOutputFlag

mErrorOutputFlag: boolean = SERVICE_ERROR_OUTPUT

Fehlerausgabe fuer Konsole festlegen

Protected mInitEvent

mInitEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Protected mServiceApiVersion

mServiceApiVersion: string = SERVICE_API_VERSION

Protected mServiceName

mServiceName: string = "Service"

Protected mServiceVersion

mServiceVersion: string = SERVICE_VERSION_STRING

Protected mSpeak

mSpeak: ISpeak = null

Private mSpeakAudioUnlockEvent

mSpeakAudioUnlockEvent: EventEmitter<boolean> = new EventEmitter<boolean>( SPEAK_ASYNC_EVENT )

Protected mStartEvent

mStartEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Protected mStopEvent

mStopEvent: EventEmitter<any> = new EventEmitter<any>( SERVICE_ASYNC_EVENT )

Static Private constructorInitFlag

constructorInitFlag: boolean = true

legt fest, ob die Initialisierung im Konstruktor bereits erfolgt

Static Private speakServiceConfig

speakServiceConfig: ISpeakOption = SpeakServiceConfig

definiert die Konfiguration des Service

Accessors

active

  • get active(): boolean
  • set active(aActiveFlag: boolean): void

  • Eigenschaft aktive Komponente zurueckgeben

    readonly

    Returns boolean

    aActiveFlag - True, wenn aktive, False sonst

  • Eigenschaft aktive Komponente setzen

    Parameters

    • aActiveFlag: boolean

      True, wenn aktive, False sonst

    Returns void

    aActiveFlag - True, wenn aktive, False sonst

audio

  • get audio(): boolean
  • set audio(aActionFlag: boolean): void

  • Eigenschaft Audio zurueckgeben.

    readonly

    Returns boolean

  • Eigenschaft Audio setzen. Wenn Audio eingeschaltet ist, wird eine Audiodatei fuer Speak abgespielt.

    Parameters

    • aActionFlag: boolean

    Returns void

audioUnlockEvent

  • Ereignis fuer Audio-Unlock

    readonly

    Returns EventEmitter<boolean>

    audioUnlockEvent

errorEvent

  • Ereignis fuer Fehler aufgetreten

    readonly

    Returns EventEmitter<any>

    errorEvent

errorOutput

  • get errorOutput(): boolean
  • set errorOutput(aErrorOutputFlag: boolean): void

  • Eigenschaft fuer Konsolenausgabe zurueckgeben

    readonly

    Returns boolean

    aErrorOutputFlag - True, wenn Konsolenausgabe erfolgen soll, False sonst

  • Eigenschaft fuer Fehlerausgabe auf der Konsole setzen

    Parameters

    • aErrorOutputFlag: boolean

      True, wenn Konsolenausgabe erfolgen soll, False sonst

    Returns void

    aErrorOutputFlag - True, wenn Konsolenausgabe erfolgen soll, False sonst

file

  • get file(): string
  • set file(aFileName: string): void

  • Eigenschaft File fuer die aktuelle Audiodatei zurueckgeben.

    Returns string

    aFileName - Name der aktuellen Audiodatei

  • Eigenschaft File eintragen fuer die aktuelle Audiodatei.

    Parameters

    • aFileName: string

      Name der Audiodatei

    Returns void

    aFileName - Name der aktuellen Audiodatei

format

  • get format(): string
  • set format(aFormat: string): void

  • Eigenschaft Format zurueckgeben

    readonly

    Returns string

    aFormat - Audioformat fuer alle Audiodateien

  • Eigenschaft Format eintragen fuer das Audiodateienformat.

    Parameters

    • aFormat: string

      Format fuer die Audiodateien

    Returns void

    aFormat - Audioformat fuer alle Audiodateien

initEvent

  • Ereignis fuer Init

    readonly

    Returns EventEmitter<any>

    initEvent

language

  • get language(): string
  • set language(aLanguageName: string): void

  • Eigenschaft Language zurueckgeben.

    Returns string

    aLanguageName - Name der Sprache in Kurzform (de, en)

  • Eigenschaft Language eintragen fuer die Sprachausgabe.

    Parameters

    • aLanguageName: string

      Name der Sprache in Kurzform (de, en)

    Returns void

    aLanguageName - Name der Sprache in Kurzform (de, en)

languages

  • get languages(): Array<string>

  • Eigenschaft alle verfuegbaren Sprachen (de, en) zurueckgeben

    Returns Array<string>

    Liste Kurzform der Sprache zurueckgeben (de, en)

path

  • get path(): string
  • set path(aPath: string): void

  • Eigenschaft Path zurueckgeben

    readonly

    Returns string

    aPath - Audioverzeichnis fuer alle Audiodateien

  • Eigenschaft Path eintragen fuer das Audiodateienverzeichnis.

    Parameters

    • aPath: string

      lokales Verzeichnis zu den Audiodateien

    Returns void

    aPath - Audioverzeichnis fuer alle Audiodateien

startEvent

  • Ereignis fuer Aktion gestartet

    readonly

    Returns EventEmitter<any>

    actionStartEvent

stopEvent

  • Ereignis fuer Aktion gestoppt

    readonly

    Returns EventEmitter<any>

    actionStopEvent

text

  • get text(): string
  • set text(aText: string): void

  • Eigenschaft Text zurueckgeben.

    Returns string

    aText - Text fuer die Sprachausgabe

  • Eigenschaft Text eintragen fuer die Sprachausgabe.

    Parameters

    • aText: string

      Text fuer die Sprachausgabe

    Returns void

    aText - Text fuer die Sprachausgabe

tts

  • get tts(): string
  • set tts(aTTSName: string): void

  • Eigenschaft TTS zurueckgeben.

    Returns string

    Name der TTS

  • Eigenschaft TTS eintragen fuer die Sprachausgabe.

    Parameters

    • aTTSName: string

      Name der TTS

    Returns void

    Name der TTS

ttses

  • get ttses(): Array<string>

  • Eigenschaft alle verfuegbaren TTS zurueckgeben

    Returns Array<string>

    Liste aller TTS zurueckgeben

voice

  • get voice(): string
  • set voice(aVoiceName: string): void

  • Eigenschaft Stimme zurueckgeben.

    Returns string

    Name der Stimme

  • Eigenschaft Stimme eintragen fuer die Sprachausgabe.

    Parameters

    • aVoiceName: string

      Name der Stimme

    Returns void

    Name der Stimme

voices

  • get voices(): Array<string>

  • Eigenschaft alle verfuegbaren Stimmen

    Returns Array<string>

    Liste aller Stimmen

Methods

Protected _addAllEvent

  • _addAllEvent(aServiceName: string): number

  • Anbindung der Events

    Parameters

    • aServiceName: string

      Name des Services

    Returns number

    Fehlercode 0 oder -1

Protected _createComponent

  • _createComponent(aComponentName: string, aOption: any): any

  • Hier wird die Komponente erzeugt.

    Parameters

    • aComponentName: string

      Name der zu erzeugenden Komponente

    • aOption: any

      optionale Parameter fuer die Initialisierung der Komponente

    Returns any

    Rueckgabe der Speak-Instanz

Protected _error

  • _error(aFuncName: string, aErrorText: string): void

  • Ausgabe eines Fehlers

    Parameters

    • aFuncName: string

      Name der Funktion, wo der Fehler auftrat

    • aErrorText: string

      Fehlertext

    Returns void

Protected _exception

  • _exception(aFuncName: string, aException: any): void

  • Ausgabe einer Exception

    Parameters

    • aFuncName: string

      Name der Funktion, in der die Exception auftrat

    • aException: any

      Exception-Objekt

    Returns void

Private _setOption

  • Optionen eintragen

    Parameters

    Returns number

getApiVersion

  • getApiVersion(): string

getAudioFileName

  • getAudioFileName(): string

  • Rueckgabe des aktuell eingestellten Audiodateinamens

    Returns string

    Verzeichnis

getAudioFilePath

  • getAudioFilePath(): string

  • Rueckgabe des aktuell eingestellten Audioverzeichnisses

    Returns string

    Verzeichnis

getAudioFormat

  • getAudioFormat(): string

  • Rueckgabe des aktuell eingestellten Audioformats

    Returns string

getComponentName

  • getComponentName(): string

getLanguage

  • getLanguage(): string

  • Rueckgabe der eingestellten Sprache

    Returns string

    eingestellte Sprache als Kurzstring ('de' oder 'en')

getLanguageList

  • getLanguageList(): Array<string>

  • Liste aller verfuegbaren Sprachen (de, en) zurueckgeben

    Returns Array<string>

    Liste Kurzform der Sprache zurueckgeben (de, en) oder leere Liste

getName

  • getName(): string

getTTS

  • getTTS(): string

  • Rueckgabe der eingestellten TTS

    Returns string

    eingestellte TTS

getTTSList

  • getTTSList(): Array<string>

  • Liste aller verfuegbaren TTS zurueckgeben

    Returns Array<string>

    Liste der vorhandenen TTS zurueckgeben oder leere Liste

getText

  • getText(): string

  • Rueckgabe des aktuell eingestellten Speaktextes

    Returns string

    Text

getVersion

  • getVersion(): string

getVoice

  • getVoice(): string

  • Rueckgabe der eingestellten Stimme

    Returns string

    eingestellte Stimme

getVoiceList

  • getVoiceList(): Array<string>

  • Liste aller verfuegbaren Stimmen zurueckgeben

    Returns Array<string>

    Liste aller Stimmen

init

  • Initialisierung des Service

    Parameters

    • Optional aOption: ISpeakOption

      optionale Parameter zur Konfiguration des Service

    Returns number

    Fehlercode 0 oder -1

isActive

  • isActive(): boolean

isAudio

  • isAudio(): boolean

  • pruefen, ob Audio fuer Sprachausgabe eingestellt ist

    Returns boolean

    audioFlag - true, es wird zur Sprachausgabe eine Audiodatei abgespielt

isErrorOutput

  • isErrorOutput(): boolean

isInit

  • isInit(): boolean

  • pruefen auf initialisierten Service

    Returns boolean

    Rueckgabe, ob Service initialisiert ist

isRunning

  • isRunning(): boolean

isTTS

  • isTTS(): boolean

  • pruefen, ob TTS vorhanden ist

    Returns boolean

isUnlockAudio

  • isUnlockAudio(): boolean

  • pruefen auf entsperrten AudioContext

    Returns boolean

reset

  • Ruecksetzen des Services, alle Werte werden auf ihre Defaultwerte gesetzt

    Parameters

    • Optional aOption: ISpeakOption

      optionale Parameter zur Konfiguration des Service

    Returns number

    Fehlercode 0 oder -1

setActiveOff

  • setActiveOff(): number

setActiveOn

  • setActiveOn(): number

setAudioFileName

  • setAudioFileName(aFileName: string): number

  • Eintragen des Audiodateinamens

    Parameters

    • aFileName: string

      Name der Audiodatei (ohne Formatextension)

    Returns number

    Fehlercode 0 oder -1

setAudioFilePath

  • setAudioFilePath(aFilePath: string): number

  • Eintragen des Audiodateiverzeichnisses

    Parameters

    • aFilePath: string

      Name des Audioverzeichnisses

    Returns number

    Fehlercode 0 oder -1

setAudioFormat

  • setAudioFormat(aAudioFormat: string): number

  • Eintragen des Audioformats fuer die Audiodateien (mp3, wav)

    Parameters

    • aAudioFormat: string

      Name des Formats eintragen ('mp3', 'wav')

    Returns number

    Fehlercode 0 oder -1

setAudioOff

  • setAudioOff(): number

  • Audio fuer Sprachausgabe ausschalten

    Returns number

    Fehlercode 0 oder -1

setAudioOn

  • setAudioOn(): number

  • Audio fuer Sprachausgabe einschalten

    Returns number

    Fehlercode 0 oder -1

setErrorOutputOff

  • setErrorOutputOff(): void

setErrorOutputOn

  • setErrorOutputOn(): void

setLanguage

  • setLanguage(aLanguage: string): number

  • Sprache fuer die Sprachausgabe einstellen

    Parameters

    • aLanguage: string

      einzustellende Sprache als Kurzname ('de' oder 'en')

    Returns number

    Fehlercode 0 oder -1

setTTS

  • setTTS(aTTSName: string): number

  • TTS fuer die Sprachausgabe einstellen

    Parameters

    • aTTSName: string

      einzustellende TTS

    Returns number

    Fehlercode 0 oder -1

setText

  • setText(aText: string): number

  • Eintragen des Speaktextes

    Parameters

    • aText: string

      Text fuer die Sprachausgabe

    Returns number

    Fehlercode 0 oder -1

setVoice

  • setVoice(aVoice: string): number

  • Stimme fuer die Sprachausgabe einstellen

    Parameters

    • aVoice: string

      einzustellende Stimme

    Returns number

    Fehlercode 0 oder -1

start

  • start(): number

  • Aktion starten. Vorher muessen die Aktionsdaten eingetragen sein.

    Returns number

    Fehlercode 0 oder -1

stop

  • stop(): number

  • Aktion stoppen.

    Returns number

    Fehlercode 0 oder -1

test

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

  • Testfunktionen aufrufen

    Parameters

    • aTestCommand: string

      Name des Testbefehls

    • Optional aTestData: any

      optionale Daten fuer den Test

    Returns any

    Rueckgabe der Testergebnisse { result: 0 }

unlockAudio

  • unlockAudio(): number

  • AudioContext entsperren

    deprecated

    Returns number

Static getConfig

  • Rueckgabe der Konfiguration fuer den Service, um die Konfiguration zu veraendern. Muss vor der Erzeugung des Service aufgerufen werden. Wird nur im Zusammenhang mit dem gesetzten ConstructorInitFlag verwendet, welches die Initialisierung des Service im Konstruktor vornimmt. Bei manuellem Aufruf von Init kann diese Funktion zur Uebergabe der Optionen verwendet werden.

    static

    Returns ISpeakOption

    SpeakServiceOptions - dient zur Einstellung der otionalen Parameter

Static isConstructorInit

  • isConstructorInit(): boolean

  • pruefen auf ConstructorInitFlag fuer Festlegung, ob der Konstructor init aufruft.

    static

    Returns boolean

    ConstructorInitFlag - True, Konstructor initialisiert den Service, False sonst

Static setConstructorInitOff

  • setConstructorInitOff(): void

  • loescht das ConstructorInitFlag, um init nicht im Konstruktor aufzurufen.

    static

    Returns void

Static setConstructorInitOn

  • setConstructorInitOn(): void

  • setzen des ConstructorInitFlag auf true, um init im Konstruktor aufzurufen.

    static

    Returns void

Generated using TypeDoc