Faq

​

Frequently Asked Questions (FAQs)

​

General

Q: What is the Kwei Client SDK?
A: The Kwei Client SDK provides developers with tools to integrate real-time audio, video, and data communication into their applications. It leverages modern WebRTC technologies to facilitate direct peer-to-peer communication securely and efficiently.

Q: Which platforms are supported by the Kwei Client SDK?
A: The Kwei Client SDK is designed to be cross-platform, headed towards supporting web-based applications through JavaScript, and native apps.

​

Installation and Configuration

Q: How do I get started with installing the Kwei Client SDK?
A: To install the SDK, you need to have Node.js installed on your system. You can then add the SDK to your project via npm:

npm install kwei-client-js-sdk

Follow the detailed setup instructions in the Getting Started section of this documentation.

Q: Do I need an account to use the Kwei SDK?
A: Yes, you need to create an account on the Kwei Dashboard. This account allows you to generate API keys necessary for using the SDK and provides access to monitoring and managing your usage and billing.

​

Usage

Q: How do I initialize the SDK in my application?
A: You can initialize the SDK by creating a new instance of Room and calling the init method with your API key and secret key:

const room = new kwei.Room();
room
  .init("your_api_key", "your_secret_key")
  .then(() => {
    console.log("Initialization successful");
  })
  .catch((error) => {
    console.error("Initialization failed:", error);
  });

Q: How can I join a communication room?
A: After initializing the SDK, you can join a room by calling the joinRoom method with the desired room name:

room
  .joinRoom("ExampleRoom")
  .then(() => {
    console.log("Joined room successfully");
  })
  .catch((error) => {
    console.error("Error joining room:", error);
  });