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
<CSAudioInterface> Protocol Reference

`#import <CSAudioInterface.h>`

Inherits <NSObject>.

## Instance Methods
(BOOL) | - isBluetoothActive
(void) | - startBluetooth
(void) | - stopBluetooth
(BOOL) | - isBluetoothConnected
(BOOL) | - isHeadsetConnected
(BOOL) | - isSpeakerConnected
(BOOL) | - setTelephonyEventPayloadType:
| Sets the dynamic payload type for telephony events. More...
(int) | - getTelephonyEventPayloadType
| Get the telephony event payload type. More...
(BOOL) | - mute:
| Set the muted state of the audio. More...
(BOOL) | - muteSpeaker:
| Set the muted state of the speaker. More...
(void) | - registerRecordPlayStatusListener:
(BOOL) | - setSpeakerGain:
| Set the speaker audio gain. More...
(int) | - speakerGain
| Get the speaker audio gain. More...
(BOOL) | - setMicrophoneGain:
| Set the microphone audio gain. More...
(int) | - microphoneGain
| Get the microphone audio gain. More...
(id< CSAudioFilePlayer >) | - createAudioFilePlayer:
| Create an Audio File Player. More...
(BOOL) | - setDscp:
| This function sets DSCP value for audio. More...
(BOOL) | - setMicrophoneAudioLevelListener:
| This function sets microphone audio level listener. More...
(BOOL) | - setAudioMuteListener:
| This fuctions sets audio mute listener. More...

## Properties
BOOL | audioMuted
| Current muted state of the audio. More...
BOOL | speakerMuted
| Current muted state of the speaker. More...
NSArray * | availableRecordDevices
| Array of (AudioDevice*) available Microphone devices. More...
NSArray * | availablePlayDevices
| Array of (AudioDevice*) available Playout devices. More...
CSMicrophoneDevice * | activeMicrophone
CSSpeakerDevice * | activeSpeaker
CSMicrophoneDevice * | userRequestedMicrophone
CSSpeakerDevice * | userRequestedSpeaker
id< CSAudioDevicesEventListener > | delegate

## Method Documentation

- (id<CSAudioFilePlayer>) createAudioFilePlayer: |  | (id< CSAudioFilePlayerListener >) | pAudioFilePlayerListener |

Create an Audio File Player.

Parameters

  pAudioFilePlayerListener | CSAudioFilePlayerListener for start/stop events.

Returns
  CSAudioFilePlayer to control audio playback.

- (int) getTelephonyEventPayloadType |  |  |

Get the telephony event payload type.

Returns
  payload type set for telephony events.

- (BOOL) isBluetoothActive |  |  |

- (BOOL) isBluetoothConnected |  |  |

- (BOOL) isHeadsetConnected |  |  |

- (BOOL) isSpeakerConnected |  |  |

- (int) microphoneGain |  |  |

Get the microphone audio gain.

Returns
  The current audio gain [0, 255].

- (BOOL) mute: |  | (BOOL) | mute |

Set the muted state of the audio.

Parameters

  mute | The new mute state of the audio.

Returns
  YES for success, NO for failure.

- (BOOL) muteSpeaker: |  | (BOOL) | mute |

Set the muted state of the speaker.

Parameters

  mute | The new mute state of the speaker.

Returns
  YES for success, NO for failure.

- (void) registerRecordPlayStatusListener: |  | (CSAudioRecordPlayStatusListener *) | listener |

- (BOOL) setAudioMuteListener: |  | (id< CSAudioMuteListener >) | pListener |

This fuctions sets audio mute listener.

Parameters

  pListener | callback

Returns
  YES on success

- (BOOL) setDscp: |  | (int) | dscpValue |

This function sets DSCP value for audio.

Parameters

  dscpValue | DSCP value must be in range 0-63.

Returns
  YES if DSCP value is set, otherwise NO.

- (BOOL) setMicrophoneAudioLevelListener: |  | (id< CSLevelListener >) | pListener |

This function sets microphone audio level listener.

Audio level will be returned in range [0, 100]

Parameters

  pListener | callback

Returns
  YES on success

- (BOOL) setMicrophoneGain: |  | (int) | gain |

Set the microphone audio gain.

Parameters

  gain | The new audio gain [0, 255].

Returns
  YES for success, NO for failure.

- (BOOL) setSpeakerGain: |  | (int) | gain |

Set the speaker audio gain.

Parameters

  gain | The new audio gain [0, 255].

Returns
  YES for success, NO for failure.

- (BOOL) setTelephonyEventPayloadType: |  | (int) | payloadType |

Sets the dynamic payload type for telephony events.

Parameters

  payloadType | The new payloadType for telephony events.

Returns
  true if the input value is accepted because it is between 96-127; false is returned when the input value is not accepted.

- (int) speakerGain |  |  |

Get the speaker audio gain.

Returns
  The current audio gain [0, 255].

- (void) startBluetooth |  |  |

- (void) stopBluetooth |  |  |

## Property Documentation

- (CSMicrophoneDevice*) activeMicrophone
| read nonatomic assign

- (CSSpeakerDevice*) activeSpeaker
| read nonatomic assign

- (BOOL) audioMuted
| read nonatomic assign

Current muted state of the audio.

- (NSArray*) availablePlayDevices
| read nonatomic assign

Array of (AudioDevice*) available Playout devices.

- (NSArray*) availableRecordDevices
| read nonatomic assign

Array of (AudioDevice*) available Microphone devices.

- (id<CSAudioDevicesEventListener>) delegate
| read write nonatomic weak

- (BOOL) speakerMuted
| read nonatomic assign

Current muted state of the speaker.

- (CSMicrophoneDevice*) userRequestedMicrophone
| read write nonatomic strong

- (CSSpeakerDevice*) userRequestedSpeaker
| read write nonatomic strong

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

- CSAudioInterface.h