getechospace-sdk
v0.0.0
Published
The EchoSpace SDK provides an easy way to integrate the EchoSpace voice streaming widget into your website.
Downloads
5
Readme
EchoSpace SDK
The EchoSpace SDK provides an easy way to integrate the EchoSpace voice streaming widget into your website.
Installation
To install the EchoSpace SDK, you can use npm or yarn.
Using npm:
npm install echospace-sdk
Using yarn:
yarn add echospace-sdk
Usage
Importing in your project
import EchoSpaceSDK, { POSITION } from "echospace-sdk";
Initializing EchoSpace
// Replace 'your-api-key' with your actual API key
const apiKey = "your-api-key";
const linkId = "unique-link-id"; // generate a unique link ID for each conversation
// Initialize EchoSpace with optional parameters
const echospaceSDK = new EchoSpaceSDK({
apiKey,
linkId,
});
echospaceSDK.initialize(POSITION.TOP_LEFT);
Parameters
apiKey
: Your EchoSpace API key.linkId
: A unique identifier for the conversation link.position (optional)
: Position of the EchoSpace widget on the screen. Use values from the POSITION enum (e.g., POSITION.TOP_LEFT, POSITION.TOP_RIGHT, etc.).
Note
Make sure to replace placeholder values with your actual API key and desired parameters.