Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ListenBaseService

ListenBaseService Klasse

export

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 mListen

mListen: IListen = null

Private mListenAudioStartEvent

mListenAudioStartEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenAudioStopEvent

mListenAudioStopEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenInterimResultEvent

mListenInterimResultEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenNoMatchEvent

mListenNoMatchEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenRecognitionStartEvent

mListenRecognitionStartEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenRecognitionStopEvent

mListenRecognitionStopEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenResultEvent

mListenResultEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenSoundStartEvent

mListenSoundStartEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenSoundStopEvent

mListenSoundStopEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenSpeechStartEvent

mListenSpeechStartEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Private mListenSpeechStopEvent

mListenSpeechStopEvent: EventEmitter<any> = new EventEmitter<any>( LISTEN_ASYNC_EVENT )

Protected mServiceApiVersion

mServiceApiVersion: string = SERVICE_API_VERSION

Protected mServiceName

mServiceName: string = "Service"

Protected mServiceVersion

mServiceVersion: string = SERVICE_VERSION_STRING

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 listenServiceConfig

listenServiceConfig: IListenOption = ListenServiceConfig

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

asr

  • get asr(): string
  • set asr(aASRName: string): void

  • Eigenschaft ASR zurueckgeben.

    Returns string

    Name der ASR

  • Eigenschaft ASR eintragen fuer die Spracheingabe.

    Parameters

    • aASRName: string

      Name der ASR

    Returns void

    Name der ASR

asrs

  • get asrs(): Array<string>

  • Eigenschaft alle verfuegbaren ASR zurueckgeben

    Returns Array<string>

    Liste aller ASR zurueckgeben

audioStartEvent

  • Ereignis fuer Start Audio

    readonly

    Returns EventEmitter<any>

    listenAudioStartEvent

audioStopEvent

  • Ereignis fuer Stop Audio

    readonly

    Returns EventEmitter<any>

    listenAudioStopEvent

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

initEvent

  • Ereignis fuer Init

    readonly

    Returns EventEmitter<any>

    initEvent

interimResultEvent

  • Ereignis fuer Sprachausgabe erkannten Text

    readonly

    Returns EventEmitter<any>

    listenInterimResultEvent

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)

mode

  • get mode(): string
  • set mode(aModeName: string): void

  • Eigenschaft Modus zurueckgeben.

    Returns string

    aModeName - Name des Eingabemodus (Command, Dictate)

  • Eigenschaft Modus eintragen fuer die Spracheingabe.

    Parameters

    • aModeName: string

      Name des Eingabemodus (Command, Dictate)

    Returns void

    aModeName - Name des Eingabemodus (Command, Dictate)

modes

  • get modes(): Array<string>

  • Eigenschaft alle verfuegbaren Modi (Command, Dictate) zurueckgeben

    Returns Array<string>

    Liste Kurzform der Sprache zurueckgeben (de, en)

noMatchEvent

  • Ereignis fuer Sprachausgabe kein erkannter Text

    readonly

    Returns EventEmitter<any>

    listenInterimResultEvent

recognitionStartEvent

  • Ereignis fuer Start Recognition

    readonly

    Returns EventEmitter<any>

    listenRecognitionStartEvent

recognitionStopEvent

  • Ereignis fuer Stop Recognition

    readonly

    Returns EventEmitter<any>

    listenRecognitionStopEvent

resultEvent

  • Ereignis fuer Sprachausgabe erkannten Text

    readonly

    Returns EventEmitter<any>

    listenResultEvent

soundStartEvent

  • Ereignis fuer Start Sound

    readonly

    Returns EventEmitter<any>

    listenSoundStartEvent

soundStopEvent

  • Ereignis fuer Stop Sound

    readonly

    Returns EventEmitter<any>

    listenSoundStopEvent

speechStartEvent

  • Ereignis fuer Start Speech

    readonly

    Returns EventEmitter<any>

    listenSpeechStartEvent

speechStopEvent

  • Ereignis fuer Stop Speech

    readonly

    Returns EventEmitter<any>

    listenSpeechStopEvent

startEvent

  • Ereignis fuer Aktion gestartet

    readonly

    Returns EventEmitter<any>

    actionStartEvent

stopEvent

  • Ereignis fuer Aktion gestoppt

    readonly

    Returns EventEmitter<any>

    actionStopEvent

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: IListenOption): any

  • Hier wird die Komponente erzeugt.

    Parameters

    • aComponentName: string

      Name der zu erzeugenden Komponente

    • aOption: IListenOption

      optionale Parameter fuer die Initialisierung der Komponente

    Returns any

    Rueckgabe der Listen-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

abort

  • abort(): number

  • Spracheingabe abbrechen

    Returns number

    Fehlercode 0 oder -1

getASR

  • getASR(): string

  • Rueckgabe der eingestellten ASR

    Returns string

    eingestellte ASR

getASRList

  • getASRList(): Array<string>

  • Liste aller verfuegbaren ASRs zurueckgeben

    Returns Array<string>

    Liste der vorhandenen ASRs zurueckgeben oder leere Liste

getApiVersion

  • getApiVersion(): 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

getMode

  • getMode(): string

  • Rueckgabe des eingestellten Eingabemodus

    Returns string

    eingestellter Modus ('Command' oder 'Dictate')

getModeList

  • getModeList(): Array<string>

  • Liste aller verfuegbaren Eingabemodi (Command, Dictate) zurueckgeben

    Returns Array<string>

    Liste der Eingabemodi zurueckgeben (Command, Dictate) oder leere Liste

getName

  • getName(): string

getVersion

  • getVersion(): string

init

  • Initialisierung des Service

    Parameters

    • Optional aOption: IListenOption

      optionale Parameter zur Konfiguration des Service

    Returns number

    errorCode(0,-1)

isASR

  • isASR(): boolean

  • pruefen auf vorhandene ASR

    Returns boolean

isActive

  • isActive(): boolean

isCommandMode

  • isCommandMode(): boolean

  • pruefen ob Eingabemodus Command fuer die Spracheingabe eingestellt ist

    Returns boolean

    True, wenn Command Modus eingestellt ist, sonst False

isDictateMode

  • isDictateMode(): boolean

  • pruefen ob Eingabemodus Dictate fuer die Spracheingabe eingestellt ist

    Returns boolean

    True, wenn Dictate Modus eingestellt ist, sonst False

isErrorOutput

  • isErrorOutput(): boolean

isInit

  • isInit(): boolean

  • pruefen auf initialisierten Service

    Returns boolean

    Rueckgabe, ob Service initialisiert ist

isMode

  • isMode(aMode: string): boolean

  • Eingabemodus fuer die Spracheingabe pruefen

    Parameters

    • aMode: string

      einzustellender Modus ('Command' oder 'Dictate')

    Returns boolean

    True, wenn uebergebener Mode gueltig ist, sonst False

isRunning

  • isRunning(): boolean

reset

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

    Parameters

    • Optional aOption: IListenOption

      optionale Parameter zur Konfiguration des Service

    Returns number

    Fehlercode 0 oder -1

setASR

  • setASR(aASRName: string): number

  • ASR fuer die Spracheingabe einstellen

    Parameters

    • aASRName: string

      einzustellende TTS

    Returns number

    Fehlercode 0 oder -1

setActiveOff

  • setActiveOff(): number

setActiveOn

  • setActiveOn(): number

setErrorOutputOff

  • setErrorOutputOff(): void

setErrorOutputOn

  • setErrorOutputOn(): void

setLanguage

  • setLanguage(aLanguage: string): number

  • Sprache fuer die Spracheingabe einstellen

    Parameters

    • aLanguage: string

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

    Returns number

    Fehlercode 0 oder -1

setMode

  • setMode(aMode: string): number

  • Eingabemodus fuer die Spracheingabe einstellen

    Parameters

    • aMode: string

      einzustellender Modus ('Command' oder 'Dictate')

    Returns number

    Fehlercode 0 oder -1

setTimeout

  • setTimeout(aTimeout: number): number

  • Timeout fuer die Spracheingabe einstellen

    Parameters

    • aTimeout: number

      einzustellender Timeout in Millisekunden

    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 }

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 IListenOption

    ListenBaseServiceOptions - 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