genesys-cloud-webrtc-sdk

Genesys Cloud WebRTC SDK

Overview

The Genesys Cloud WebRTC SDK is a client library for connecting to Genesys Cloud WebRTC services. Supported WebRTC Features:

• WebRTC SoftPhone (Authenticated Business User/Agent Telephony - inbound/outbound, etc)
• WebRTC Screen Share (Unauthenticated User/Guest)
• WebRTC Video (Authenticated Business User)

Demo: https://sdk-cdn.mypurecloud.com/webrtc-sdk/demo/webpack/

• Demo requires Genesys Cloud Credentials for video. Organization id and security key are required for unauthenticated screen share.

Not yet supported:

• WebRTC Video (Unauthenticated User/Guest)
• WebRTC Screen Share (Authenticated Business User/Agent Telephony)
• WebRTC Screen Recording
• WebRTC Click-to-Call (Unauthenticated user SoftPhone, Telephony)

Installation

# npm
npm install --save genesys-cloud-webrtc-sdk
# yarn
yarn genesys-cloud-webrtc-sdk

See documentation for usage and implementation details.

Documentation

Documentation is available in the documentation of this repository and on the Genesys Cloud Developer Center at DeveloperCenter.

Note: due to the constant development on the SDK, it is recommended to always reference the documentation in this repository as that will always be the most up-to-date information regarding the SDK. There can be delays in the updating of documentation on the Developer Center.

Contributing

This repo uses typescript semistandard for code style and Jest for tests and code coverage.

To get started in development:

npm install
npm run test:watch

Test will rebuild as source or tests change. All linting and tests must pass 100%, and coverage should remain at 100%.

Testing

Run the tests using npm test in the command line

Changelog

v11.0.0

Breaking Changes

• Lru-cache was upgraded from v6 to v11 in a dependency (genesys-cloud-streaming-client), which uses newer language features. Depending on your language target version, you may need to configure a transpiler accordingly. For example, we added plugin-transform-private-methods to our Babel config for the SDK.

Changed

• STREAM-314 - On streaming-client disconnected events, emit the value of autoReconnect so that consumers can determine if they should tear down their SDK or wait for streaming-client to reconnect. Updated docs to reflect this.

Added

• PCM-2081 - Add ability to join a video conference using a meeting id