Class BriaClientAudio

Control audio settings of the Bria client

Hierarchy

default<AudioTypes>
- BriaClientAudio

Index

Constructors

constructor

Events

Properties

Methods

Constructors

constructor

new BriaClientAudio(client: BriaClient): BriaClientAudio

Overrides default.constructor
- Defined in client/Audio.ts:53
Parameters
- client: BriaClient
Returns BriaClientAudio

Events

devicesUpdated

devicesUpdated(devices: AudioDevice[]): Promise<void> | void

Parameters
- devices: AudioDevice[]
Returns Promise<void> | void

propertiesUpdated

propertiesUpdated(): Promise<void> | void

Returns Promise<void> | void

Properties

Optional devices

devices?: AudioDevice[]

Optional properties

properties?: AudioProperties

Methods

getAudioDevices

getAudioDevices(): Promise<AudioDevice[]>

- Defined in client/Audio.ts:129
Get audio devices (input/output) from Bria client

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiAudio.htm#getStatusAudioDevices

Returns Promise<AudioDevice[]>
Array of audio devices

getAudioProperties

getAudioProperties(): Promise<AudioProperties>

- Defined in client/Audio.ts:91
Get audio properties (mute, speakerphone state, volume)

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiAudio.htm#getStatusAudioProperties

Returns Promise<AudioProperties>
Properties

populate

populate(): Promise<void>

Overrides default.populate
- Defined in client/Audio.ts:61
Returns Promise<void>

selectAudioDevices

selectAudioDevices(devices: AudioDevice[]): Promise<XML>

- Defined in client/Audio.ts:162
Select audio devices Roles must be a one-element array in each device, Bria API only supports changing one role per device per request :(

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiAudio.htm#getSelectAudioDevices

Parameters
- devices: AudioDevice[]
  
  Array of audio devices
Returns Promise<XML>

setAudioProperties

setAudioProperties(properties: Partial<AudioProperties>): Promise<XML>

- Defined in client/Audio.ts:120
Set audio properties

see
https://docs.counterpath.com/guides/desk/desk_api/clients/deskAPI/deskApiAudio.htm#getSelectAudioDevices

Parameters
- properties: Partial<AudioProperties>
  
  Partial audio properties
Returns Promise<XML>

Generated using TypeDoc