Installation

Install the Talker SDK in your project using npm, yarn, or pnpm.

Package Installation

Terminal

npm install @talker-network/talker-sdk

Terminal

yarn add @talker-network/talker-sdk

Terminal

pnpm add @talker-network/talker-sdk

Requirements

For Backend (Node.js)

Node.js 16 or higher
SDK Key (contact parag@talker.network)

For Frontend (Browser)

Modern browser with WebRTC support
User credentials from backend

Obtaining an SDK Key

To use the Talker SDK, you need an SDK key. Contact parag@talker.network to obtain your SDK key.

Keep Your SDK Key Secret

Your SDK key should never be exposed in client-side code. Store it as an environment variable and only use it on your backend server.

Environment Setup

Store your SDK key in environment variables:

.env

TALKER_SDK_KEY=your-sdk-key-here

Importing the SDK

Backend (CommonJS)

JavaScript

const { TalkerAdmin } = require('@talker-network/talker-sdk');

Backend (ES Modules / TypeScript)

TypeScript

import { TalkerAdmin } from '@talker-network/talker-sdk';

Frontend

TypeScript

import { TalkerClient } from '@talker-network/talker-sdk';

TypeScript Support

The SDK is written in TypeScript and includes type definitions. All types are exported from the main package:

TypeScript

import type {
  TalkerAdminConfig,
  TalkerClientConfig,
  UserData,
  Channel,
  BroadcastStartEvent,
  ConnectionChangeEvent,
} from '@talker-network/talker-sdk';

See the TypeScript Types page for a complete list of exported types.