Avaya Client Services API Reference (OS X)

- Main Page
- Classes
- Files
- Related Pages

- Class List
- Class Index
- Class Hierarchy
- Class Members

Instance Methods | Properties | List of all members
<CSAudioFilePlayer> Protocol Reference

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...

## Detailed Description

Audio file player control interface.

## Method Documentation

- (BOOL) isPlaying |  |  |

Query the player status.

Returns
  TRUE if playing; otherwise FALSE.

- (BOOL) startPlaying |  |  |

Signal the player to start the tone/file.

Returns
  TRUE if player starts successfully; otherwise FALSE.

- (BOOL) stopPlaying |  |  |

Signal the player to stop the tone/file.

Returns
  TRUE if player stops successfully; otherwise FALSE.

## Property Documentation

- (id<CSAudioFilePlayerListener>) audioFilePlayerListener
| read write nonatomic weak

Listener for audio tone/file start and stop events.

- (int) durationMs
| read write nonatomic assign

Audio tone/file duration.

Number of milliseconds to play tone/file; zero to play the entire tone/file.

- (NSString*) file
| read write nonatomic copy

Audio file to play.

- (int) gain
| read write nonatomic assign

Audio tone/file gain, in range [0, 255].

- (BOOL) isLoop
| read write nonatomic assign

Audio tone/file looping flag.

TRUE to loop forever, FALSE to play once.

- (CSAudioTone) tone
| read write nonatomic assign

Audio tone to play.

Resources for these tones must be available at CSVoIPConfigurationAudio toneFilePath.

- (BOOL) useSpeaker
| read write nonatomic assign

Destintion to play tone/file.

TRUE to play on speakers, FALSE to mix with microphone. Can be overridden by useMicrophone

- (BOOL) useStream
| read write nonatomic assign

Play tone/file to stream.

TRUE to mix to stream, FALSE to not mix to stream.

The documentation for this protocol was generated from the following file:

- CSAudioFilePlayer.h