|
Avaya Client Services API Reference (iOS)
|
Audio file player control interface. More...
#import <CSAudioFilePlayer.h>
Inherits <NSObject>.
Instance Methods | |
| (BOOL) | - startPlaying |
| Signal the player to start the tone/file. More... | |
| (BOOL) | - stopPlaying |
| Signal the player to stop the tone/file. More... | |
| (BOOL) | - isPlaying |
| Query the player status. More... | |
Properties | |
| CSAudioTone | tone |
| Audio tone to play. More... | |
| NSString * | file |
| Audio file to play. More... | |
| BOOL | isLoop |
| Audio tone/file looping flag. More... | |
| int | durationMs |
| Audio tone/file duration. More... | |
| int | gain |
| Audio tone/file gain, in range [0, 255]. More... | |
| BOOL | useSpeaker |
| Destintion to play tone/file. More... | |
| BOOL | useStream |
| Play tone/file to stream. More... | |
| id< CSAudioFilePlayerListener > | audioFilePlayerListener |
| Listener for audio tone/file start and stop events. More... | |
Audio file player control interface.
| - (BOOL) isPlaying |
Query the player status.
| - (BOOL) startPlaying |
Signal the player to start the tone/file.
| - (BOOL) stopPlaying |
Signal the player to stop the tone/file.
|
readwritenonatomicweak |
Listener for audio tone/file start and stop events.
|
readwritenonatomicassign |
Audio tone/file duration.
Number of milliseconds to play tone/file; zero to play the entire tone/file.
|
readwritenonatomiccopy |
Audio file to play.
|
readwritenonatomicassign |
Audio tone/file gain, in range [0, 255].
|
readwritenonatomicassign |
Audio tone/file looping flag.
TRUE to loop forever, FALSE to play once.
|
readwritenonatomicassign |
Audio tone to play.
Resources for these tones must be available at CSVoIPConfigurationAudio toneFilePath.
|
readwritenonatomicassign |
Destintion to play tone/file.
TRUE to play on speakers, FALSE to mix with microphone. Can be overridden by useMicrophone
|
readwritenonatomicassign |
Play tone/file to stream.
TRUE to mix to stream, FALSE to not mix to stream.