https://github.com/mslosarz/nextrtc-js-client

JavaScript client written for NextRTC signaling server
https://github.com/mslosarz/nextrtc-js-client

nextrtc webrtc webrtc-javascript-library webrtc-libraries

Last synced: 4 months ago
JSON representation

JavaScript client written for NextRTC signaling server

• Host: GitHub
• URL: https://github.com/mslosarz/nextrtc-js-client
• Owner: mslosarz
• License: mit
• Created: 2014-11-02T15:15:08.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2018-09-08T12:34:21.000Z (over 6 years ago)
• Last Synced: 2024-04-14T12:01:34.741Z (10 months ago)
• Topics: nextrtc, webrtc, webrtc-javascript-library, webrtc-libraries
• Language: JavaScript
• Homepage: https://nextrtc.org
• Size: 57.6 KB
• Stars: 13
• Watchers: 4
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# NextRTC JavaScript client

NextRTC js client constructor requires:

* **wsURL** which should points to your endpoint `{ws/wss}://{host}:{port}/{applicationName}/{endpointGivenInAnnotation}`

endpointGivenInAnnotation e.g. – @ServerEndpoint(value = “/signaling” …)

* **mediaConfig** are passed straight to adapter, so more information about parametres you can find in webrtc/adapter documentation.

* **peerConfig** are also described in [webrtc/adapter](https://github.com/webrtc/adapter) project.

Example is shown below and it’s also available in [nextrtc-sample-webapp](https://github.com/mslosarz/nextrtc-sample-webapp)

```js

new NextRTC({

    wsURL : 'wss://examples.nextrtc.org/videochat/signaling',

    mediaConfig : {

        video : true,

        audio : true,

    },

    peerConfig : {

        'iceServers' : [ {

            url : "stun:stun.l.google.com:19302"

        }]

    }

}/*, optional DEBUG mode /true or false/*/);

```

## How to use nextrtc-js-client on static page?

 

When page will be fully loaded you should create nextrtc object.

If you don’t know when your page is fully loaded you can use override method NextRTC.onReady (this way of use is presented in example).

When you create NextRTC object you have to provide function which will be called when event happens.

To register function you have to call method on() as presented in snipped:

```js

var nextRTC = new NextRTC({

    ...

});

nextRTC.on('{eventName}', function(event:Event){

    

});

```

There are two signals which are providing other second parameter type. Those signals are:

`localStream` and `remoteStream`, when you are handling local audio/video stream and incoming audio/video stream you can simply attach stream to valid element (without additional action like resolving stream by description provided in event).

```js

nextRTC.on('{localStream|remoteStream}', function({stream: Stream, member: memberId}){

});

```

## How to send / handle custom signals?

On the js side you have to write two methods. One for sending new signal

```js

NextRTC.prototype.upperCase = function upperCase(content, custom) {

    this.channel.send({signal: 'upperCase', content: 'content', custom: custom});

}; 

```

second one which will react on the response:

```js

nextRTC.on('upperCase', content => {

// here you should handle the response

});

```

Then you will be able to use structure like this to post your custom signal:

```js

nexrtc.upperCase('lowerCase');

```

## Model

Event structure and available events are presented [here](https://github.com/mslosarz/nextrtc-signaling-server)

Event is serialized java version of message.