Index (org.mechio.api.speech OSGi Bundle 1.0.1 API)

A B C D F G H O P R S V W

A

Activator - Class in org.mechio.api.speech.osgi
Activator() - Constructor for class org.mechio.api.speech.osgi.Activator
addBinding(VisemeBinding) - Method in class org.mechio.api.speech.viseme.VisemeBindingManager: Adds a VisemeBinding to this Manager.
addListener(Listener<VisemeEvent>) - Method in class org.mechio.api.speech.viseme.VisemeEventNotifier: Adds a VisemeEvent listener to be notified.
addRequestListener(Listener<SpeechRequest>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
addRequestListener(Listener<SpeechRequest>) - Method in interface org.mechio.api.speech.SpeechService: Adds a Listener to be notified when a speech request is made.
addSpeechEventListener(Listener<SpeechEventList<SpeechEvent>>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
addSpeechEventListener(Listener<SpeechEventList<SpeechEvent>>) - Method in interface org.mechio.api.speech.SpeechService: Adds a Listener to be notified when a speech event occurs.
addSpeechEventListener(Listener<SpeechEventList<SpeechEvent>>) - Method in class org.mechio.api.speech.utils.SpeechEventNotifier: Adds a SpeechEvent listener.

B

BOOKMARK - Static variable in interface org.mechio.api.speech.SpeechEvent
build(VisemeBindingManagerConfig) - Method in class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory
buildManager(VisemeBindingManagerConfig) - Static method in class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory: Creates a new VisemeBindingManager from the given configuration.
buildVisemeBinding(VisemeBindingConfig<VisemePosition>) - Static method in class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory: Creates a new VisemeBinding from the given configuration.

C

cancel() - Method in interface org.mechio.api.speech.SpeechJob
cancel() - Method in class org.mechio.api.speech.utils.DefaultSpeechJob: Stops the speech.
CANCELED - Static variable in class org.mechio.api.speech.utils.DefaultSpeechJob: The speech job has been canceled.
cancelSpeech() - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
cancelSpeech() - Method in interface org.mechio.api.speech.SpeechService
clear() - Method in class org.mechio.api.speech.viseme.VisemeEventQueue
COMPLETE - Static variable in class org.mechio.api.speech.utils.DefaultSpeechJob: The robot has finished speaking.
create(Map<String, Object>) - Method in class org.mechio.api.speech.lifecycle.RemoteSpeechServiceClientLifecycle
create(Map<String, Object>) - Method in class org.mechio.api.speech.lifecycle.RemoteSpeechServiceHostLifecycle
create(String, String, String) - Method in interface org.mechio.api.speech.SpeechRequestFactory
create(String, String, String, double) - Method in interface org.mechio.api.speech.utils.SpeechConfigFactory
create(Map<String, Object>) - Method in class org.mechio.api.speech.viseme.lifecycle.VisemeBindingManagerLifecycle
create(Map<String, Object>) - Method in class org.mechio.api.speech.viseme.lifecycle.VisemeEventNotifierLifecycle
createSpeechJob(String) - Method in class org.mechio.api.speech.utils.SpeechJobManager: Adds text to the speech queue.

D

DefaultSpeechJob - Class in org.mechio.api.speech.utils
DefaultVisemeEvent - Class in org.mechio.api.speech.viseme
DefaultVisemeEvent(SpeechEvent, long) - Constructor for class org.mechio.api.speech.viseme.DefaultVisemeEvent: Creates a DefaultVisemeEvent from the given SpeechEvent.
DefaultVisemeEvent(SpeechEvent, long, long) - Constructor for class org.mechio.api.speech.viseme.DefaultVisemeEvent

F

fireSpeechEvent(SpeechEventList<SpeechEvent>) - Method in class org.mechio.api.speech.utils.SpeechEventNotifier: Notifies listeners of a SpeechEvent.

G

getBindingId() - Method in interface org.mechio.api.speech.viseme.config.VisemeBindingConfig: Returns the binding key for the VisemeBinding.
getBindingKey() - Method in class org.mechio.api.speech.viseme.VisemeBinding: Returns the binding key for this VisemeBinding.
getBindingValues(Viseme) - Method in class org.mechio.api.speech.viseme.VisemeBindingManager: Returns a Map of binding keys to NormalizedDoubles for the given Viseme.
getById(int) - Static method in enum org.mechio.api.speech.viseme.Viseme: Returns the Viseme with the given Id.
getConfigSourceId() - Method in interface org.mechio.api.speech.SpeechConfig
getConfigurationClass() - Method in class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory
getCurrentData() - Method in interface org.mechio.api.speech.SpeechEvent: Returns event data (usually phone or viseme id) associated with the start of the event.
getCurrentViseme() - Method in class org.mechio.api.speech.viseme.DefaultVisemeEvent
getCurrentViseme() - Method in interface org.mechio.api.speech.viseme.VisemeEvent: Returns the current Viseme at the time of the event.
getDuration() - Method in interface org.mechio.api.speech.SpeechEvent: Returns the duration of the event in milliseconds.
getDuration() - Method in class org.mechio.api.speech.viseme.DefaultVisemeEvent
getDuration() - Method in interface org.mechio.api.speech.viseme.VisemeEvent: Returns the number of milliseconds for the transition to the next Viseme.
getEvent(long) - Method in class org.mechio.api.speech.viseme.VisemeEventQueue
getEventType() - Method in interface org.mechio.api.speech.SpeechEvent: Returns the name of the event of this event.
getListener() - Method in class org.mechio.api.speech.viseme.VisemeEventQueue
getNextData() - Method in interface org.mechio.api.speech.SpeechEvent: Returns event data (usually phone or viseme id) associated with the end of the event.
getNextViseme() - Method in class org.mechio.api.speech.viseme.DefaultVisemeEvent
getNextViseme() - Method in interface org.mechio.api.speech.viseme.VisemeEvent: Returns the Viseme to transition to.
getPhrase() - Method in interface org.mechio.api.speech.SpeechRequest: Returns the phrase the SpeechService is being requested to speak.
getPosition() - Method in interface org.mechio.api.speech.viseme.VisemePosition
getRequestSourceId() - Method in interface org.mechio.api.speech.SpeechRequest: Returns the id String of the service making the request.
getSampleRate() - Method in interface org.mechio.api.speech.SpeechConfig
getServiceClass() - Method in class org.mechio.api.speech.lifecycle.RemoteSpeechServiceClientLifecycle
getServiceClass() - Method in class org.mechio.api.speech.lifecycle.RemoteSpeechServiceHostLifecycle
getServiceClass() - Method in class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory
getServiceClass() - Method in class org.mechio.api.speech.viseme.lifecycle.VisemeBindingManagerLifecycle
getServiceClass() - Method in class org.mechio.api.speech.viseme.lifecycle.VisemeEventNotifierLifecycle
getServiceVersion() - Method in class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory
getSpeechEvents() - Method in interface org.mechio.api.speech.SpeechEventList: Returns the List of SpeechEvents.
getSpeechJobId() - Method in interface org.mechio.api.speech.SpeechJob
getSpeechJobId() - Method in class org.mechio.api.speech.utils.DefaultSpeechJob: Returns a unique id for this SpeechJob.
getSpeechServiceId() - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
getSpeechServiceId() - Method in interface org.mechio.api.speech.SpeechConfig
getSpeechServiceId() - Method in interface org.mechio.api.speech.SpeechEventList: Returns the id String of the SpeechService the events originated from.
getSpeechServiceId() - Method in interface org.mechio.api.speech.SpeechRequest: Returns the id String of request's intended SpeechService.
getSpeechServiceId() - Method in interface org.mechio.api.speech.SpeechService: Returns the SpeechService Id.
getSpeechText() - Method in interface org.mechio.api.speech.SpeechJob
getSpeechText() - Method in class org.mechio.api.speech.utils.DefaultSpeechJob: Returns the text being spoken.
getStartTime() - Method in interface org.mechio.api.speech.SpeechJob
getStartTime() - Method in class org.mechio.api.speech.utils.DefaultSpeechJob: Returns the time the speech was queued.
getStatus() - Method in interface org.mechio.api.speech.SpeechJob
getStatus() - Method in class org.mechio.api.speech.utils.DefaultSpeechJob: Returns the current status of the speech job.
getStream() - Method in class org.mechio.api.speech.viseme.DefaultVisemeEvent
getStream() - Method in interface org.mechio.api.speech.viseme.VisemeEvent: Returns the speech Stream identifier.
getStreamNumber() - Method in interface org.mechio.api.speech.SpeechEvent: Returns the stream number for tts output the event originates from.
getStringData() - Method in interface org.mechio.api.speech.SpeechEvent: Returns any String data associated with the event (used for SAPI bookmark events).
getTextLength() - Method in interface org.mechio.api.speech.SpeechEvent: Returns the number of characters the event covers.
getTextPosition() - Method in interface org.mechio.api.speech.SpeechEvent: Returns the position of the speech request the event begins at.
getTimestampMillisecUTC() - Method in interface org.mechio.api.speech.SpeechEventList: Returns the timestamp of the events.
getTimestampMillisecUTC() - Method in interface org.mechio.api.speech.SpeechRequest: Returns the timestamp of the request.
getTimestampMillisecUTC() - Method in class org.mechio.api.speech.viseme.DefaultVisemeEvent
getTimestampMillisecUTC() - Method in interface org.mechio.api.speech.viseme.VisemeEvent: Returns the timestamp of the VisemeEvent.
getValue(Viseme) - Method in class org.mechio.api.speech.viseme.VisemeBinding: Returns the NormalizedDouble mapped to the given Viseme.
getVisemeBindings() - Method in interface org.mechio.api.speech.viseme.config.VisemeBindingConfig: Returns the list of VisemePositions.
getVisemeBindings() - Method in interface org.mechio.api.speech.viseme.config.VisemeBindingManagerConfig: Returns the configurations of the VisemeBindings to create.
getVisemeId() - Method in enum org.mechio.api.speech.viseme.Viseme: Returns the id of this Viseme.
getVisemeId() - Method in interface org.mechio.api.speech.viseme.VisemePosition
getVisemeValueMap() - Method in class org.mechio.api.speech.viseme.VisemeBinding
getVoiceName() - Method in interface org.mechio.api.speech.SpeechConfig

H

handleChange(String, Object, Map<String, Object>) - Method in class org.mechio.api.speech.lifecycle.RemoteSpeechServiceClientLifecycle
handleChange(String, Object, Map<String, Object>) - Method in class org.mechio.api.speech.lifecycle.RemoteSpeechServiceHostLifecycle
handleChange(String, Object, Map<String, Object>) - Method in class org.mechio.api.speech.viseme.lifecycle.VisemeBindingManagerLifecycle
handleChange(String, Object, Map<String, Object>) - Method in class org.mechio.api.speech.viseme.lifecycle.VisemeEventNotifierLifecycle
handleEvent(SpeechRequest) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
handleEvent(SpeechEventList<SpeechEvent>) - Method in class org.mechio.api.speech.utils.SpeechEventLogger
handleEvent(SpeechEventList<SpeechEvent>) - Method in class org.mechio.api.speech.utils.SpeechEventNotifier
handleEvent(VisemeEvent) - Method in class org.mechio.api.speech.utils.VisemeLogger
handleEvent(SpeechEventList<SpeechEvent>) - Method in class org.mechio.api.speech.viseme.VisemeEventNotifier
handleVisemeEvent(VisemeEvent) - Method in class org.mechio.api.speech.viseme.VisemeEventNotifier: Notifies listeners of a VisemeEvent.

O

org.mechio.api.speech - package org.mechio.api.speech
org.mechio.api.speech.lifecycle - package org.mechio.api.speech.lifecycle
org.mechio.api.speech.messaging - package org.mechio.api.speech.messaging
org.mechio.api.speech.osgi - package org.mechio.api.speech.osgi
org.mechio.api.speech.utils - package org.mechio.api.speech.utils
org.mechio.api.speech.viseme - package org.mechio.api.speech.viseme
org.mechio.api.speech.viseme.config - package org.mechio.api.speech.viseme.config
org.mechio.api.speech.viseme.lifecycle - package org.mechio.api.speech.viseme.lifecycle

P

PENDING - Static variable in class org.mechio.api.speech.utils.DefaultSpeechJob: Waiting for robot to begin speaking.
PROP_ID - Static variable in class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
PROP_ID - Static variable in interface org.mechio.api.speech.SpeechService: Property name for the SpeechService Id.

R

RemoteSpeechServiceClient<Conf> - Class in org.mechio.api.speech.messaging
RemoteSpeechServiceClient(Class<Conf>, String, String, MessageSender<ServiceCommand>, MessageSender<Conf>, MessageAsyncReceiver<ServiceError>, ServiceCommandFactory, MessageSender<SpeechRequest>, MessageAsyncReceiver<SpeechEventList<SpeechEvent>>, SpeechRequestFactory) - Constructor for class org.mechio.api.speech.messaging.RemoteSpeechServiceClient: Connects to a remote SpeechService through Messaging components
RemoteSpeechServiceClientLifecycle - Class in org.mechio.api.speech.lifecycle
RemoteSpeechServiceClientLifecycle(String, String, String, String, String, String, String) - Constructor for class org.mechio.api.speech.lifecycle.RemoteSpeechServiceClientLifecycle: Creates a new SpeechTriggerHandlerLifecycle for a SpeechService
RemoteSpeechServiceHost - Class in org.mechio.api.speech.messaging
RemoteSpeechServiceHost() - Constructor for class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
RemoteSpeechServiceHost(SpeechService, Listener<SpeechEventList<SpeechEvent>>, Notifier<SpeechRequest>) - Constructor for class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
RemoteSpeechServiceHostLifecycle - Class in org.mechio.api.speech.lifecycle
RemoteSpeechServiceHostLifecycle(String, String, String, String, String) - Constructor for class org.mechio.api.speech.lifecycle.RemoteSpeechServiceHostLifecycle
removeListener(Listener<VisemeEvent>) - Method in class org.mechio.api.speech.viseme.VisemeEventNotifier: Removes a VisemeEvent listener.
removeRequestListener(Listener<SpeechRequest>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
removeRequestListener(Listener<SpeechRequest>) - Method in interface org.mechio.api.speech.SpeechService: Removes a Listener from being notified when a speech request is made.
removeSpeechEventListener(Listener<SpeechEventList<SpeechEvent>>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
removeSpeechEventListener(Listener<SpeechEventList<SpeechEvent>>) - Method in interface org.mechio.api.speech.SpeechService: Removes a Listener from being notified when a speech event occurs.
removeSpeechEventListener(Listener<SpeechEventList<SpeechEvent>>) - Method in class org.mechio.api.speech.utils.SpeechEventNotifier: Removes a SpeechEvent listener.
RUNNING - Static variable in class org.mechio.api.speech.utils.DefaultSpeechJob: The robot is speaking.

S

setSpeechEventSender(Listener<SpeechEventList<SpeechEvent>>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
setSpeechEventsReceiver(MessageAsyncReceiver<SpeechEventList<SpeechEvent>>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
setSpeechRequestFactory(SpeechRequestFactory) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
setSpeechRequestReceiver(Notifier<SpeechRequest>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
setSpeechRequestSender(MessageSender<SpeechRequest>) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
setSpeechService(SpeechService) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceHost
setStatus(int) - Method in interface org.mechio.api.speech.SpeechJob
setStatus(int) - Method in class org.mechio.api.speech.utils.DefaultSpeechJob
setVisemeValue(Viseme, NormalizedDouble) - Method in class org.mechio.api.speech.viseme.VisemeBinding: Sets the NormalizedDouble to be mapped to the given Viseme.
speak(String) - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
speak(String) - Method in interface org.mechio.api.speech.SpeechService: Sends the SpeechService text to speak.
SPEECH_END - Static variable in interface org.mechio.api.speech.SpeechEvent
SPEECH_START - Static variable in interface org.mechio.api.speech.SpeechEvent
SpeechConfig - Interface in org.mechio.api.speech: Configuration for a SpeechService.
SpeechConfigFactory - Interface in org.mechio.api.speech.utils
SpeechEvent - Interface in org.mechio.api.speech: Defines a common interface for several types of Speech events.
SpeechEventList<T extends SpeechEvent> - Interface in org.mechio.api.speech: Contains a List of SpeechEvents and metadata about the event origin.
SpeechEventLogger - Class in org.mechio.api.speech.utils
SpeechEventLogger() - Constructor for class org.mechio.api.speech.utils.SpeechEventLogger
SpeechEventNotifier - Class in org.mechio.api.speech.utils: A SpeechEventNotifier receives SpeechEventList Messages and notifies listeners of the individual SpeechEvents in the SpeechEventList so SpeechEvents can be handled individually.
SpeechEventNotifier() - Constructor for class org.mechio.api.speech.utils.SpeechEventNotifier: Creates a new SpeechEventNotifier.
SpeechJob - Interface in org.mechio.api.speech
SpeechJobManager - Class in org.mechio.api.speech.utils
SpeechJobManager(SpeechService) - Constructor for class org.mechio.api.speech.utils.SpeechJobManager
SpeechRequest - Interface in org.mechio.api.speech: Defines a request for a SpeechService to speak a phrase.
SpeechRequestFactory - Interface in org.mechio.api.speech
SpeechService - Interface in org.mechio.api.speech: The SpeechService provides a basic interface for an service providing Text-to-Speech or equivalent capabilities.
start() - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
start(BundleContext) - Method in class org.mechio.api.speech.osgi.Activator
start() - Method in interface org.mechio.api.speech.SpeechService: Starts the SpeechService, making it ready to speak.
stop() - Method in class org.mechio.api.speech.messaging.RemoteSpeechServiceClient
stop(BundleContext) - Method in class org.mechio.api.speech.osgi.Activator
stop() - Method in interface org.mechio.api.speech.SpeechService: Closes a SpeechService, leaving it unable to speak.

V

valueOf(String) - Static method in enum org.mechio.api.speech.viseme.Viseme: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.mechio.api.speech.viseme.Viseme: Returns an array containing the constants of this enum type, in the order they are declared.
VERSION - Static variable in class org.mechio.api.speech.viseme.VisemeBindingManager: Controller type VersionProperty.
VERSION_NAME - Static variable in class org.mechio.api.speech.viseme.VisemeBindingManager: Service type version name.
VERSION_NUMBER - Static variable in class org.mechio.api.speech.viseme.VisemeBindingManager: Service type version number.
VISEME - Static variable in interface org.mechio.api.speech.SpeechEvent
Viseme - Enum in org.mechio.api.speech.viseme
VisemeBinding - Class in org.mechio.api.speech.viseme: Defines NormalizedDoubles, for each Viseme, to be bound to a key.
VisemeBinding(int) - Constructor for class org.mechio.api.speech.viseme.VisemeBinding: Creates an empty VisemeBinding for the given key.
VisemeBinding(VisemeBindingConfig<VisemePosition>) - Constructor for class org.mechio.api.speech.viseme.VisemeBinding: Creates a new VisemeBinding with the given configuration.
VisemeBindingConfig<T extends VisemePosition> - Interface in org.mechio.api.speech.viseme.config: Configuration for creating a VisemeBinding.
VisemeBindingManager - Class in org.mechio.api.speech.viseme: A VisemeBindingManager holds a set of VisemeBindings with different binding keys.
VisemeBindingManager() - Constructor for class org.mechio.api.speech.viseme.VisemeBindingManager: Creates an empty VisemeBindingManager.
VisemeBindingManagerConfig<T extends VisemeBindingConfig> - Interface in org.mechio.api.speech.viseme.config: Configuration for creating a VisemeBindingManager.
VisemeBindingManagerFactory - Class in org.mechio.api.speech.viseme.config: ServiceFactory for creating a VisemeBindingManager from a VisemeBindingManagerConfig.
VisemeBindingManagerFactory() - Constructor for class org.mechio.api.speech.viseme.config.VisemeBindingManagerFactory
VisemeBindingManagerLifecycle - Class in org.mechio.api.speech.viseme.lifecycle
VisemeBindingManagerLifecycle(Properties) - Constructor for class org.mechio.api.speech.viseme.lifecycle.VisemeBindingManagerLifecycle: Creates a new lifecycle provider for a VisemeEventNotifier which uses the given SpeechService.
VisemeEvent - Interface in org.mechio.api.speech.viseme: SpeechEvent with Visemes from a SpeechService, representing the visual information corresponding to current Speech from the SpeechService.
VisemeEventNotifier - Class in org.mechio.api.speech.viseme: Converts a SpeechEvent to a VisemeEvent and notifies listeners.
VisemeEventNotifier() - Constructor for class org.mechio.api.speech.viseme.VisemeEventNotifier: Creates an empty VisemeEventNotifier.
VisemeEventNotifierLifecycle - Class in org.mechio.api.speech.viseme.lifecycle: Lifecycle provider for a VisemeEventNotifier.
VisemeEventNotifierLifecycle(String) - Constructor for class org.mechio.api.speech.viseme.lifecycle.VisemeEventNotifierLifecycle: Creates a new lifecycle provider for a VisemeEventNotifier which uses the given SpeechService.
VisemeEventQueue - Class in org.mechio.api.speech.viseme
VisemeEventQueue() - Constructor for class org.mechio.api.speech.viseme.VisemeEventQueue
VisemeLogger - Class in org.mechio.api.speech.utils
VisemeLogger() - Constructor for class org.mechio.api.speech.utils.VisemeLogger
VisemePosition - Interface in org.mechio.api.speech.viseme

W

WORD_BOUNDARY - Static variable in interface org.mechio.api.speech.SpeechEvent

A B C D F G H O P R S V W