Package org.openhab.core.voice.dialog.trigger.ks

Interface KSService

All Superinterfaces:

DTService

@NonNullByDefault
public interface KSService
extends DTService

This is the interface that a keyword spotting service has to implement.

Author:

Kelly Davis - Initial contribution, Kai Kreuzer - Refactored to use AudioStream

Method Summary

Modifier and Type	Method	Description
Set<AudioFormat>	getSupportedFormats()	Get the audio formats supported by this KSService
Set<Locale>	getSupportedLocales()	Get the Locales available from this KSService
KSServiceHandle	spot(KSListener ksListener, AudioStream audioStream, Locale locale, String keyword)	This method starts the process of keyword spotting

Methods inherited from interface org.openhab.core.voice.dialog.trigger.DTService

getId, getLabel

Method Details

getSupportedLocales

Set<Locale> getSupportedLocales()

Get the Locales available from this KSService

Returns:

The Locales available from this service

getSupportedFormats

Set<AudioFormat> getSupportedFormats()

Get the audio formats supported by this KSService

Returns:

The audio formats supported by this service

spot

KSServiceHandle spot(KSListener ksListener,
 AudioStream audioStream,
 Locale locale,
 String keyword)
              throws KSException

This method starts the process of keyword spotting

The audio data of the passed AudioStream is passed to the keyword spotting engine. The keyword spotting attempts to spot keyword as being spoken in the passed Locale. Spotted keyword is indicated by fired KSEvent events targeting the passed KSListener.

The passed AudioStream must be of a supported AudioFormat. In other words an AudioFormat compatible with one returned from the getSupportedFormats() method.

The passed Locale must be supported. That is to say it must be a Locale returned from the getSupportedLocales() method.

The passed keyword is the keyword which should be spotted.

Parameters:

ksListener - Non-null KSListener that KSEvent events target

audioStream - The AudioStream from which keywords are spotted

locale - The Locale in which the target keywords are spoken

keyword - The keyword to spot

Returns:

A KSServiceHandle used to abort keyword spotting

Throws:

KSException - if any parameter is invalid or a problem occurs

Implementation note:

The method is supposed to return fast, i.e., it should only start the spotting as a background process.