Class CallingClient

The CallingClient module provides a set of APIs for line registration and calling functionalities within the SDK.

The following code snippet demonstrates how to create an instance of CallingClient using a webex instance and callingConfig:

Example

const callingClient = createClient(webex, callingConfig);

Hierarchy

Eventing<CallingClientEventTypes>
- CallingClient

Implements

ICallingClient

Index

Properties

mediaEngine

mediaEngine: __module

Represents the `mediaEngine for managing media-related operations within the CallingClient. The media engine provides access to audio and video devices such as cameras, microphones, and speakers within the media layer.

Example

const microphones = await callingClient.mediaEngine.Media.getMicrophones();
const speakers = await callingClient.mediaEngine.Media.getSpeakers();
const cameras = await callingClient.mediaEngine.Media.getCameras();

Methods

getLines

getLines(): Record<string, ILine>
Retrieves details of all the Line objects belonging to a User NOTE: currently multiple lines are not supported

Returns Record<string, ILine>

Implementation of ICallingClient.getLines

getActiveCalls

getActiveCalls(): Record<string, ICall[]>
Retrieves call objects for all the active calls present in the client

Returns Record<string, ICall[]>

Implementation of ICallingClient.getActiveCalls

getConnectedCall

getConnectedCall(): undefined | ICall
Retrieves call object for the connected call in the client

Returns undefined | ICall

Implementation of ICallingClient.getConnectedCall

Events

emit

emit<E>(event: E, ...args: Parameters<CallingClientEventTypes[E]>): boolean
Type Parameters
- E extends keyof CallingClientEventTypes
Parameters
- event: E
  
  Event that is going ot be emitted.
- Rest ...args: Parameters<CallingClientEventTypes[E]>
  
  Parameters that are emitted with the event.
Returns boolean

Implementation of ICallingClient.emit

Inherited from Eventing.emit

on

on<E>(event: E, listener: CallingClientEventTypes[E]): CallingClient
.
Type Parameters
- E extends keyof CallingClientEventTypes
Parameters
- event: E
  
  Event to listen to.
- listener: CallingClientEventTypes[E]
  
  Callback for event.
Returns CallingClient

Implementation of ICallingClient.on

Inherited from Eventing.on

off

off<E>(event: E, listener: CallingClientEventTypes[E]): CallingClient
.
Type Parameters
- E extends keyof CallingClientEventTypes
Parameters
- event: E
  
  Event to remove listener on.
- listener: CallingClientEventTypes[E]
  
  Callback for event.
Returns CallingClient

Implementation of ICallingClient.off

Inherited from Eventing.off

Class CallingClient

Example

Hierarchy

Implements

Index

Properties

Methods

Events

Properties

mediaEngine

Example

Methods

getLines

Returns Record<string, ILine>

getActiveCalls

Returns Record<string, ICall[]>

getConnectedCall

Returns undefined | ICall

Events

emit

Type Parameters

E extends keyof CallingClientEventTypes

Parameters

event: E

Rest ...args: Parameters<CallingClientEventTypes[E]>

Returns boolean

on

Type Parameters

E extends keyof CallingClientEventTypes

Parameters

event: E

listener: CallingClientEventTypes[E]

Returns CallingClient

off

Type Parameters

E extends keyof CallingClientEventTypes

Parameters

event: E

listener: CallingClientEventTypes[E]

Returns CallingClient

Settings

Member Visibility

Theme

`Rest` ...args: Parameters<CallingClientEventTypes[E]>