TT#2723 Added usage docs

Change-Id: Id54438349d1c82565952a6fbb12c199d4ae3a2f2
changes/33/9433/1
Hans-Peter Herzog 9 years ago
parent 1aa0d1053a
commit e2e9cddf98

@ -5,13 +5,13 @@ Node.js client that implements a subset of the WebSocket interface of the Janus
Note: For now it supports the videoroom plugin only.
## Setup
## Initial setup
```javascript
var JanusVideoroomClient = require('janus-videoroom-client').Janus;
```
#### Without authentication
Without authentication
```javascript
var client = new JanusVideoroomClient({
@ -19,7 +19,7 @@ var client = new JanusVideoroomClient({
});
```
#### Token based authentication
Token based authentication
```javascript
var client = new JanusVideoroomClient({
@ -28,7 +28,7 @@ var client = new JanusVideoroomClient({
});
```
#### Static secret authentication
Static secret authentication
```javascript
var client = new JanusVideoroomClient({
@ -37,6 +37,30 @@ var client = new JanusVideoroomClient({
});
```
## Usage
Create a new janus session
```javascript
client.createSession().then((session)=>{
...
}).catch((err)=>{
...
});
```
Create a new videoroom handle
```javascript
client.createSession().then((session)=>{
return session.createVideoRoomHandle();
}).then((handle)=>{
...
}).catch((err)=>{
...
});
```
## Run tests
npm test

@ -1,6 +1,6 @@
{
"name": "janus-videoroom-client",
"version": "2.0.0",
"version": "2.0.1",
"main": "src/janus.js",
"scripts": {
"test": "mocha -R spec --full-trace test/*-spec.js"

Loading…
Cancel
Save