public interface PlayItem
MediaService
Modifier and Type | Field and Description |
---|---|
static boolean |
DEFAULT_INTERRUPTIBLE |
static int |
DEFAULT_ITERATION_COUNT |
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.
|
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 |
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
PlayItem setSource(String[] source) throws URISyntaxException
source
: a list of cstore://
or file://
or http://
URI for
audio resources or TTS text strings to be synthesized into speech.
"cstore://welcome?ns=announcements&cg=greetings"
"file://welcome.wav"
, "file://music.lss"
, "file://thankYou.ulaw"
."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:///
" URI scheme to specify an absolute path is deprecated in Avaya Breeze 3.0.
Items previously played using the "file:///"
URI scheme can use either the "file://"
URI scheme to specify
a relative path or the "cstore://" URI scheme instead.
The "file://"
relative path uses the filestorage root at /opt/avaya/app/localmedia/
or the link
/home/cust/media
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.
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)
duration
: 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)
iterateCount
: 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)
interruptible
: false.interruptible
- true if the announcement can be barged.Copyright © 2016 Avaya. All Rights Reserved.