vroom-web-sdk-beta

Installation

Welcome to the Vroom WebRTC SDK documentation! This SDK provides developers with the tools to integrate real-time communication capabilities into their Node.js applications using WebRTC technology.

With Vroom WebRTC SDK, developers can build applications that enable peer-to-peer audio and video calls, screen sharing, and data sharing. This SDK simplifies the integration process by providing a set of APIs that handle the complexities of establishing and managing WebRTC connections.

Getting started with Vroom WebRTC SDK is easy! Simply follow the installation instructions to add the SDK to your Node.js project. Then, use the provided API reference to start building your application's WebRTC capabilities.

Vroom WebRTC SDK also includes sample applications that demonstrate the SDK's functionality, as well as tutorials that guide developers through building real-world use cases.

Thank you for choosing Vroom WebRTC SDK as your solution for integrating WebRTC into your Node.js application. We look forward to seeing the innovative real-time communication experiences you create!

YARN

yarn add @vroom/web-sdk

NPM

npm install @vroom/web-sdk

ReactJS usage

import VroomUI from 'vroomSDK/react'

function App() {
  const [ callStart, setCallStart ] = useState(false)
  const [ vroomState, setVroomState ] = useState(null)
  
  return (
    <>
      <VroomUI
        config={{
          sdkToken: '<sdk token>',
        }}
        displayName={'<user display name>'}
        ctlCallStart={callStart}
        getVroomState={setVroomState}
      />

    <button type="button" onClick={() => {setCallStart(true)}}>
      call start
    </button>
    </>
  )
}

export default App;

Contribute Installation

git clone https://gitlab.com/true-vroom/sdk/web-sdk

cd web-sdk

yarn install

/**
 * It will create /dist folder to bundule the package
 */
yarn build

/**
 * After build can go to web page for example
 */
cd examples

npm install

npm run start

Dev URL. http://localhost:3000