\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/opentok-shim` is a wrapper over the [Dyte SDK](https://dyte.io) with a Opentok compatible external API. It is a drop-in replacement for Opentok JS, and supports most of the methods and events that are\npresent in the library.\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/opentok-shim` from the [NPM Registry](https://npmjs.com/) using the `npm install` command.\n\n```bash\nnpm install @dytesdk/opentok-shim\n```\n\n## Usage\n\nThe `@dytesdk/opentok-shim` shares the same API as the opentok Video SDK. You can use most of the methods that are supported by it. Here's a [compatibility specification](https://dyte.notion.site/opentok-Shim-Compatibility-Spec-38090f970c4845529cb709f2222b438b)\nthat describes the methods from `opentok-video` that are supported by this `@dytesdk/opentok-shim` package.\n\nHere are a few examples:\nReplace:\n\n```js\nimport * as OT from \"@opentok/client\";\n```\nwith\n\n```js\nimport * as OT from \"@dytesdk/opentok-shim\";\n```\n\nConnection\n\n```js\nconst token = \"\";\nconst sessionId = \"\";\nconst session = OT.initSession(token, sessionId);\n```\n\n```js\nsession.on(\"streamCreated\", function streamCreated(event) {\n console.log(\"[streamCreated] index.ts: \", event.stream);\n session.subscribe(\n event.stream,\n \"subscriber\",\n {\n insertMode: \"append\",\n width: \"100%\",\n height: \"100%\",\n },\n handleError\n );\n // }\n});\n\nlet connections: OT.Connection[] = [];\nsession.on(\"connectionCreated\", (connectionCreatedEvent) => {\n console.log(\"session connectionCreatedEvent: \", connectionCreatedEvent);\n connections.push(connectionCreatedEvent.connection);\n\n if (\n connections.find(\n (connection) =>\n connection.connectionId ===\n connectionCreatedEvent.connection.connectionId\n )\n ) {\n console.log(\"connection already exists\");\n return;\n }\n connections.push(connectionCreatedEvent.connection);\n});\n\nsession.on(\"connectionDestroyed\", (connectionDestroyedEvent) => {\n console.log(\"session connectionDestroyedEvent: \", connectionDestroyedEvent);\n connections = connections.filter(\n (connection) =>\n connection.connectionId !==\n connectionDestroyedEvent.connection.connectionId\n );\n});\n```\n\n\n\n## About\n\n`opentok-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