Quickstart

npm i github:Nickbur/ringkit#v1.0.0
npx cap sync

{
  "plugins": {
    "RingKit": {
      "appName": "Acme",
      "supportsVideo": true,
      "payloadPreset": "raw"
    }
  }
}

import { RingKit } from '@nickbur/ringkit';

async function setupCalls() {
  if (!(await RingKit.isAvailable()).available) return; // web/desktop → in-app ringing

  await RingKit.addListener('registration', ({ token, platform, apsEnvironment }) => {
    // Register `token` with your push provider so it can wake this device.
    // iOS: `apsEnvironment` ('development' | 'production') tells you which APNs
    // gateway / OneSignal test_type to route the VoIP token through.
  });

  await RingKit.addListener('callAnswered', async ({ callId, chatId, hasVideo }) => {
    await joinYourCall(callId, chatId, hasVideo);   // your media/SFU join
    await RingKit.reportCallConnected({ callId });
  });

  await RingKit.addListener('callEnded', ({ callId }) => {
    teardownYourCall(callId);
  });

  await RingKit.register();
}

await RingKit.reportIncomingCall({ callId, handle: 'Ada Lovelace', hasVideo: false, chatId });

// End it (remote hang-up / cancel):
await RingKit.endCall({ callId });