@the-/rtc

RTC server for the-frameworks

Installation

$ npm install @the-/rtc --save

Usage

'use strict'

const { TheRTC } = require('@the-/rtc')

async function tryExample() {
  const rtc = new TheRTC({
    stun: {
      url: 'stun:stun.l.google.com:19302',
    },
    topology: 'mesh',
    turn: {
      expiry: 86400 * 1000,
      secret: 'xxxxxxxxxxxxxxxx',
      url: 'turn:your.turn.servers.here',
    },
  })

  const port = 3000
  await rtc.listen(port)
  console.log(`Example RTC Server listening: http://localhost:${port}`)
}

tryExample().catch((err) => console.error(err))

API Guide

• module:@the-/rtc
  • .constants
  • .create(args)
  • .default()
  • .helpers
  • .mixins
  • .TheRTC
• module:@the-/rtc.constants
  • .ChannelNames
  • .IOEvents
  • .PeerEvents
  • .TopologyTypes
• module:@the-/rtc.helpers
  • .handleUnknownKeys(unknowns,options=)
  • .parseTurnSecret(name,secret,expiry)
• module:@the-/rtc.mixins
  • .ioMix(Class)
  • .sfuMix(Class)
• global
  • SFUProxy
  • SFUProxyEdge
  • SFUProxyEdgeAnswerer
  • SFUProxyEdgeOfferer
  • SFUProxyPool

See API Guide for more detail

License

This software is released under the MIT License.

Links

• THE Labo