{"_id":"@belivvr/livekit-client","_rev":"1-6aebbabf9f49aefc2d3cc1874f5f85e8","name":"@belivvr/livekit-client","dist-tags":{"latest":"1.5.0"},"versions":{"1.5.0":{"name":"@belivvr/livekit-client","version":"1.5.0","description":"JavaScript/TypeScript client SDK for LiveKit","main":"./dist/@belivvr/livekit-client.umd.js","unpkg":"./dist/@belivvr/livekit-client.umd.js","module":"./dist/@belivvr/livekit-client.esm.mjs","exports":{"types":"./dist/src/index.d.ts","import":"./dist/@belivvr/livekit-client.esm.mjs","require":"./dist/@belivvr/livekit-client.umd.js"},"types":"dist/@belivvr/src/index.d.ts","typesVersions":{"<4.8":{"./dist/@belivvr/src/index.d.ts":["./dist/@belivvr/src/ts4.2/index.d.ts"]}},"repository":{"type":"git","url":"git@github.com:livekit/client-sdk-js.git"},"author":{"name":"David Zhao","email":"david@davidzhao.com"},"license":"Apache-2.0","scripts":{"build":"rollup --config && yarn downlevel-dts","build:watch":"rollup --watch --config rollup.config.js","build-docs":"typedoc","proto":"protoc --plugin=node_modules/ts-proto/protoc-gen-ts_proto --ts_proto_opt=esModuleInterop=true --ts_proto_out=./src/proto --ts_proto_opt=outputClientImpl=false,useOptionals=messages,oneof=unions -I./protocol ./protocol/livekit_rtc.proto ./protocol/livekit_models.proto","sample":"vite serve example --port 8080 --open","lint":"eslint src","test":"jest","deploy":"gh-pages -d example/dist","format":"prettier --write src example/sample.ts","format:check":"prettier --check src","release":"yarn build && changeset publish","downlevel-dts":"downlevel-dts ./dist/ ./dist/ts4.2 --to=4.2"},"dependencies":{"async-await-queue":"^1.2.1","events":"^3.3.0","loglevel":"^1.8.0","protobufjs":"^7.0.0","sdp-transform":"^2.14.1","ts-debounce":"^4.0.0","typed-emitter":"^2.1.0","ua-parser-js":"^1.0.2","webrtc-adapter":"^8.1.1"},"devDependencies":{"@babel/core":"7.20.2","@babel/preset-env":"7.20.2","@changesets/changelog-github":"0.4.7","@changesets/cli":"2.25.2","@rollup/plugin-babel":"6.0.2","@rollup/plugin-commonjs":"23.0.2","@rollup/plugin-json":"5.0.1","@rollup/plugin-node-resolve":"14.1.0","@types/jest":"29.2.2","@types/sdp-transform":"2.4.5","@types/ua-parser-js":"0.7.36","@types/ws":"8.5.3","@typescript-eslint/eslint-plugin":"5.42.0","@typescript-eslint/parser":"5.42.0","downlevel-dts":"^0.11.0","eslint":"8.27.0","eslint-config-airbnb-typescript":"17.0.0","eslint-config-prettier":"8.5.0","eslint-plugin-import":"2.26.0","gh-pages":"4.0.0","jest":"29.2.2","prettier":"2.7.1","rollup":"2.79.1","rollup-plugin-delete":"^2.0.0","rollup-plugin-filesize":"9.1.2","rollup-plugin-re":"1.0.7","rollup-plugin-terser":"7.0.2","rollup-plugin-typescript2":"0.34.1","ts-jest":"29.0.3","ts-proto":"1.131.0","typedoc":"0.23.20","typedoc-plugin-no-inherit":"1.4.0","typescript":"4.8.4","vite":"3.2.3"},"browserslist":["safari >= 11","ios_saf >= 11","chrome >= 64","and_chr >= 64","android >= 64","firefox >= 53","and_ff >= 53","edge >= 79","Opera >= 52","Samsung >= 9.2","not IE 11","not dead"],"licenseText":"\n                                 Apache License\n                           Version 2.0, January 2004\n                        http://www.apache.org/licenses/\n\n   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n   1. Definitions.\n\n      \"License\" shall mean the terms and conditions for use, reproduction,\n      and distribution as defined by Sections 1 through 9 of this document.\n\n      \"Licensor\" shall mean the copyright owner or entity authorized by\n      the copyright owner that is granting the License.\n\n      \"Legal Entity\" shall mean the union of the acting entity and all\n      other entities that control, are controlled by, or are under common\n      control with that entity. For the purposes of this definition,\n      \"control\" means (i) the power, direct or indirect, to cause the\n      direction or management of such entity, whether by contract or\n      otherwise, or (ii) ownership of fifty percent (50%) or more of the\n      outstanding shares, or (iii) beneficial ownership of such entity.\n\n      \"You\" (or \"Your\") shall mean an individual or Legal Entity\n      exercising permissions granted by this License.\n\n      \"Source\" form shall mean the preferred form for making modifications,\n      including but not limited to software source code, documentation\n      source, and configuration files.\n\n      \"Object\" form shall mean any form resulting from mechanical\n      transformation or translation of a Source form, including but\n      not limited to compiled object code, generated documentation,\n      and conversions to other media types.\n\n      \"Work\" shall mean the work of authorship, whether in Source or\n      Object form, made available under the License, as indicated by a\n      copyright notice that is included in or attached to the work\n      (an example is provided in the Appendix below).\n\n      \"Derivative Works\" shall mean any work, whether in Source or Object\n      form, that is based on (or derived from) the Work and for which the\n      editorial revisions, annotations, elaborations, or other modifications\n      represent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof.\n\n      \"Contribution\" shall mean any work of authorship, including\n      the original version of the Work and any modifications or additions\n      to that Work or Derivative Works thereof, that is intentionally\n      submitted to Licensor for inclusion in the Work by the copyright owner\n      or by an individual or Legal Entity authorized to submit on behalf of\n      the copyright owner. For the purposes of this definition, \"submitted\"\n      means any form of electronic, verbal, or written communication sent\n      to the Licensor or its representatives, including but not limited to\n      communication on electronic mailing lists, source code control systems,\n      and issue tracking systems that are managed by, or on behalf of, the\n      Licensor for the purpose of discussing and improving the Work, but\n      excluding communication that is conspicuously marked or otherwise\n      designated in writing by the copyright owner as \"Not a Contribution.\"\n\n      \"Contributor\" shall mean Licensor and any individual or Legal Entity\n      on behalf of whom a Contribution has been received by Licensor and\n      subsequently incorporated within the Work.\n\n   2. Grant of Copyright License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      copyright license to reproduce, prepare Derivative Works of,\n      publicly display, publicly perform, sublicense, and distribute the\n      Work and such Derivative Works in Source or Object form.\n\n   3. Grant of Patent License. Subject to the terms and conditions of\n      this License, each Contributor hereby grants to You a perpetual,\n      worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n      (except as stated in this section) patent license to make, have made,\n      use, offer to sell, sell, import, and otherwise transfer the Work,\n      where such license applies only to those patent claims licensable\n      by such Contributor that are necessarily infringed by their\n      Contribution(s) alone or by combination of their Contribution(s)\n      with the Work to which such Contribution(s) was submitted. If You\n      institute patent litigation against any entity (including a\n      cross-claim or counterclaim in a lawsuit) alleging that the Work\n      or a Contribution incorporated within the Work constitutes direct\n      or contributory patent infringement, then any patent licenses\n      granted to You under this License for that Work shall terminate\n      as of the date such litigation is filed.\n\n   4. Redistribution. You may reproduce and distribute copies of the\n      Work or Derivative Works thereof in any medium, with or without\n      modifications, and in Source or Object form, provided that You\n      meet the following conditions:\n\n      (a) You must give any other recipients of the Work or\n          Derivative Works a copy of this License; and\n\n      (b) You must cause any modified files to carry prominent notices\n          stating that You changed the files; and\n\n      (c) You must retain, in the Source form of any Derivative Works\n          that You distribute, all copyright, patent, trademark, and\n          attribution notices from the Source form of the Work,\n          excluding those notices that do not pertain to any part of\n          the Derivative Works; and\n\n      (d) If the Work includes a \"NOTICE\" text file as part of its\n          distribution, then any Derivative Works that You distribute must\n          include a readable copy of the attribution notices contained\n          within such NOTICE file, excluding those notices that do not\n          pertain to any part of the Derivative Works, in at least one\n          of the following places: within a NOTICE text file distributed\n          as part of the Derivative Works; within the Source form or\n          documentation, if provided along with the Derivative Works; or,\n          within a display generated by the Derivative Works, if and\n          wherever such third-party notices normally appear. The contents\n          of the NOTICE file are for informational purposes only and\n          do not modify the License. You may add Your own attribution\n          notices within Derivative Works that You distribute, alongside\n          or as an addendum to the NOTICE text from the Work, provided\n          that such additional attribution notices cannot be construed\n          as modifying the License.\n\n      You may add Your own copyright statement to Your modifications and\n      may provide additional or different license terms and conditions\n      for use, reproduction, or distribution of Your modifications, or\n      for any such Derivative Works as a whole, provided Your use,\n      reproduction, and distribution of the Work otherwise complies with\n      the conditions stated in this License.\n\n   5. Submission of Contributions. Unless You explicitly state otherwise,\n      any Contribution intentionally submitted for inclusion in the Work\n      by You to the Licensor shall be under the terms and conditions of\n      this License, without any additional terms or conditions.\n      Notwithstanding the above, nothing herein shall supersede or modify\n      the terms of any separate license agreement you may have executed\n      with Licensor regarding such Contributions.\n\n   6. Trademarks. This License does not grant permission to use the trade\n      names, trademarks, service marks, or product names of the Licensor,\n      except as required for reasonable and customary use in describing the\n      origin of the Work and reproducing the content of the NOTICE file.\n\n   7. Disclaimer of Warranty. Unless required by applicable law or\n      agreed to in writing, Licensor provides the Work (and each\n      Contributor provides its Contributions) on an \"AS IS\" BASIS,\n      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n      implied, including, without limitation, any warranties or conditions\n      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n      PARTICULAR PURPOSE. You are solely responsible for determining the\n      appropriateness of using or redistributing the Work and assume any\n      risks associated with Your exercise of permissions under this License.\n\n   8. Limitation of Liability. In no event and under no legal theory,\n      whether in tort (including negligence), contract, or otherwise,\n      unless required by applicable law (such as deliberate and grossly\n      negligent acts) or agreed to in writing, shall any Contributor be\n      liable to You for damages, including any direct, indirect, special,\n      incidental, or consequential damages of any character arising as a\n      result of this License or out of the use or inability to use the\n      Work (including but not limited to damages for loss of goodwill,\n      work stoppage, computer failure or malfunction, or any and all\n      other commercial damages or losses), even if such Contributor\n      has been advised of the possibility of such damages.\n\n   9. Accepting Warranty or Additional Liability. While redistributing\n      the Work or Derivative Works thereof, You may choose to offer,\n      and charge a fee for, acceptance of support, warranty, indemnity,\n      or other liability obligations and/or rights consistent with this\n      License. However, in accepting such obligations, You may act only\n      on Your own behalf and on Your sole responsibility, not on behalf\n      of any other Contributor, and only if You agree to indemnify,\n      defend, and hold each Contributor harmless for any liability\n      incurred by, or claims asserted against, such Contributor by reason\n      of your accepting any such warranty or additional liability.\n","_id":"@belivvr/livekit-client@1.5.0","dist":{"shasum":"4ff51efbf05e14d0ef2ad235d55b0d669f4ce05a","integrity":"sha512-z+KhIMehA9c1R1N7iX9pOH0qMiyeslYnVxCHguGJl79yCkcsqbSguMwIgbp7ZaVLIayd7M+cICEjpOOJ5Sq7wQ==","tarball":"https://registry.npmjs.org/@belivvr/livekit-client/-/livekit-client-1.5.0.tgz","fileCount":242,"unpackedSize":5828938,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIE59akATR2NkffAnFb5XPhwgzKtlhKcN+RAfGQEc5qAHAiEAhIosL5LbxGCWbiDSUZBMvyFsZa5vBBztn1Sz6Oz5+Zw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjd0RfACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqb3w/+KN9pjZqt+GVP6LilYO3vfj/39lHnR+48Xb3BopYsBhEPUc/B\r\nTnhXvLwLHJJv2s10QFqJFT28IgVnEykkc/Pv1HU9YNxA2umXjHVM+AZeAZFn\r\n4nehSyMHJsSqP4EsdbtUW/AzuYsMwVM+p+cMN1gF2T/KzOSV7CkZ4uMc+OOa\r\nbAR9g7L3BgjLklEowO3SVt7ejv0S+brY1FhRfaxI2+ZrAe16kY4iOM+6T0Sn\r\n+EFPckALZgl3qTrTcegs59BE5PnH/BoHz8QTYYp+Kt53qCFtXRrWkV2Nl8m5\r\nykDrqAxm8AuDwsQD6T2sLudXpd+OD6lGOTNfZRP9RW55lkDVMbo9BHJ84XSw\r\n65Yk2iRUkd3n4WjzyNXSC2HBbndembffPJzm5SkhNV3iIVYQ10bZWpSY7SUJ\r\nLUiMYJccFkmlZIhZGaeQJgCaPWypZSwIxq5IvwT21e91Yq3d+gOmsV0SAq7v\r\nJAXL8kOdK5Pu89EQCMlrGIK0U8ya9UK9cS7SgGtrGpKiHGW+N352Mx4tUnTf\r\nPM8+4USFfqsOYOk6mSKapD5kxosJLZU0KRRw2aajxrBmHI/JbUUHa6m/SebL\r\nHuIhtzlc+WIsY+NLeNXAUqQ+ge9ies/gUSS/ZZh9FcVMJhI4TEoFOrh5v6X2\r\nT1WVE0C73cnSSF/MMDMAirS+Aw7TDp79B9Y=\r\n=LRCm\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"juunini","email":"juuni.ni.i@gmail.com"},"directories":{},"maintainers":[{"name":"juunini","email":"juuni.ni.i@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/livekit-client_1.5.0_1668760671149_0.2583492649504253"},"_hasShrinkwrap":false,"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2022-11-18T08:37:51.081Z","1.5.0":"2022-11-18T08:37:51.464Z","modified":"2023-08-18T01:51:34.893Z"},"maintainers":[{"name":"juunini","email":"juuni.ni.i@gmail.com"}],"description":"JavaScript/TypeScript client SDK for LiveKit","repository":{"type":"git","url":"git@github.com:livekit/client-sdk-js.git"},"author":{"name":"David Zhao","email":"david@davidzhao.com"},"license":"Apache-2.0","readme":"# JavaScript/TypeScript client SDK for LiveKit\n\n`livekit-client` is the official client SDK for [LiveKit](https://github.com/livekit/livekit-server). With it, you can add real time video and audio to your web apps.\n\n## Docs\n\nDocs and guides at [https://docs.livekit.io](https://docs.livekit.io)\n\n[SDK reference](https://docs.livekit.io/client-sdk-js/)\n\n## Installation\n\n### Yarn\n\n```shell\nyarn add livekit-client\n```\n\n### NPM\n\n```shell\nnpm install livekit-client --save\n```\n\n## Usage\n\nExamples below are in TypeScript, if using JS/CommonJS imports replace import with:\n\n```javascript\nconst livekit = require('livekit-client');\n\nconst room = new livekit.Room(...);\nawait room.connect(...);\n```\n\n### Connecting to a room, publish video & audio\n\n```typescript\nimport {\n  connect,\n  Room,\n  RoomEvent,\n  RemoteParticipant,\n  RemoteTrackPublication,\n  RemoteTrack,\n  Participant,\n} from 'livekit-client';\n\n// creates a new room with options\nconst room = new Room({\n  // automatically manage subscribed video quality\n  adaptiveStream: true,\n\n  // optimize publishing bandwidth and CPU for published tracks\n  dynacast: true,\n\n  // default capture settings\n  videoCaptureDefaults: {\n    resolution: VideoPresets.h720.resolution,\n  },\n});\n\n// set up event listeners\nroom\n  .on(RoomEvent.TrackSubscribed, handleTrackSubscribed)\n  .on(RoomEvent.TrackUnsubscribed, handleTrackUnsubscribed)\n  .on(RoomEvent.ActiveSpeakersChanged, handleActiveSpeakerChange)\n  .on(RoomEvent.Disconnected, handleDisconnect)\n  .on(RoomEvent.LocalTrackUnpublished, handleLocalTrackUnpublished);\n\n// connect to room\nawait room.connect('ws://localhost:7800', token);\nconsole.log('connected to room', room.name);\n\n// publish local camera and mic tracks\nawait room.localParticipant.enableCameraAndMicrophone();\n\nfunction handleTrackSubscribed(\n  track: RemoteTrack,\n  publication: RemoteTrackPublication,\n  participant: RemoteParticipant,\n) {\n  if (track.kind === Track.Kind.Video || track.kind === Track.Kind.Audio) {\n    // attach it to a new HTMLVideoElement or HTMLAudioElement\n    const element = track.attach();\n    parentElement.appendChild(element);\n  }\n}\n\nfunction handleTrackUnsubscribed(\n  track: RemoteTrack,\n  publication: RemoteTrackPublication,\n  participant: RemoteParticipant,\n) {\n  // remove tracks from all attached elements\n  track.detach();\n}\n\nfunction handleLocalTrackUnpublished(track: LocalTrackPublication, participant: LocalParticipant) {\n  // when local tracks are ended, update UI to remove them from rendering\n  track.detach();\n}\n\nfunction handleActiveSpeakerChange(speakers: Participant[]) {\n  // show UI indicators when participant is speaking\n}\n\nfunction handleDisconnect() {\n  console.log('disconnected from room');\n}\n```\n\nIn order to connect to a room, you need to first create an access token.\n\nSee [access token docs](https://docs.livekit.io/guides/access-tokens) for details\n\n### Handling common track types\n\nWhile LiveKit is designed to be flexible, we've added a few shortcuts that makes working with common track types simple. For a user's camera, microphone, and screen share, you can enable them with the following `LocalParticipant` methods:\n\n```typescript\nconst p = room.localParticipant;\n// turn on the local user's camera and mic, this may trigger a browser prompt\n// to ensure permissions are granted\nawait p.setCameraEnabled(true);\nawait p.setMicrophoneEnabled(true);\n\n// start sharing the user's screen, this will trigger a browser prompt to select\n// the screen to share.\nawait p.setScreenShareEnabled(true);\n\n// disable camera to mute them, when muted, the user's camera indicator will be turned off\nawait p.setCameraEnabled(false);\n```\n\nSimilarly, you can access these common track types on the other participants' end.\n\n```typescript\n// get a RemoteParticipant by their sid\nconst p = room.participants.get('participant-sid');\nif (p) {\n  // if the other user has enabled their camera, attach it to a new HTMLVideoElement\n  if (p.isCameraEnabled) {\n    const track = p.getTrack(Track.Source.Camera);\n    if (track?.isSubscribed) {\n      const videoElement = track.videoTrack?.attach();\n      // do something with the element\n    }\n  }\n}\n```\n\n### Creating a track prior to creating a room\n\nIn some cases, it may be useful to create a track before creating a room. For\nexample, when building a staging area so the user may check their own camera.\n\nYou can use our global track creation functions for this:\n\n```typescript\nconst tracks = await createLocalTracks({\n  audio: true,\n  video: true,\n});\n```\n\n### Publish tracks from any source\n\nLiveKit lets you publish any track as long as it can be represented by a MediaStreamTrack. You can specify a name on the track in order to identify it later.\n\n```typescript\nconst pub = await room.localParticipant.publishTrack(mediaStreamTrack, {\n  name: 'mytrack',\n  simulcast: true,\n  // if this should be treated like a camera feed, tag it as such\n  // supported known sources are .Camera, .Microphone, .ScreenShare\n  source: Track.Source.Camera,\n});\n\n// you may mute or unpublish the track later\npub.setMuted(true);\n\nroom.localParticipant.unpublishTrack(mediaStreamTrack);\n```\n\n### Device management APIs\n\nUsers may have multiple input and output devices available. LiveKit will automatically use the one that's deemed as the `default` device on the system. You may also list and specify an alternative device to use.\n\nWe use the same deviceId as one returned by [MediaDevices.enumerateDevices()](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/enumerateDevices).\n\n#### Example listing and selecting a camera device\n\n```typescript\n// list all microphone devices\nconst devices = await Room.getLocalDevices('audioinput');\n\n// select last device\nconst device = devices[devices.length - 1];\n\n// in the current room, switch to the selected device and set\n// it as default audioinput in the future.\nawait room.switchActiveDevice('audioinput', device.deviceId);\n```\n\nYou can also switch devices given a constraint. This could be useful on mobile devices to switch to a back-facing camera:\n\n```typescript\nawait videoTrack.restartTrack({\n  facingMode: 'environment',\n});\n```\n\n#### Handling device failures\n\nWhen creating tracks using LiveKit APIs (`connect`, `createLocalTracks`, `setCameraEnabled`, etc), it's possible to encounter errors with the underlying media device. In those cases, LiveKit will emit `RoomEvent.MediaDevicesError`.\n\nYou can use the helper `MediaDeviceFailure.getFailure(error)` to determine specific reason for the error.\n\n- `PermissionDenied` - the user disallowed capturing devices\n- `NotFound` - the particular device isn't available\n- `DeviceInUse` - device is in use by another process (happens on Windows)\n\nThese distinctions enables you to provide more specific messaging to the user.\n\nYou could also retrieve the last error with `LocalParticipant.lastCameraError` and `LocalParticipant.lastMicrophoneError`.\n\n### Audio playback\n\nBrowsers can be restrictive with regards to audio playback that is not initiated by user interaction. What each browser considers as user interaction can vary by vendor (for example, Safari on iOS is very restrictive).\n\nLiveKit will attempt to autoplay all audio tracks when you attach them to audio elements. However, if that fails, we'll notify you via `RoomEvent.AudioPlaybackStatusChanged`. `Room.canPlayAudio` will indicate if audio playback is permitted. LiveKit takes an optimistic approach so it's possible for this value to change from `true` to `false` when we encounter a browser error.\n\nIn the case user interaction is required, LiveKit provides `Room.startAudio` to start audio playback. This function must be triggered in an onclick or ontap event handler. In the same session, once audio playback is successful, additional audio tracks can be played without further user interactions.\n\n```typescript\nroom.on(RoomEvent.AudioPlaybackStatusChanged, () => {\n  if (!room.canPlayAudio) {\n    // UI is necessary.\n    ...\n    button.onclick = () => {\n      // startAudio *must* be called in an click/tap handler.\n      room.startAudio().then(() => {\n        // successful, UI can be removed now\n        button.remove();\n      });\n    }\n  }\n});\n```\n\n### Configuring logging\n\nThis library uses [loglevel](https://github.com/pimterry/loglevel) for its internal logs. You can change the effective log level with the `logLevel` field in `ConnectOptions`.\nThe method `setLogExtension` allows to hook into the livekit internal logs and send them to some third party logging service\n\n```ts\nsetLogExtension((level: LogLevel, msg: string, context: object) => {\n  const enhancedContext = { ...context, timeStamp: Date.now() };\n  if (level >= LogLevel.debug) {\n    console.log(level, msg, enhancedContext);\n  }\n});\n```\n\n## Examples\n\n### SDK Sample\n\n[example/sample.ts](example/sample.ts) contains a demo webapp that uses the SDK. Run it with `yarn sample`\n\n## Browser Support\n\n| Browser         | Desktop OS            | Mobile OS |\n| --------------- | --------------------- | --------- |\n| Chrome          | Windows, macOS, Linux | Android   |\n| Firefox         | Windows, macOS, Linux | Android   |\n| Safari          | macOS                 | iOS       |\n| Edge (Chromium) | Windows, macOS        |           |\n\nWe aim to support a broad range of browser versions by transpiling the library code with babel.\nYou can have a look at the `\"browerslist\"` section of `package.json` for more details.\n\n> Note that the library requires some specific browser APIs to be present.\n> You can check general compatibility with the helper function `isBrowserSupported()`.\n> Support for more modern features like adaptiveStream and dynacast can be checked for with `supportsAdaptiveStream()` and `supportsDynacast()`.\n\nIf you are targeting legacy browsers, but still want adaptiveStream functionality you'll likely need to use polyfills for [ResizeObserver](https://www.npmjs.com/package/resize-observer-polyfill) and [IntersectionObserver](https://www.npmjs.com/package/intersection-observer).\n","readmeFilename":"README.md"}