CoreKit SDK

The CoreKit SDK provides a JavaScript interface for interacting with the Vocalix WebRTC Stream Server. It simplifies the process of creating and managing WebRTC voice calls.

Installation

npm install ./corekit-sdk

Or if published to npm:

npm install corekit-sdk

Usage

<script src="path/to/dist/corekit.bundle.js"></script>
<script>
    const corekit = new CoreKit({
        serverUrl: 'http://localhost:8080/api/v1'
    });

    async function start() {
        try {
            await corekit.connect({ callId: 'my-call-123' });
            console.log('Call started');
        } catch (error) {
            console.error('Failed to start call:', error);
        }
    }

    function end() {
        corekit.disconnect();
        console.log('Call ended');
    }
</script>

<button onclick="start()">Start Call</button>
<button onclick="end()">End Call</button>

API Reference

new CoreKit(options)

Creates a new CoreKit instance.

• options.serverUrl (string, required): The base URL of the WebRTC Stream Server API.
• options.logLevel (string, optional): The logging level. Can be 'debug', 'info', 'warn', 'error'. Defaults to 'info'.

corekit.connect(options)

Establishes a WebRTC connection.

• options.callId (string, required): A unique identifier for the call.

Returns a Promise that resolves when the connection is established.

corekit.disconnect()

Terminates the WebRTC connection.

corekit.on(eventName, callback)

Listens for events.

• eventName (string): The name of the event.
• callback (function): The function to call when the event occurs.

Events

• connected: Fired when the WebRTC connection is established.
• disconnected: Fired when the WebRTC connection is closed.
• error: Fired when an error occurs. The callback receives an Error object.
• audio-level: Fired periodically with the current audio level of the microphone. The callback receives a number between 0 and 1.

corekit.toggleMute()

Toggles the microphone mute state.

Returns the new mute state (boolean).

corekit.isMuted()

Returns the current mute state (boolean).