public interface PlayItem
Zang-enabled Breeze specific information:
The following URI schemes are supported for Zang-enabled Breeze Calls: http:// and https://
All other URI schemes are NOT supported.
SeePlayItem.setSource(String...)
MediaService
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_INTERRUPTIBLE |
static int |
DEFAULT_ITERATION_COUNT |
static String |
DEFAULT_LANGUAGE |
static int |
DEFAULT_MAX_DURATION |
static int |
ITERATE_FOREVER |
Modifier and Type | Method and Description |
---|---|
int |
getDuration()
Returns the duration of a play request in milliseconds.
|
int |
getIterateCount()
The number of times to repeatedly play this item.
|
String |
getLanguage()
Returns the language identifier for the TTS prompt.
|
List |
getSource()
Returns the list of the audio resources and TTS text strings to be played.
|
boolean |
isInterruptible()
Returns true if the play operation can be interrupted when a digit is detected.
|
PlayItem |
setDuration(int duration)
(Optional) - sets the duration of a play request in milliseconds.
|
PlayItem |
setInterruptible(boolean interruptible)
(Optional) - defines whether or not audio announcements may be interrupted when a digit is detected.
|
PlayItem |
setIterateCount(int iterateCount)
(Optional) - sets the number of times to play this item.
|
PlayItem |
setLanguage(String language)
(Optional) - sets the language identifier for the TTS prompt.
|
PlayItem |
setSource(String[] source)
Sets the source that identifies the list of audio resources and text-to-speech (TTS) strings to be played on the call.
|
static final int DEFAULT_MAX_DURATION
static final int DEFAULT_ITERATION_COUNT
static final int ITERATE_FOREVER
static final boolean DEFAULT_INTERRUPTIBLE
static final String DEFAULT_LANGUAGE
PlayItem setSource(String[] source) throws URISyntaxException
Sets the source that identifies the list of audio resources and text-to-speech (TTS) strings to be played on the call.
Legal value forsource
: a list of cstore://
or http://
URI for audio resources or TTS
text strings to be synthesized into speech.
"cstore://welcome?ns=announcements&cg=greetings"
"http://www.mycompany.com/announcements/greetings/welcome.wav"
,
"http://www.mycompany.com/announcements/greetings/thankYou.ulaw"
,
"http://www.mycompany.com/user/voiceMessage"
."Welcome to my company."
Note that the use of the "file:///
" or "file://
" URI scheme to specify an absolute path is
deprecated in Avaya Breeze 3.0 and Avaya Breeze 3.4 respectively. Items previously played using the "file:///"
or
"file://"
URI scheme can use "cstore://" URI scheme instead.
The "cstore://"
requires that the files be moved from the Avaya Aura® Media Server's file system into the Avaya
Aura® Media Server content store.
See Implementing and Administering Avaya Aura® Media Server documentation for more details on content store administration, or for details on supported media file formats (for example 16-bit mono sampled at 8kHz). The procedure for setting up the live stream source (e.g. music.lss) may be found in the Media processing configuration section.
Zang-enabled Breeze specific information:
The following URI schemes are supported for Zang-enabled Breeze Calls: http:// and https://
All other URI schemes are NOT supported.
SeeCallProperties.getCallProvider(Call)
to determine the call type
source
- the list of audio resources and text strings to be played.IllegalArgumentException
- if source
is null or an empty string.URISyntaxException
- if the source
cannot be parsed.int getDuration()
PlayItem setDuration(int duration)
(Optional) - sets the duration of a play request in milliseconds.
Default value forduration
: Integer.MAX_VALUE. The duration
parameter is not used when the parameter
iterateCount
is equal to PlayItem.ITERATE_FOREVER
.duration
- specifies the length of time in milliseconds to play the file.IllegalArgumentException
- if iterateCount
is less than 1.int getIterateCount()
PlayItem setIterateCount(int iterateCount)
(Optional) - sets the number of times to play this item.
Legal values foriterateCount
: Greater than or equal to 1, or equal to PlayItem.ITERATE_FOREVER
.iterateCount
: 1 When iterateCount
is set to PlayItem.ITERATE_FOREVER
, the play resource will iterate forever without being interrupted by a timer expiration. When iterateCount is set to
PlayItem.ITERATE_FOREVER, the duration parameter is not used.iterateCount
- the number of times to play this item.IllegalArgumentException
- if iterateCount
is less than 1 and not equal to PlayItem.ITERATE_FOREVER
.List getSource()
boolean isInterruptible()
PlayItem setInterruptible(boolean interruptible)
(Optional) - defines whether or not audio announcements may be interrupted when a digit is detected.
Announcements can only be interrupted by a digit press if they are played to a participant on the call. Announcements played on the call cannot be interrupted by a digit press. If this flag is set to true for an announcement played on the call, it is ignored.
Default value forinterruptible
: false.interruptible
- true if the announcement can be barged.String getLanguage()
PlayItem setLanguage(String language)
(Optional) - sets the language identifier for the TTS prompt.
Please consult the documentation for your speech server for information on which Language Identifiers are supported.
Default value forlanguage
: en-us.language
- the language you want for the TTS prompt.Copyright © 2023 Avaya. All rights reserved.