https://github.com/rtc-io/rtc-core

Core definitions and functions for the rtc.io suite
https://github.com/rtc-io/rtc-core

Last synced: 4 months ago
JSON representation

Core definitions and functions for the rtc.io suite

• Host: GitHub
• URL: https://github.com/rtc-io/rtc-core
• Owner: rtc-io
• License: apache-2.0
• Created: 2013-07-26T02:32:54.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2022-08-29T05:24:01.000Z (almost 2 years ago)
• Last Synced: 2023-11-11T07:40:31.709Z (8 months ago)
• Language: JavaScript
• Homepage: http://www.rtc.io/modules.html
• Size: 66.4 KB
• Stars: 12
• Watchers: 4
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-peer-to-peer - rtc-core
• awesome-peer-to-peer - rtc-core
• starred-awesome - rtc-core - Core definitions and functions for the rtc.io suite (JavaScript)
• awesome-peer-to-peer - rtc-core

README

        
# rtc-core

The rtc-core package includes a number of core types and constants that

are used across the rtc.io suite.

[![NPM](https://nodei.co/npm/rtc-core.png)](https://nodei.co/npm/rtc-core/)

[![Build Status](https://img.shields.io/travis/rtc-io/rtc-core.svg?branch=master)](https://travis-ci.org/rtc-io/rtc-core) [![unstable](https://img.shields.io/badge/stability-unstable-yellowgreen.svg)](https://github.com/dominictarr/stability#unstable) 

### `rtc-core/detect`

A browser detection helper for accessing prefix-free versions of the various

WebRTC types.

### Example Usage

If you wanted to get the native `RTCPeerConnection` prototype in any browser

you could do the following:

```js

var detect = require('rtc-core/detect'); // also available in rtc/detect

var RTCPeerConnection = detect('RTCPeerConnection');

```

This would provide whatever the browser prefixed version of the

RTCPeerConnection is available (`webkitRTCPeerConnection`,

`mozRTCPeerConnection`, etc).

### `rtc-core/genice`

Respond appropriately to options that are passed to packages like

`rtc-quickconnect` and trigger a `callback` (error first) with iceServer

values.

The function looks for either of the following keys in the options, in

the following order or precedence:

1. `ice` - this can either be an array of ice server values or a generator

   function (in the same format as this function).  If this key contains a

   value then any servers specified in the `iceServers` key (2) will be

   ignored.

2. `iceServers` - an array of ice server values.

### `rtc-core/reset`

This is a simple, cross-browser method for resetting a media element

back to a initial state after having media attached.

### `rtc-core/wait-connected`

`waitConnected(pc, callback)`

A simple helper function that will monitor `iceconnectionstatechange` events

and wait until a connected `iceConnectionState` has been triggered (either

`connected` or `completed`).  Once this state has been achieved the event

listener will be removed and a callback fired.

## License(s)

### Apache 2.0

Copyright 2013 - 2014 National ICT Australia Limited (NICTA)

   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.