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

Node.js 16 or higher (for Node.js environments)
Modern browser with WebRTC support (for browser environments)
SDK Key (contact parag@talker.network)

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 be kept secret. Store it as an environment variable and avoid exposing it in publicly accessible code.

Environment Setup

Store your SDK key in environment variables:

.env

TALKER_SDK_KEY=your-sdk-key-here

Importing the SDK

CommonJS

JavaScript

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

ES Modules / TypeScript

TypeScript

import { TalkerAdmin, 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.