Package org.openhab.core.voice

Class DialogRegistration

java.lang.Object

org.openhab.core.voice.DialogRegistration

@NonNullByDefault
public class DialogRegistration
extends Object

Describes dialog desired services and options.

Author:

Miguel Álvarez - Initial contribution

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable String	dialogGroup	Dialog group name
List<String>	hliIds	List of interpreters
@Nullable String	keyword	Selected keyword for spotting
@Nullable String	ksId	Preferred keyword-spotting service
@Nullable String	listeningItem	Linked listening item
@Nullable String	listeningMelody	Custom listening melody
@Nullable Locale	locale	Dialog locale
@Nullable String	locationItem	Linked location item
boolean	running	True if an associated dialog is running
String	sinkId	Dialog audio sink id
String	sourceId	Dialog audio source id
@Nullable String	sttId	Preferred speech-to-text service id
@Nullable String	ttsId	Preferred text-to-speech service id
@Nullable String	voiceId	Preferred voice id

Constructor Summary

Constructors

Constructor	Description
DialogRegistration(String sourceId, String sinkId)

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

sourceId

public String sourceId

Dialog audio source id

sinkId

public String sinkId

Dialog audio sink id

ksId

public @Nullable String ksId

Preferred keyword-spotting service

keyword

public @Nullable String keyword

Selected keyword for spotting

sttId

public @Nullable String sttId

Preferred speech-to-text service id

ttsId

public @Nullable String ttsId

Preferred text-to-speech service id

voiceId

public @Nullable String voiceId

Preferred voice id

hliIds

public List<String> hliIds

List of interpreters

locale

public @Nullable Locale locale

Dialog locale

listeningItem

public @Nullable String listeningItem

Linked listening item

locationItem

public @Nullable String locationItem

Linked location item

dialogGroup

public @Nullable String dialogGroup

Dialog group name

listeningMelody

public @Nullable String listeningMelody

Custom listening melody

running

public boolean running

True if an associated dialog is running

Constructor Details

DialogRegistration

public DialogRegistration(String sourceId,
 String sinkId)