jandres/StreamingAvatar
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md to announce SDK

Browse Source 
Updated to direct users to SDK
This commit is contained in:
Alec Lindsay
2024-05-10 17:41:25 -04:00
committed by GitHub
parent 4212d2cfe6
commit 11fc43dbef
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -1,5 +1,9 @@
# Streaming Avatar Demo # Streaming Avatar Demo
NEW: We have an SDK now! The SDK is an NPM package that you can easily add to your website and use for Streaming Avatar functionality. Please check it out at https://www.npmjs.com/package/@heygen/streaming-avatar
We also have an example React app demonstrating the SDK's functionality. That is located at: https://github.com/HeyGen-Official/StreamingAvatarTSDemo
## Introduction ## Introduction
This HeyGen Streaming Avatar demo is a starting point from which developers can adapt and build streaming sessions into their own websites and experiences. This HeyGen Streaming Avatar demo is a starting point from which developers can adapt and build streaming sessions into their own websites and experiences.
@@ -61,7 +65,6 @@ You can check how many active sessions you have open with the List Sessions endp
## Using the Demo ## Using the Demo
0. Make sure you are whitelisted to use the HeyGen's Streaming avatar API.
1. Open the web browser and enter the `http://localhost:3000`to start the demo. 1. Open the web browser and enter the `http://localhost:3000`to start the demo.
2. Click the "New" button to create a new session. The status updates will be displayed on the screen. 2. Click the "New" button to create a new session. The status updates will be displayed on the screen.
3. After the session is created successfully, click the "Start" button to start streaming the avatar. 3. After the session is created successfully, click the "Start" button to start streaming the avatar.