com.avaya.collaboration.call.speech.search

Interface SpeechService

public interface SpeechService

This is the interface used to invoke speech operations including search based on provided queries. The Speech Service supports:

1. Speech search on both parties of a call
2. Speech search on a single party of a call
3. Stopping a search
4. VoiceXML dialog on a single party of a call
5. Stopping a VoiceXML dialog

Since:

3.0

See Also:

Call, Participant, SearchOptions, SpeechSearchListener

Method Summary

Methods

Modifier and Type	Method and Description
UUID	startSearch(Call call, SearchOptions searchOptions, SpeechSearchListener speechSearchListener) Starts searching the speech on a call using search queries.
UUID	startSearch(Participant participant, SearchOptions searchOptions, SpeechSearchListener speechSearchListener) Starts searching the speech of a participant on a call using search queries.
UUID	startVoiceXMLDialog(Participant participant, VoiceXMLDialogItem voiceXMLDialogItem, VoiceXMLDialogListener voiceXMLDialogListener) Sends a VoiceXML request to the Avaya Aura® Media Server for a participant on an established call.
void	stopSearch(UUID searchID) Stop the speech search on the Avaya Aura® Media Server using the search identifier.
void	stopVoiceXMLDialog(UUID requestId) Stop the VoiceXML dialog on the Avaya Aura® Media Server using the dialog identifier

Method Detail

startSearch

UUID startSearch(Call call,
               SearchOptions searchOptions,
               SpeechSearchListener speechSearchListener)

Starts searching the speech on a call using search queries. Any events that occur are notified to the SpeechSearchListener.

Parameters:

call - a call that has been initialized for a speech search

searchOptions - the search options

speechSearchListener - the listener for the search events

Returns:

UUID that identifies the search.

startSearch

UUID startSearch(Participant participant,
               SearchOptions searchOptions,
               SpeechSearchListener speechSearchListener)

Starts searching the speech of a participant on a call using search queries. Any events that occur are notified to the SpeechSearchListener.

Parameters:

participant - a Participant that has been initialized for a speech search

searchOptions - the search options

speechSearchListener - the listener for the search events

Returns:

UUID that identifies the search.

stopSearch

void stopSearch(UUID searchID)

Stop the speech search on the Avaya Aura® Media Server using the search identifier.

Parameters:

searchID - the UUID that identifies the search

startVoiceXMLDialog

UUID startVoiceXMLDialog(Participant participant,
                       VoiceXMLDialogItem voiceXMLDialogItem,
                       VoiceXMLDialogListener voiceXMLDialogListener)

Sends a VoiceXML request to the Avaya Aura® Media Server for a participant on an established call.

Parameters:

participant - the participant on a call to which the dialog request is sent

voiceXMLDialogItem - the VoiceXMLDialog request

voiceXMLDialogListener - the listener that receives VoiceXMLDialog events

Returns:

the universal unique identifier for this VoiceXMLDialog request

stopVoiceXMLDialog

void stopVoiceXMLDialog(UUID requestId)

Stop the VoiceXML dialog on the Avaya Aura® Media Server using the dialog identifier

Parameters:

requestId - the UUID that identifies the voice xml dialog