Class CXoneVoiceClient

Wrapper class for CXone Voice Connection

Hierarchy

CXoneVoiceClient

Constructors

constructor

new CXoneVoiceClient(): CXoneVoiceClient

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:31
Constructor for Voice Client
example
```
voiceClient = new CXoneVoiceClient();
```
Returns CXoneVoiceClient

Properties

Private logger

logger: Logger = ...

onAudioDeviceChange

onAudioDeviceChange: Subject<AudioDeviceChangeEvent>

onCallStatusChanged

onCallStatusChanged: Subject<CXoneVoiceCall>

onConnectionStatusChanged

onConnectionStatusChanged: Subject<CXoneVoiceConnection>

Private voiceCall

voiceCall: CXoneVoiceCall

Private voiceConnection

voiceConnection: CXoneVoiceConnection

Private webRtcService

webRtcService: ACWebRtcService

Static Private singleton

singleton: CXoneVoiceClient

Accessors

callState

get callState(): CXoneVoiceCall

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:80
Gets current voice call state
example
```
voiceClient.callState;
```
Returns CXoneVoiceCall

connectionState

get connectionState(): CXoneVoiceConnection

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:69
Gets current WebRTC connection state
example
```
voiceClient.connectionState;
```
Returns CXoneVoiceConnection

Static instance

get instance(): CXoneVoiceClient

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:55
Method to create singleton object of the class
```
@example
const CXoneVoiceClient = CXoneVoiceClient.instance();
```
Returns CXoneVoiceClient

Methods

connectAgentLeg

connectAgentLeg(agentLegId: string): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:137
Disconnect from WebRTC server
example
```
voiceClient.disconnectServer();
```
Parameters
- agentLegId: string
Returns void

connectServer

connectServer(acdAgentId: string, options: CXoneVoiceConnectionOptions, audioElement: HTMLAudioElement, appName: string): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:95
Initialize this client and connect to the WebRTC server. Please use onConnectionStatusChanged event for both success and failure notification for server connectivity
example
```
voiceClient.connectServer('12345', options, audioElement);
```
Parameters
- acdAgentId: string
  
  CXone agent number, that will be used for voice connection
- options: CXoneVoiceConnectionOptions
  
  CXone audio connection options that has WebRTC server information
- audioElement: HTMLAudioElement
  
  audio element used to open audio stream
- appName: string
Returns void

disconnectServer

disconnectServer(): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:125
Disconnect from WebRTC server
example
```
voiceClient.disconnectServer();
```
Returns void

emitAudioDeviceChange

emitAudioDeviceChange(event: AudioDeviceChangeEvent): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:218
Emits the processed audio device change event to all onAudioDeviceChange subscribers.
example
```
voiceClient.emitAudioDeviceChange(event);
```
Parameters
- event: AudioDeviceChangeEvent
  
  the AudioDeviceChangeEvent payload to emit
Returns void

getActiveAudioTrackLabel

getActiveAudioTrackLabel(): string

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:205
Returns the active audio input track label from the current sender to seed the known active device on call connect.
example
```
voiceClient.getActiveAudioTrackLabel();
```
Returns string
the track label string, or null if unavailable

handleAgentLegEvent

handleAgentLegEvent(agentLeg: AgentLegEvent): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:114
Send an request to initialize a audio streaming to the connected WebRTC server. Please use onCallStatusChanged event for both success and failure notification for voice call
example
```
voiceClient.handleAgentLegEvent(agentLeg);
```
Parameters
- agentLeg: AgentLegEvent
  
  CXone agent leg having contactId and status
Returns void

replaceTrack

replaceTrack(newTrack: MediaStreamTrack): Promise<void>

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:179
Replaces the active audio input track on the live RTP sender during mid-call audio device failover.
example
```
voiceClient.replaceTrack(newTrack);
```
Parameters
- newTrack: MediaStreamTrack
  
  the new MediaStreamTrack for the microphone input
Returns Promise<void>

setSinkId

setSinkId(deviceId: string): Promise<void>

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:192
Sets the audio output device on the audio element during mid-call audio device failover
example
```
voiceClient.setSinkId('device-id');
```
Parameters
- deviceId: string
  
  the deviceId of the target audio output device
Returns Promise<void>

triggerAutoAccept

triggerAutoAccept(agentLegId: string): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:160
Enables SDK user to auto accept the call in CXone Agent
example
```
triggerAutoAccept(agentLegId);
```
Parameters
- agentLegId: string
  
  input agent leg id
Returns void

volumeChange

volumeChange(volume: number): void

- Defined in voice-sdk/src/lib/cxone-voice-client.ts:147
Set the webRtc volume

example
voiceClient.volumeChange();

Parameters
- volume: number
  
  webRtc volume
Returns void

Generated using TypeDoc