2.9.0 • Published 1 day ago

@antmedia/webrtc_adaptor v2.9.0

Weekly downloads
-
License
ISC
Repository
github
Last release
1 day ago

Ant Media Server WebRTC SDK

WebSocket interface in publishing and playing WebRTC streams on Ant Media Server using Javascript.

For more information, visit antmedia.io

NPM version Build Status Quality Gate Status

Installation

Using npm:

$ npm install @antmedia/webrtc_adaptor

Using yarn:

$ yarn add @antmedia/webrtc_adaptor

Requirements

Before start using Ant Media Server WebRTC SDK, you need a distribution of the Ant Media Server running on a server or local machine. Quick Start - Ant Media Server

Usage

In your project, run:

npm i @antmedia/webrtc_adaptor --save-dev

Then inside your javascript file:

Initialize the WebRTCAdaptor

  // ...
import { WebRTCAdaptor } from '@antmedia/webrtc_adaptor';

const webRTCAdaptor = new WebRTCAdaptor({
    websocket_url: "wss://your-domain.tld:5443/WebRTCAppEE/websocket",
    mediaConstraints: {
        video: true,
        audio: true,
    },
    peerconnection_config: {
        'iceServers': [{'urls': 'stun:stun1.l.google.com:19302'}]
    },
    sdp_constraints: {
        OfferToReceiveAudio : false,
        OfferToReceiveVideo : false,
    },
    localVideoId: "id-of-video-element", // <video id="id-of-video-element" autoplay muted></video>
    bandwidth: int|string, // default is 900 kbps, string can be 'unlimited'
    dataChannelEnabled: true|false, // enable or disable data channel
    callback: (info, obj) => {}, // check info callbacks bellow
    callbackError: function(error, message) {}, // check error callbacks bellow
});
//...

In another part of your script:

Publish

// You can start streaming by calling the publish method
webRTCAdaptor.publish(streamId);

Play

// You can start streaming by calling the publish method
webRTCAdaptor.play(streamId);

Samples

Visit The [Samples List](https://resources.antmedia.io/docs/sample-tools-and-applications) and look at their [sources codes](https://github.com/ant-media/StreamApp/tree/master/src/main/webapp)

Documentation

[Javascript SDK Documentation](https://resources.antmedia.io/docs/javascript-sdk)

Live Demo

You can check our [live demo](https://antmedia.io/live-demo).

Issues

Create issues on the [Ant-Media-Server](https://github.com/ant-media/Ant-Media-Server/issues)

2.9.0

1 month ago

2.8.2

3 months ago

2.8.1

3 months ago

2.8.0

4 months ago

2.8.0-SNAPSHOT

4 months ago

2.7.0

6 months ago

2.6.3

9 months ago

2.6.4

9 months ago

2.6.1

11 months ago

2.6.2

11 months ago

2.6.0

12 months ago

2.5.3

1 year ago

2.5.1

2 years ago

2.4.4-SNAPSHOT

2 years ago

2.4.3

2 years ago

2.4.2-SNAPSHOT

2 years ago

2.4.1-SNAPSHOT

2 years ago

2.4.1

2 years ago

2.4.2

2 years ago

2.4.2-latest

2 years ago

2.3.2

3 years ago