\n\n\n\n\n## Table of Contents\n\n- [About the Project](#about-the-project)\n - [Built With](#built-with)\n- [Getting Started](#getting-started)\n- [Usage](#usage)\n- [Version History](#version-history)\n- [Roadmap](#roadmap)\n- [About](#about)\n\n\n\n## About The Project\n\nThis package `@dytesdk/twilio-shim` is a wrapper over the [Dyte SDK](https://dyte.io) with a Twilio Video compatible external API. It is a drop-in replacement for Twilio Video.js, and supports most of the methods and events that are\npresent in the Twilio Video SDK.\n\n### Built With\n- [@dytesdk/web-core](https://www.npmjs.com/package/@dytesdk/web-core)\n- [Typescript](https://typescriptlang.org)\n\n\n\n## Getting Started\n\nYou can install the `@dytesdk/twilio-shim` from the [NPM Registry](https://npmjs.com/) using the `npm install` command.\n\n```bash\nnpm install @dytesdk/twilio-shim\n```\n\n## Usage\n\nThe `@dytesdk/twilio-shim` shares the same API as the Twilio Video SDK. You can use most of the methods that are supported by it. Here's a [compatibility specification](https://dyte.notion.site/Twilio-Shim-Compatibility-Spec-38090f970c4845529cb709f2222b438b)\nthat describes the methods from `twilio-video` that are supported by this `@dytesdk/twilio-shim` package.\n\nHere are a few examples:\n\n```js\nconst { connect } = require('@dytesdk/twilio-shim');\n\nconst authToken = '';\nconst room = await connect(authToken, {audio: false, video: true});\nconsole.log(`Successfully joined a Room: ${room.name}`);\nconsole.log(room);\nroom.on('participantConnected', participant => {\n console.log(`A remote Participant connected: ${participant}`);\n});\n```\n\n```js\nconst { connect } = require('@dytesdk/twilio-shim');\n\nconst authToken = '';\nconst room = await connect(authToken, {audio: false, video: false});\nroom.on('participantConnected', participant => {\n console.log(`Participant \"${participant.identity}\" connected`);\n\n participant.tracks.forEach(publication => {\n if (publication.isSubscribed) {\n const track = publication.track;\n document.getElementById('remote-media-div').appendChild(track.attach());\n }\n });\n\n participant.on('trackSubscribed', track => {\n console.log('Subscribed to track', track);\n const element = track.attach();\n console.log(element);\n document.getElementById('remote-media-div').appendChild(element);\n });\n});\n```\n\n```js\nconst { connect } = require('@dytesdk/twilio-shim');\n\nconst authToken = '';\nconst room = await connect(authToken, {audio: true, video: true});\n\nroom.localParticipant.audioTracks.forEach(publication => {\n publication.track.disable();\n});\n\nroom.localParticipant.videoTracks.forEach(publication => {\n publication.track.disable();\n});\n\n\n// Enable audio and video tracks after 5 seconds\nsetTimeout(() => {\n room.localParticipant.audioTracks.forEach(publication => {\n publication.track.enable();\n });\n\n room.localParticipant.videoTracks.forEach(publication => {\n publication.track.enable();\n });\n}, 5000);\n```\n\n\n\n## About\n\n`twilio-shim` is created & maintained by Dyte, Inc. You can find us on Twitter - [@dyte_io](https://twitter.com/dyte_io) or write to us at `dev [at] dyte.io`.\n\nThe names and logos for Dyte are trademarks of Dyte, Inc.\n\nWe love open source software! See [our other projects](https://github.com/dyte-in) and [our products](https://dyte.io).\n","readmeFilename":"README.md"}
![\"Logo\"](\"https://assets.dyte.io/logo-outlined.png\"){kind=logo}
\n \n\n