Kandy Anonymous SDK Reference

Configuration options for the Logs feature.

Configuration options for the notification feature.

Configuration options for the CallMe Authentication feature.

Configuration options for the call feature.

Configuration options for the Connectivity feature.

Add an event listener for the specified event type.

• Error: Invalid event type

Removes an event listener for the specified event type.

• Error: Invalid event type

Adds a global event listener

• Error: Listener not a function

Removes a global event listener

• Error: Listener not a function

Returns the current logged in user and the current auth token.

Get the connection state.

Possible subscription states of the user.

Starts an outgoing call as an anonymous user.

// Make a basic anonymous call.
let callee = 'user1@kandy.io';
let callOptions = { ... };

let callId = kandy.call.makeAnonymous(callee, {}, callOptions);

// Make a time-limited token anonymous call.
let callee = 'user1@kandy.io';
let account = 'user2@kandy.io';
let callOptions = { ... };

// Generate / Retrieve the encrypted tokens.
const key = 'abc123...';
const credentials = {
     accountToken: createToken(account, key),
     fromToken: createToken('sip:' + account, key),
     toToken: createToken('sip:' + callee, key),
     realm: 'realmAbc123...'
};

let callId = kandy.call.makeAnonymous(callee, credentials, callOptions);

Retrieves the state of calls made during the current session.

let calls = kandy.call.getAll();
let currentCalls = calls.filter(call => {
    return call.state === kandy.call.states.IN_CALL;
});

Retrieves a call from state with a specific call ID.

States of a call.

kandy.on('call:stateChange', function(callInfo) {
     if(callInfo.state === kandy.call.states.ENDED) {
         // Call has ended.
     }
});

State of the media connection within a call.

End an on-going call.

Mute the local audio stream on an ongoing call.

Unmute the local audio stream on an ongoing call.

Start local video stream for an ongoing call.

Stop local video for an ongoing call.

Put an ongoing call on hold.

Return a held call to ongoing.

Starts sharing a screen over a call.

Stops sharing a screen over a call.

Send a DTMF tone over a call.

An outgoing call has successfully started.

A call's state has changed.

kandy.on('call:stateChange', function(params) {
    // We are now in call with another user, so update our app to show it.
    if(params.state === kandy.call.states.IN_CALL) {
        renderCall(kandy.call.getById(params.callId));
    }
});

A call's media state has changed.

Screensharing has been started turned on or off.

An error has occurred with a call.

Sets the selected devices as the default devices. They will be used for audio output for future calls. Changing speaker is supported on browser's that support HTMLMediaElement.setSinkId().

// Set only the default microphone and camera.
kandy.media.setDefaultDevices({
    camera: 'abc123...',
    microphone: 'def456...'
});

Retrieves the available media devices for use.

A change has been made to default devices used for calls.

Media support has been checked.

Get the state of the websocket.

Enables or disables connectivity checking.

The websocket to the server has changed state.

Registers a device token for push notifications.

Deregisters for push notifications.

Enables, or disables, the processing of websocket notifications.

Push notifications registration state has changed.

An error occured with push notifications.

In some scenarios it's necessary to remove certain codecs being offered by the SDK to the remote party. While creating an SDP handler would allow a user to perform this type of manipulation, it is a non-trivial task that requires in-depth knowledge of WebRTC SDP.

To facilitate this common task, the SDK provides a codec removal handler that can be used for this purpose.

The SDP handlers are exposed on the entry point of the SDK. They need to be added to the list of SDP handlers via configuration on creation of a Kandy instance.

import createKandy from 'kandy';
const codecRemover = createKandy.sdpHandlers.createCodecRemover(['VP8', 'VP9'])
const kandy = createKandy({
  call: {
    sdpHandlers: [codecRemover]
  }
})

Possible levels for the SDK logger.

Gets the current configuration Object

Update values in the global Config section of the store.

Creates a local bridge that can be used to join audio calls.

Closes an existing audio bridge.

Adds a call to the specified local audio bridge.

Remove a specified call from the local audio bridge.

Mute the local audio for all of the calls on the bridge.

Unmute the local audio for all of the calls on the bridge.

Retrieve information about audio bridges.

A change has occurred in an audio bridge.

An error occurred while performing an audio bridge operation.