@ceeblue/webrtc-client

Requirements | Usage | Examples | Building locally | Documentation | Contribution | License

Ceeblue WebRTC Client

The Ceeblue WebRTC Client is a generic client library designed to simplify the implementation of WebRTC functionalities for Ceeblue customers.

The client library addresses common challenges faced by developers:

• Unified Browser Support - Addresses inconsistencies and variations in implementation across different browsers.
• Firewall Traversal - Implements our unique TURN approach to manage firewall traversal.
• Security - Ensures secure streaming through encryption and authentication.
• Quality of Service (QoS) - Handles latency, packet loss, and other optimizations.
• Signalling - Unifies different signalling capabilities over Websockets and WHIP/WHEP into a single, easy-to-use interface, with enhanced communication robustness.
• Multi Bitrate Playback - Enables the player to switch in real-time between multiple quality renditions based on network conditions and client capabilities.
• Adaptive Bitrate Streaming - Allows the streamer to adapt its video bitrate in real-time based on network conditions and client capabilities.

Requirements

Item	Description
Ceeblue Account	To create a Stream, you will need an active account with Ceeblue Streaming Cloud. A trial account is sufficient. If you do not have one yet, you can request one on the Ceeblue website.
Stream	To use this library, you'll first need to create a stream either through our Rest API or on the dashboard. Use the following steps: Create a new stream Copy the Stream name (UUID) Copy the Endpoint
Node Package Manager (npm)	Download and install from https://nodejs.org/en/download
http-server	(Optional) Simple, zero-configuration command-line static HTTP server The http-server is useful to explore the WebRTC client examples or the documentation locally when you do not have a host. To start the server, use the following command: http-server . -p 8081

Usage

Add the library as a dependency to your npm project using:

npm install @ceeblue/webrtc-client

Then import the library into your project with:

import * as WebRTC from '@ceeblue/webrtc-client';

💡 TIP

If your project uses TypeScript, it is recommended to set "target": "ES6" in your configuration to align with our usage of ES6 features and ensures that your build will succeed (for those requiring a backwards-compatible UMD version, a local build is advised). Then defining the compiler option "moduleResolution": "Node" in tsconfig.json helps with import errors by ensuring that TypeScript uses the correct strategy for resolving imports based on the targeted Node.js version.

{
   "compilerOptions": {
      "target": "ES6",
      "moduleResolution": "Node"
   }
}

Publish a stream

To publish the stream <streamName> to <endPoint>, use the Streamer class and the variables you saved while setting up the stream in the dashboard Requirements. For a full example, see push.html in Examples.

import { Streamer } from '@ceeblue/webrtc-client';

const streamer = new Streamer();
streamer.onStart = stream => {
   console.log('start streaming');
}
streamer.onStop = _ => {
   console.log('stop streaming');
}
const stream = await navigator.mediaDevices.getUserMedia({ audio: true, video: true });
streamer.start(stream, {
   endPoint: <endPoint>,
   streamName: <streamName>,
   iceServer: {
      urls: ['turn:' + <endPoint> + ':3478?transport=tcp', 'turn:' + <endPoint> + ':3478'],
      username: 'csc_demo', credential: 'UtrAFClFFO'
   }
});

Play a stream

To play the stream <streamName> from <endPoint>, use the Player class and the variables you saved while setting up the stream in the dashboard Requirements. For a full example, see play.html in Examples.

import { Player } from '@ceeblue/webrtc-client';

const player = new Player();

player.onStart = stream => {
   videoElement.srcObject = stream;
   console.log('start playing');
}
player.onStop = _ => {
   console.log('stop playing');
}
player.start({
   endPoint: <endPoint>,
   streamName: <streamName>,
   iceServer: {
      urls: ['turn:' + <endPoint> + ':3478?transport=tcp', 'turn:' + <endPoint> + ':3478'],
      username: 'csc_demo', credential: 'UtrAFClFFO'
   }
});

Examples

To understand how to use the library through examples, we provide three illustrations of its implementation:

• /examples/streamer.html → Publish a stream with your webcam
• /examples/player.html → Play a stream
• /examples/player-with-timed-metadata.html → Play a stream with timed metadata

• In your project directory, if you have installed the http-server service, execute the following command from the Terminal prompt by navigating to:

  http-server . -p 8081
  

• Navigate to the specified address in your browser, making sure to replace any placeholders in the URL with the variables you have copied during the stream setup in the dashboard.

  http://localhost:8081/examples/streamer.html?host=<endPoint>&stream=<streamName>
  

• Click on Start streaming. Upon doing so, a live stream from your webcam will initiate. Should your browser request permission to access your camera, ensure to grant it.

• In the address bar of a separate browser window, enter the following address, making sure to replace the placeholders in the URL with the variables you have copied while configuring the stream setup in the dashboard.

  http://localhost:8081/examples/player.html?host=<endPoint>&stream=<streamName>
  

• Click Play to start watching the live stream.

Building locally

• Clone this repository
• Enter the webrtc-client folder and run npm install to install packages dependencies.
• Execute npm run build. The output will be five files placed in the /dist/ folder:
  • webrtc-client.d.ts Typescript definitions file
  • webrtc-client.js: Bundled JavaScript library
  • webrtc-client.js.map: Source map that associates the bundled library with the original source files
  • webrtc-client.min.js Minified version of the library, optimized for size
  • webrtc-client.min.js.map Source map that associates the minified library with the original source files

git clone https://github.com/CeeblueTV/webrtc-client.git
cd webrtc-client
npm install
npm run build

💡 TIP

• To build a UMD (Universal Module Definition) version compatible with older browsers, you can run the following command:

  npm run build:es5
  

• To automatically build bundles when any modification has been applied, you can run a watch command. The watch command will continuously monitor your project files for changes and rebuild the bundles accordingly.

  npm run watch
  

  Or for ES5 (UMD):

  npm run watch:es5
  

Documentation

This monorepo also contains built-in documentation about the APIs in the library, which can be built using the following npm command:

npm run build:docs

You can access the documentation by opening the index.html file in the docs folder with your browser (./docs/index.html), or if you have installed and started the http-server service by navigating to:

http://localhost:8081/docs/

Contribution

All contributions are welcome. Please see our contribution guide for details.

License

By contributing code to this project, you agree to license your contribution under the GNU Affero General Public License.