Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@webex/webrtc-core

webex12.6kMIT2.13.3TypeScript support: included

Handles the WebRTC core functionality and provides media helper function on browser.

readme

webrtc-core

Handles the WebRTC core functionality and provides media helper function on browser.

Development

  1. yarn
  2. yarn build
  3. yarn test
  4. yarn watch

Usage

This library uses cspell to check spelling throughout the codebase. Any words that need to be ignored (e.g., package names, protocols, etc.), should be added to the ignoreWords field in the cspell.json configuration file.

changelog

2.13.3 (2025-07-10)

Bug Fixes

2.13.2 (2025-06-30)

Bug Fixes

2.13.1 (2025-06-26)

Bug Fixes

2.13.0 (2025-06-02)

Features

  • getter for gathered ice candidates (#89) (cb1fa85)

2.12.0 (2025-02-04)

Features

2.11.0 (2025-01-24)

Features

  • upgrade to node 22 and yarn 1.22.22 (#87) (b7ab7a3)

2.10.3 (2024-09-20)

Bug Fixes

  • conditionally add device permissions (#86) (9e2d55a)

2.10.2 (2024-08-21)

Bug Fixes

  • node effects lib compatible with node 16 (#85) (1186086)

2.10.1 (2024-07-30)

Bug Fixes

2.10.0 (2024-07-11)

Features

2.9.0 (2024-07-10)

Features

2.8.0 (2024-06-18)

Features

  • expose getCurrentConnectionType with ConnectionType type (#80) (c9f8ad9)
  • pr to update release version (#79) (816c685)

2.7.0 (2024-04-17)

Features

  • expose on ice candidate event callback (#74) (c246686)

2.6.1 (2024-04-16)

Bug Fixes

  • dispose effects on call to LocalStream.stop (#75) (60205bc)

2.6.0 (2024-03-12)

Features

  • separate API for enabled and muted states (#72) (f4ce41d)

2.5.0 (2024-02-14)

Features

2.4.0 (2024-01-29)

Features

  • add custom method toJSON for _LocalStream (#70) (6ac5ba1)

2.3.1 (2024-01-19)

Bug Fixes

  • check muted property for mute getter (#69) (f07754c)

2.3.0 (2024-01-10)

Features

2.2.3 (2023-12-12)

Bug Fixes

  • handle invalid m-line with trailing whitespace (#67) (6f4fbdb)
  • rename error type enum (#66) (cc3473b)

2.2.2 (2023-12-11)

Bug Fixes

  • rename WcmeError to WebrtcCoreError (#65) (6a4078b)

2.2.1 (2023-10-12)

Bug Fixes

  • throw error in setLocalDescription if media line is missing codecs (#63) (ec5f257)

2.2.0 (2023-10-02)

Features

  • add id, readyState, and getAllEffects to stream classes (#62) (62deb74)

2.1.0 (2023-07-28)

Features

  • add generics to device management (#61) (adf048e)

2.0.0 (2023-07-19)

Features

  • convert track-based classes into stream-based classes (#60) (74089af)

BREAKING CHANGES

  • convert track-based classes into stream-based classes

1.7.1 (2023-06-02)

Bug Fixes

  • resolve system audio as null if unavailable (#54) (c90617b)

1.7.0 (2023-06-02)

Features

  • add support for getting slides audio (#53) (7b9fea4)

1.6.3 (2023-05-09)

Bug Fixes

  • keep track of loading effects and dispose them if unrequired after load (#48) (c3e8ebc)

1.6.2 (2023-04-19)

Bug Fixes

1.6.1 (2023-04-18)

Bug Fixes

1.6.0 (2023-04-13)

Features

  • add getEffects and fix disposeEffects to be async (#43) (f5117f2)

1.5.1 (2023-04-07)

Bug Fixes

1.5.0 (2023-03-29)

Features

  • add support for videocontenthint on display tracks (#39) (e4a1bb1)

1.4.1 (2023-03-27)

Bug Fixes

  • made create*Track() functions generic (#38) (5493d89)

1.4.0 (2023-03-06)

Bug Fixes

  • update disposeEffects doc (fa6d58b)

Features

  • Method named getNumActiveSimulcastLayers & event to LocalTrack for constraints changed (#35) (9298169)
  • support applying music mode constraints (#27) (081b8b2)

1.3.0 (2022-12-20)

Features

  • add the api for fetching the connection type (#20) (4e5fe55)

1.2.0 (2022-12-16)

Features

  • support for passing the config to the PeerConnection constructor (#19) (e4cc4a8)

1.1.1 (2022-12-06)

Bug Fixes

  • restore the original stream on disposing effects (#16) (981c1de)

1.1.0 (2022-11-28)

Features

1.0.2 (2022-11-18)

Bug Fixes

  • added export for ConnectionState (#10) (7258165)

1.0.1 (2022-11-15)

Bug Fixes

  • update doc for a force release (#9) (b19c913)

1.0.0 (2022-11-14)

Bug Fixes

  • commitlint rules for body (17d2057)
  • dependent package vulnerability (#62) (803f296)
  • disable integration tests (temporary) (#68) (75064a4)
  • enable sonar with quality gate check as part of build (#54) (ae10580)
  • fix import path (#27) (eee0d88)
  • fix the way we do exports (#19) (cc8cc85)
  • handle underlying track being undefined in addTransceiver (#35) (b9bbca6)
  • hookup cspell and eslint for lint-staged (#16) (ad42e8b)
  • make track class abstract and ensure correct track import path (#21) (3fdf38c)
  • media-stream-track param no longer optional (#31) (bf49615), closes #33
  • release initial package on @webex/webrt-core (d359d77)
  • remove blank testbed until needed and correct readme steps (#17) (e31de4f)
  • remove error logs (#44) (8a3817e)
  • remove redundant git remote (#52) (b6c2d33)
  • sonar fixes (#56) (6e7ce8a)
  • support ice gathering already being complete in getLocalDescriptionWithIceCandidates (#40) (e22429a)
  • update adapterjs (#70) (ce6a151)
  • update new npm org and registry (#57) (21b16f5)
  • update node to use v16 (#67) (4ea99a8)

Features

  • add getter for remote description (#66) (021b771)
  • add getunderlyingrtcpeerconnection method on peerconnection class (#64) (5abb6be)
  • add some more peer connection functionality (#34) (2058263)
  • add support for creating an rtcdatachannel (#15) (66d88b2)
  • added connection state handling (#8) (0c7c7e0)
  • enhance browser support (#59) (3e87bac)
  • events object on local-track class (#24) (53b4068)
  • export the datachannel options type (#60) (8c62610)
  • expose checkdevicepermissions method (#65) (41ed515)
  • import webrtc-adapter (#69) (7b3834f)
  • migrating the wcme track to webrtc core (bdee8c6)
  • peer connection events; helper functions (#23) (7fa6727)

1.0.0 (2022-10-14)

Bug Fixes

  • commitlint rules for body (17d2057)
  • dependent package vulnerability (#62) (803f296)
  • disable integration tests (temporary) (#68) (75064a4)
  • enable sonar with quality gate check as part of build (#54) (ae10580)
  • fix import path (#27) (eee0d88)
  • fix the way we do exports (#19) (cc8cc85)
  • handle underlying track being undefined in addTransceiver (#35) (b9bbca6)
  • hookup cspell and eslint for lint-staged (#16) (ad42e8b)
  • make track class abstract and ensure correct track import path (#21) (3fdf38c)
  • media-stream-track param no longer optional (#31) (bf49615), closes #33
  • release initial package on @webex/webrt-core (d359d77)
  • remove blank testbed until needed and correct readme steps (#17) (e31de4f)
  • remove error logs (#44) (8a3817e)
  • remove redundant git remote (#52) (b6c2d33)
  • sonar fixes (#56) (6e7ce8a)
  • support ice gathering already being complete in getLocalDescriptionWithIceCandidates (#40) (e22429a)
  • update adapterjs (#70) (ce6a151)
  • update new npm org and registry (#57) (21b16f5)
  • update node to use v16 (#67) (4ea99a8)

Features

  • add getter for remote description (#66) (021b771)
  • add getunderlyingrtcpeerconnection method on peerconnection class (#64) (5abb6be)
  • add some more peer connection functionality (#34) (2058263)
  • add support for creating an rtcdatachannel (#15) (66d88b2)
  • enhance browser support (#59) (3e87bac)
  • events object on local-track class (#24) (53b4068)
  • export the datachannel options type (#60) (8c62610)
  • expose checkdevicepermissions method (#65) (41ed515)
  • import webrtc-adapter (#69) (7b3834f)
  • migrating the wcme track to webrtc core (bdee8c6)
  • peer connection events; helper functions (#23) (7fa6727)

Bug Fixes

  • commitlint rules for body (17d2057)

Features

  • migrating the wcme track to webrtc core (bdee8c6)

1.7.0 (2022-10-14)

Bug Fixes

  • commitlint rules for body (17d2057)

Features

  • migrating the wcme track to webrtc core (bdee8c6)

Bug Fixes

  • update adapterjs
  • disable integration tests (temporary)
  • update node to use v16
  • dependent package vulnerability
  • update new npm org and registry
  • update new npm org and registry
  • sonar fixes
  • enable sonar with quality gate check as part of build
  • remove error logs
  • remove redundant git remote
  • fix import path
  • fix the way we do exports
  • handle underlying track being undefined in addTransceiver
  • hookup cspell and eslint for lint-staged
  • make track class abstract and ensure correct track import path
  • media-stream-track param no longer optional
  • remove blank testbed until needed and correct readme steps
  • support ice gathering already being complete in getLocalDescriptionWithIceCandidates

Features

  • import webrtc-adapter
  • add getter for remote description
  • expose checkdevicepermissions method
  • add getunderlyingrtcpeerconnection method on peerconnection class
  • enhance browser support
  • export the datachannel options type
  • add support for creating an rtcdatachannel
  • add some more peer connection functionality
  • events object on local-track class
  • peer connection events; helper functions