{"_id":"@twilio/rtc-diagnostics","_rev":"17-276d0cef7a1af6d1fb0c618fb01f1c62","name":"@twilio/rtc-diagnostics","dist-tags":{"alpha":"1.0.0-preview3","beta":"1.0.0-beta2","latest":"1.0.1"},"versions":{"1.0.0-preview3":{"name":"@twilio/rtc-diagnostics","version":"1.0.0-preview3","keywords":["client","diagnostics","twilio","video","voice","voip"],"license":"Apache-2.0","_id":"@twilio/rtc-diagnostics@1.0.0-preview3","maintainers":[{"name":"twilio-ci","email":"twilio-ci@twilio.com"}],"contributors":[{"name":"Michael Huynh"},{"name":"Ryan Rowland"},{"name":"Charlie Santos"}],"dist":{"shasum":"e0d6f9b37c52554984a8eceb6e166ca91fd5d19f","tarball":"https://registry.npmjs.org/@twilio/rtc-diagnostics/-/rtc-diagnostics-1.0.0-preview3.tgz","fileCount":103,"integrity":"sha512-Fo6AQfdjl70RVerSUh8lZwL6HJ9pY/WbMogP/mXDyPX7Mbu3Kv2qNTG4Bpk3aL+vnrTt5Pr6WL4PFXciimsULQ==","signatures":[{"sig":"MEUCIQDA4cBcvqsTo9fEaCr51GbM1bDMbOsZ4z294AZ1w5c6AwIgS+Y79dAzTgCM5p1L2fuvt17cLdZ8BWUFT3wLQeORVHs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":352592,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6rDYCRA9TVsSAnZWagAAk8QP/ighmR4GJtkDmFcfXWJO\nBPOHnezxC8QnQ5JMADVLymHljlwyRq6RHoVremlMAGb+o9ZzYpe2Tk4pKZDT\nq1ukRM9SlESDKnUmgkFMxujFtHtsN5MrnnEJsoN8lBVdHbNLtPZGvxYjFHal\ny8DYEfxez4OGa7wbudPEkDunWmIpP+1JegqaSUqkSs8GASKWpf8+9d4GRKsf\nnkRAi/WCrgUk0Nh45imDxIplkceqg3O2aT+C/D5mRkgnOgqg02Jou1MyxLV2\nnL80azYm6zFCMiVZeccpgKI3YBFeDpnu/aze2icQTtZ0Ce0L+LrEiEyIreI/\nCbI4C0BInWtQHj0Rt6/d9gGRi38x7dFvr76vGvumtOxWJVEwgPb0zjzYcejW\ndbRJcJkYBDvLdRSrSM+yCVIc/EZH2lJkCq/XGVFDZK/pujAObZBvxrslUQyn\no4XV0im2k2TaPqZiKHwNxlA3KgTZ3D29ZoGOV7cKDupZjwrWF6ry5mBu3aOu\nyq2y6rURfiiwgOFarQliAyNPn0xZjKnvKyVJZZ8jx/+8VJLDVKdkm64PYzFl\nB5up50bbr//uRUKmirzDFQH7piPRWAqGCWfuZLriLDrS38rxFIQj0XO0QOoZ\nf8KCftjeUTZNHeJFKWukRt4rL7Fn4q3di3ayxbJ61ZffyTp/Us9Ui0dEK0DR\nJkRM\r\n=C4CI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./es5/lib/diagnostics.js","types":"./es5/lib/diagnostics.d.ts","gitHead":"646a00257b30279657a7d5d0b22a22b9987ef18b","scripts":{"docs":"rimraf ./docs && typedoc --internal-aliases internal,publicapi --external-aliases external,internalapi --excludePrivate --excludeProtected --theme ./node_modules/typedoc-twilio-theme/bin/default","lint":"tslint -c ./tslint.json --project ./tsconfig.json -t stylish","test":"npm-run-all lint build test:unit test:integration","build":"npm-run-all clean docs build:es5 build:dist build:dist-min","clean":"rimraf ./dist ./coverage ./es5 ./docs","status":"git status","release":"release","build:es5":"rimraf ./es5 && tsc","test:unit":"nyc mocha -r ts-node/register ./tests/unit/index.ts","build:dist":"rimraf ./dist && node ./scripts/build.js ./LICENSE.md ./dist/rtc-diagnostics.js","build:release":"npm-run-all lint build status","build:dist-min":"uglifyjs ./dist/rtc-diagnostics.js -o ./dist/rtc-diagnostics.min.js --comments \"/^! rtc-diagnostics.js/\" -b beautify=false,ascii_only=true","test:integration":"karma start"},"_npmUser":{"name":"twilio-ci","email":"twilio-ci@twilio.com"},"_npmVersion":"6.14.4","description":"Various diagnostics functions to help analyze connections to Twilio","directories":{},"_nodeVersion":"12.16.3","dependencies":{"events":"3.0.0","@types/node":"12.12.11","@types/events":"3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"15.0.0","karma":"4.4.1","mocha":"6.2.2","sinon":"7.5.0","tsify":"4.0.1","tslint":"5.20.1","twilio":"3.39.1","ts-node":"8.5.2","typedoc":"0.16.11","coverage":"0.4.1","vinyl-fs":"3.0.3","is-docker":"2.0.0","browserify":"16.5.0","typescript":"3.7.2","karma-mocha":"1.3.0","npm-run-all":"4.1.5","@types/mocha":"5.2.7","@types/sinon":"7.5.1","karma-typescript":"4.1.1","travis-multirunner":"4.6.0","karma-spec-reporter":"0.0.32","twilio-release-tool":"1.0.1","vinyl-source-stream":"2.0.0","typedoc-twilio-theme":"github:charliesantos/typedoc-twilio-theme#1.0.1","karma-chrome-launcher":"3.1.0","karma-firefox-launcher":"1.2.0","typedoc-plugin-as-member-of":"1.0.2","typedoc-plugin-internal-external":"2.1.1","typedoc-plugin-external-module-name":"3.0.0"},"_npmOperationalInternal":{"tmp":"tmp/rtc-diagnostics_1.0.0-preview3_1592438999507_0.37672821366097997","host":"s3://npm-registry-packages"}},"1.0.0-beta1":{"name":"@twilio/rtc-diagnostics","version":"1.0.0-beta1","keywords":["client","diagnostics","twilio","video","voice","voip"],"license":"Apache-2.0","_id":"@twilio/rtc-diagnostics@1.0.0-beta1","maintainers":[{"name":"twilio-ci","email":"twilio-ci@twilio.com"}],"contributors":[{"name":"Michael Huynh"},{"name":"Ryan Rowland"},{"name":"Charlie Santos"}],"dist":{"shasum":"17cbff4e86e3b720830479b98a6c2b61f191f147","tarball":"https://registry.npmjs.org/@twilio/rtc-diagnostics/-/rtc-diagnostics-1.0.0-beta1.tgz","fileCount":115,"integrity":"sha512-sooD83HmNOGzBm09UKw3WLQ6PsPqJKIOyXFk+0KvRNKSGoWb0B9O/oLPSoLKxxAg6L0GyVUdUWe8x7YjlsNT+A==","signatures":[{"sig":"MEYCIQCuvW4fnsjpqwI5wDBu/HiA15q65WWQnlC3MhwoxgByrwIhAIfhXUhpES+9ifdD21j28B7sHzlUy0QD9B46WYxa4yU+","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":442737,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfIaxvCRA9TVsSAnZWagAAqMoP/24Qxu5tctWtdp61u5MU\nI4CIXkvUx8p0lzdINzIhAQRRxGZK4GxKxzjtCTqmJK6KYfp6SXfiaZ7XHlnF\nsnbcsaElQatP4I7Hkn324Wn3NLvGTzW6FyL9UIiVKElkzrN+Jv5QFz+SGv9x\n8jQL86qkCWFcHx20aoJREnzN2XgjHp1ci4g/g4T7jDVKHcgenkTORGEcYfW0\nPlQzjDLelrI9wSFf2fWny2yj/+nn1QK4Bw9/4gLlVWRkTr4F9uVEhhcVDcAn\nOMg0DvS16IqGBewkqZgiqzosYI71aekA7XzVxjJ7dtc1uzzbGmHdLBVkXwNr\n9LOKo1xtzgn/5FljC4GLzTawDSmFQrq4nyufYpXPMAyUOtKVdJr2ihb56IR6\nkNCQ/3QYT6pUspANxF/Jhv7Jp6PnzHqXiL42QEGdNN5r0n0WW81dyGcDbUsu\nD9zPTTWtH55AqkO6fRRxiPL3D24Ohuojxc98bVHd2WBN/UA66aOOSYK32lmA\nAkZoUV6vjHfRyiMFp4lxpiFJXrfdRPa5JqIEHi8j1u5SRvUhGYuGtbR8sV09\nRTW40dDC5TNMpStEKeW1opCsq8pJ/i4U/GDX7we+ZELNIS9Ww1pSN/mPmaqS\nIo8QGHW+p5lWUKQo1JV3/SM1bV9CJ0AeT5Z4CPamUeQqIMm1xuPhngq1XmPN\nVCiz\r\n=J3Sz\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./es5/lib/diagnostics.js","types":"./es5/lib/diagnostics.d.ts","readme":"# Voice Diagnostics SDK\nThe Voice Diagnostics SDK provides functions to test input and output audio devices, and the functionality to test network bandwidth requirements towards Twilio’s servers.\n\nThis SDK requires the use of Twilio NTS to perform the network tests. Using NTS will incur charges as per [NTS pricing](https://www.twilio.com/stun-turn/pricing).\n\n## Features\n* Input audio device tests include volume calculation\n* Output audio device tests are done by playing a sound file to the selected device\n* Bandwidth requirements tests\n\n## Prerequisites\n* A Twilio account. Sign up for free [here](https://www.twilio.com/try-twilio)\n* Node.js v10+\n* NPM v6+ (comes installed with newer Node versions)\n\n## Installation\n\n### Building the project locally\n\n```bash\n# Clone repository\ngit clone git@github.com:twilio/rtc-diagnostics.git\ncd rtc-diagnostics\n\n# Install dependencies\nnpm install\n\n# Build the artifacts under dist folder\nnpm run build\n```\n\n### NPM\nYou can install directly from npm.\n```\nnpm install @twilio/rtc-diagnostics --save\n```\n\nOr install from a local directory.\n```\nnpm install /local-path-to-repo/rtc-diagnostics\n```\n\nUsing this method, you can import `rtc-diagnostics` like so:\n```ts\nimport { testBitrate } from '@twilio/rtc-diagnostics';\n```\n\n### Script tag\nYou can also include `rtc-diagnostics.js` directly in your web app using a `<script>` tag.\n ```html\n <script src=\"https://my-server-path/rtc-diagnostics.js\"></script>\n ```\n\n Using this method, `rtc-diagnostics.js` will set a browser global:\n ```ts\n const { testBitrate } = Twilio.Diagnostics;\n ```\n\n## Usage\nThe following are examples for running tests. For more information, please refer to the [API Docs](https://twilio.github.io/rtc-diagnostics/globals.html)\n\n### BitrateTest Example\n```ts\nimport { testBitrate } from '@twilio/rtc-diagnostics';\n\nconst bitrateTest = testBitrate({\n iceServers: [{\n   credential: 'bar',\n   username: 'foo',\n   urls: 'turn:global.turn.twilio.com:3478?transport=udp',\n }],\n});\n\nbitrateTest.on('bitrate', (bitrate) => {\n console.log(bitrate);\n});\n\nbitrateTest.on('error', (error) => {\n console.log(error);\n});\n\nbitrateTest.on('end', (report) => {\n console.log(report);\n});\n\nsetTimeout(() => {\n bitrateTest.stop();\n}, 10000);\n```\nSee `BitrateTest.Options` for more information for how to obtain the `urls values`\n\n### InputTest Example\n```ts\nimport { testInputDevice, InputTest } from '@twilio/rtc-diagnostics';\n\nconst outputDeviceTest = testInputDevice({\n  deviceId: ...,\n});\n\ninputDeviceTest.on(InputTest.Events.Volume, (volume) => {\n  console.log(volume);\n});\n\ninputDeviceTest.on(InputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\ninputDeviceTest.on(InputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  inputDeviceTest.stop();\n}, 10000);\n```\n\n### OutputTest Example\n```ts\nimport { testOutputDevice, OutputTest } from '@twilio/rtc-diagnostics';\n\nconst outputDeviceTest = testOutputDevice({\n  deviceId: ...,\n});\n\noutputDeviceTest.on(InputTest.Events.Volume, (volume) => {\n  console.log(volume);\n});\n\noutputDeviceTest.on(InputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\noutputDeviceTest.on(InputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  outputDeviceTest.stop();\n}, 10000);\n```\n\n## Related\n* [Twilio Voice Client JS SDK](https://github.com/twilio/twilio-client.js)\n* [Twilio Voice Client JS Quickstart](https://github.com/TwilioDevEd/client-quickstart-js)\n* [Twilio Client connectivity requirements](https://www.twilio.com/docs/voice/client/javascript/voice-client-js-and-mobile-sdks-network-connectivity-requirements)\n\n## License\nSee [LICENSE.md](LICENSE.md)\n","gitHead":"5fd7dc7497bf3d85deaeeda85ff175750be5524b","scripts":{"docs":"rimraf ./docs && typedoc --internal-aliases internal,publicapi --external-aliases external,internalapi --excludePrivate --excludeProtected --theme ./node_modules/typedoc-twilio-theme/bin/default","lint":"tslint -c ./tslint.json --project ./tsconfig.json -t stylish","test":"npm-run-all lint build test:unit test:integration","build":"npm-run-all clean docs build:es5 build:dist build:dist-min","clean":"rimraf ./dist ./coverage ./es5 ./docs","status":"git status","release":"release","build:es5":"rimraf ./es5 && tsc","test:unit":"nyc mocha -r ts-node/register ./tests/unit/index.ts","build:dist":"rimraf ./dist && node ./scripts/build.js ./LICENSE.md ./dist/rtc-diagnostics.js","build:release":"npm-run-all lint build status","build:dist-min":"uglifyjs ./dist/rtc-diagnostics.js -o ./dist/rtc-diagnostics.min.js --comments \"/^! rtc-diagnostics.js/\" -b beautify=false,ascii_only=true","test:integration":"karma start"},"_npmUser":{"name":"twilio-ci","email":"twilio-ci@twilio.com"},"_npmVersion":"6.14.4","description":"Various diagnostics functions to help analyze connections to Twilio","directories":{},"_nodeVersion":"12.16.3","dependencies":{"events":"3.0.0","@types/node":"12.12.11","@types/events":"3.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nyc":"15.0.0","karma":"4.4.1","mocha":"6.2.2","sinon":"9.0.2","tsify":"4.0.1","tslint":"5.20.1","twilio":"3.39.1","ts-node":"8.5.2","typedoc":"0.16.11","vinyl-fs":"3.0.3","is-docker":"2.0.0","browserify":"16.5.0","typescript":"3.7.2","karma-mocha":"1.3.0","npm-run-all":"4.1.5","@types/mocha":"5.2.7","@types/sinon":"9.0.4","karma-typescript":"4.1.1","travis-multirunner":"4.6.0","karma-spec-reporter":"0.0.32","twilio-release-tool":"1.0.1","vinyl-source-stream":"2.0.0","typedoc-twilio-theme":"github:charliesantos/typedoc-twilio-theme#1.0.1","karma-chrome-launcher":"3.1.0","karma-firefox-launcher":"1.2.0","typedoc-plugin-as-member-of":"1.0.2","typedoc-plugin-internal-external":"2.1.1","typedoc-plugin-external-module-name":"3.0.0"},"_npmOperationalInternal":{"tmp":"tmp/rtc-diagnostics_1.0.0-beta1_1596042351202_0.9672557281650223","host":"s3://npm-registry-packages"}},"1.0.0-beta2":{"name":"@twilio/rtc-diagnostics","version":"1.0.0-beta2","keywords":["client","diagnostics","twilio","video","voice","voip"],"license":"Apache-2.0","_id":"@twilio/rtc-diagnostics@1.0.0-beta2","maintainers":[{"name":"twilio-ci","email":"twilio-ci@twilio.com"}],"contributors":[{"name":"Michael Huynh"},{"name":"Ryan Rowland"},{"name":"Charlie Santos"}],"dist":{"shasum":"bb685304f6a16f746812f314d543e38248dbfe91","tarball":"https://registry.npmjs.org/@twilio/rtc-diagnostics/-/rtc-diagnostics-1.0.0-beta2.tgz","fileCount":108,"integrity":"sha512-UWeHjVCpsAFuQjTblH7qBrX+4CK9yUw3jyujFx0rRj3TPPbxm/s1A29zu1IZGxECne6F1TUj3gbp1NbHEHbR4Q==","signatures":[{"sig":"MEUCIDYDPLEc7jw92dfVmyLJEMfHivi1xaIX3IT0uad1OhRVAiEAjPkt1oIAvoWCFmz9qkNhLi0jSR6r+U5vROJ6iTckQgA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":489471,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfbib8CRA9TVsSAnZWagAAxEUP/3o87xDns59o8L4I3uCY\nDXsqs0GHbADX+oFAt28OKsiKCXLeOncZ4nGwqWdHJQ+ZDdXNhp61b91fQlF5\naDd4iCIqyznNInx/7vpisCscGpl3IAS4iG9RYJ0zIIF6gCmAlr64/jCN6ysE\n+yq8szD0G83v+zFCb2yU4pBDsPRYlkSkLiZ6sZ5ybApaBg8LOMuUlaOLeuKY\nxTUf0W217M/5sxzZYaDsxl0HeDLQJnIdw2NDOFv38uuaKJSL+XrobEl33UjJ\nv8yJXQDGvbf3cAKtg5BHnk1pZREq0RGRMB2f++FGBmjYyc3Hrm8npV66tH4e\nZBaKYpXDBzqS+7VM06gVEFoaBpH0rtGjSZ6fzJOrKvwun/Wnv2h7VzLn/6dh\n44eH+6CHWXhnzWHTLML81qGDf8Hjgspq0nhNqcJ60uo55yfuHRPHyoMKmsfx\nD/lsRgROBPUrA1G3d60FweTssWxl7Clv4UOOhta3fndy+vGwtPoEKO2hrB0Z\nvxxeTkYbLP2/kiPPBL5vamIdHIN40dobFx5ch1NcwfIMIZAyEeomOdAeeNPH\n07dXX/+R9rjbFCqONNrigLjezQi0nxX3MoOwyFaK7jhr+N44GwC2ZFZFAlie\nvIacGENDaBiI/UXpkl92PaSbpccy2/qw8o5YiMVJmzol7IRyfyrQkZ3kphJ0\njUAB\r\n=WYPI\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./es5/lib/diagnostics.js","types":"./es5/lib/diagnostics.d.ts","readme":"# RTC Diagnostics SDK\nThe RTC Diagnostics SDK provides functions to test input and output devices (microphone, speaker, camera) as well as functionality to confirm that you meet the network bandwidth requirements required to make a voice call or join a video room.\n\nThis SDK requires the use of Twilio NTS or your own STUN/TURN servers to perform the network tests. Using Twilio NTS will mirror how Twilio uses STUN/TURN in Programmable Video when connecting to a Twilio Video Room and will incur charges as per [NTS pricing](https://www.twilio.com/stun-turn/pricing).\n\n## Features\n* Input audio device tests\n* Input video device tests\n* Output audio device tests\n* Bandwidth requirements tests\n\n## Prerequisites\n* A Twilio account. Sign up for free [here](https://www.twilio.com/try-twilio)\n* Node.js v12+\n* NPM v6+ (comes installed with newer Node versions)\n\n## Installation\n\n### Building the project locally\n\n```bash\n# Clone repository\ngit clone git@github.com:twilio/rtc-diagnostics.git\ncd rtc-diagnostics\n\n# Install dependencies\nnpm install\n\n# Build the artifacts under dist folder\nnpm run build\n```\n\nIn order to run integration tests, you'll need to copy over the `credentials.example.json` file\nto `credentials.json` in the same folder, and replace the empty fields with valid values.\n\n### NPM\nYou can install directly from npm.\n```\nnpm install @twilio/rtc-diagnostics --save\n```\n\nOr install from a local directory.\n```\nnpm install /local-path-to-repo/rtc-diagnostics\n```\n\nUsing this method, you can import `rtc-diagnostics` like so:\n```ts\nimport { testMediaConnectionBitrate } from '@twilio/rtc-diagnostics';\n```\n\n### Script tag\nYou can also include `rtc-diagnostics.js` directly in your web app using a `<script>` tag.\n ```html\n <script src=\"https://my-server-path/rtc-diagnostics.js\"></script>\n ```\n\n Using this method, `rtc-diagnostics.js` will set a browser global:\n ```ts\n const { testMediaConnectionBitrate } = Twilio.Diagnostics;\n ```\n\n## Usage\nThe following are examples for running tests. For more information, please refer to the [API Docs](https://twilio.github.io/rtc-diagnostics/globals.html)\n\n### MediaConnectionBitrateTest Example\n```ts\nimport { testMediaConnectionBitrate } from '@twilio/rtc-diagnostics';\n\nconst mediaConnectionBitrateTest = testMediaConnectionBitrate({\n iceServers: [{\n   credential: 'bar',\n   username: 'foo',\n   urls: 'turn:global.turn.twilio.com:3478?transport=udp',\n }],\n});\n\nmediaConnectionBitrateTest.on('bitrate', (bitrate) => {\n console.log(bitrate);\n});\n\nmediaConnectionBitrateTest.on('error', (error) => {\n console.log(error);\n});\n\nmediaConnectionBitrateTest.on('end', (report) => {\n console.log(report);\n});\n\nsetTimeout(() => {\n mediaConnectionBitrateTest.stop();\n}, 10000);\n```\nSee `MediaConnectionBitrateTest.Options` for more information for how to obtain the `urls values`\n\n### AudioInputTest Example\n```ts\nimport { testAudioInputDevice, AudioInputTest } from '@twilio/rtc-diagnostics';\n\nconst audioInputDeviceTest = testAudioInputDevice({\n  deviceId: ...,\n});\n\naudioInputDeviceTest.on(AudioInputTest.Events.Volume, (volume) => {\n  console.log(volume);\n});\n\naudioInputDeviceTest.on(AudioInputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\naudioInputDeviceTest.on(AudioInputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  audioInputDeviceTest.stop();\n}, 10000);\n```\n\n### VideoInputTest Example\n```ts\nimport { testVideoInputDevice, VideoInputTest } from '@twilio/rtc-diagnostics';\n\nconst videoInputDeviceTest = testVideoInputDevice({ element: videoElement });\n\nvideoInputDeviceTest.on(VideoInputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\nvideoInputDeviceTest.on(VideoInputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  videoInputDeviceTest.stop();\n}, 10000);\n```\n\n### AudioOutputTest Example\n```ts\nimport { testAudioOutputDevice, AudioOutputTest } from '@twilio/rtc-diagnostics';\n\nconst audioOutputDeviceTest = testAudioOutputDevice({\n  deviceId: ...,\n});\n\naudioOutputDeviceTest.on(AudioOutputTest.Events.Volume, (volume) => {\n  console.log(volume);\n});\n\naudioOutputDeviceTest.on(AudioOutputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\naudioOutputDeviceTest.on(AudioOutputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  audioOutputDeviceTest.stop();\n}, 10000);\n```\n\n## Related\n* [Twilio Voice Client JS SDK](https://github.com/twilio/twilio-client.js)\n* [Twilio Voice Client JS Quickstart](https://github.com/TwilioDevEd/client-quickstart-js)\n* [Twilio Video JS SDK](https://github.com/twilio/twilio-video.js)\n* [Twilio Video JS Quickstart](https://github.com/twilio/video-quickstart-js)\n* [Twilio Client connectivity requirements](https://www.twilio.com/docs/voice/client/javascript/voice-client-js-and-mobile-sdks-network-connectivity-requirements)\n\n## License\nSee [LICENSE.md](LICENSE.md)\n","gitHead":"bbc266a63e090ad731f28e2644ab0ed176acf8e9","scripts":{"docs":"rimraf ./docs && typedoc --internal-aliases internal,publicapi --external-aliases external,internalapi --excludePrivate --excludeProtected --theme ./node_modules/typedoc-twilio-theme/bin/default","lint":"tslint -c ./tslint.json --project ./tsconfig.json -t stylish","test":"npm-run-all lint build test:unit test:integration","build":"npm-run-all clean docs build:es5 build:dist build:dist-min","clean":"rimraf ./dist ./coverage ./es5 ./docs","status":"git status","release":"release","build:es5":"rimraf ./es5 && tsc","test:unit":"nyc mocha -r ts-node/register ./tests/unit/index.ts","build:dist":"rimraf ./dist && node ./scripts/build.js ./LICENSE.md ./dist/rtc-diagnostics.js","build:release":"npm-run-all lint build status","build:dist-min":"uglifyjs ./dist/rtc-diagnostics.js -o ./dist/rtc-diagnostics.min.js --comments \"/^! rtc-diagnostics.js/\" -b beautify=false,ascii_only=true","test:integration":"node ./scripts/env.js && karma start"},"_npmUser":{"name":"twilio-ci","email":"twilio-ci@twilio.com"},"_npmVersion":"6.14.4","description":"Various diagnostics functions to help analyze connections to Twilio","directories":{},"_nodeVersion":"12.16.3","dependencies":{"events":"3.0.0","@types/node":"12.12.11","@types/events":"3.0.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"nyc":"15.0.0","karma":"4.4.1","mocha":"6.2.2","sinon":"9.0.2","tsify":"4.0.1","tslint":"5.20.1","twilio":"3.39.1","request":"^2.88.2","ts-node":"8.5.2","typedoc":"0.16.11","vinyl-fs":"3.0.3","is-docker":"2.0.0","browserify":"16.5.0","typescript":"3.7.2","karma-mocha":"1.3.0","npm-run-all":"4.1.5","@types/mocha":"5.2.7","@types/sinon":"9.0.4","@types/request":"^2.48.5","karma-typescript":"4.1.1","travis-multirunner":"4.6.0","karma-spec-reporter":"0.0.32","twilio-release-tool":"1.0.1","vinyl-source-stream":"2.0.0","typedoc-twilio-theme":"github:charliesantos/typedoc-twilio-theme#1.0.1","karma-chrome-launcher":"3.1.0","karma-env-preprocessor":"^0.1.1","karma-firefox-launcher":"1.2.0","typedoc-plugin-as-member-of":"1.0.2","typedoc-plugin-internal-external":"2.1.1","typedoc-plugin-external-module-name":"3.0.0"},"_npmOperationalInternal":{"tmp":"tmp/rtc-diagnostics_1.0.0-beta2_1601054459964_0.1526207815071121","host":"s3://npm-registry-packages"}},"1.0.0":{"name":"@twilio/rtc-diagnostics","version":"1.0.0","keywords":["client","diagnostics","twilio","video","voice","voip"],"license":"Apache-2.0","_id":"@twilio/rtc-diagnostics@1.0.0","maintainers":[{"name":"twilio-ci","email":"twilio-ci@twilio.com"}],"contributors":[{"name":"Michael Huynh"},{"name":"Ryan Rowland"},{"name":"Charlie Santos"}],"dist":{"shasum":"fe2eda52657722a5be47cab11e41447ad96ea033","tarball":"https://registry.npmjs.org/@twilio/rtc-diagnostics/-/rtc-diagnostics-1.0.0.tgz","fileCount":108,"integrity":"sha512-XY1a6Qg03CAqF7Zio57+QE6cM31mfMmv6dCkhqYTenmgshK/XTtdlBTkvCxRxQYz3SBGDXNRbZ55c2hNYG7W+A==","signatures":[{"sig":"MEUCIBS9XIm134YhTZOjjw51jBAvMeSAkExlSZPEqeQkm3IxAiEA4p+DXdklMS1u/xYnPpUhIjx6eMnyFeBGaTeOFv4uqas=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":490450,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfoc8iCRA9TVsSAnZWagAAnPkQAKJuqaWuLwTwuInH3vyQ\nqr8m8GuAIIsh9PB1rzDkATunLdyJZka7MoVVueVfaQEvM18UOAu7i4WQGcjF\nk7aWtF78aqA431+qQmvKEzardMAHOfWVrkRTLi034eq9a4GZ4YRcFhNGpaVw\nZSEk8rHDaMWXTYIOOkdbSt8kzlAVLC4bFSVjGsin452Fv27CKDKoobhm1egj\nps/eW2qdjwgERsjuQV8IzLoxbplLEvl9J7LpSTsrwPTXwzIb5qzQQFtBw7st\n2wBU6croIWq01Ug8x0PUGBdYRlra033IwfUs75C+1+rN8lsSZ9bhVYkDQaVC\nnx1VyupeGozCxgcg6iZXOtDzvi172QPVdMDGZxQZ8mLeOVBXERcXOpBEkIZo\ndkFGDWTCg/79bUUq43Y6JKUSXn13PHjb6Wujpih394WUmw0RgPL/Gbyipiuy\n+NTVY3K+Ne4Bk0WF4CGj0rv+o6MsRj69Hn9eL3eHIdX27XJxWiZFr2b0gjNG\nGAVIkF2+UVzEKtD8/FbPPHR1VHMnvk5fS06glDeKbygPke7zxBEvLRlwqSUE\nL+RzOUXULng0/f9NQVC+DqpseQiBjx09giBl53mfZiHX/NMmr50jll8GBSiq\nRZvsns6R9KCU2PwEAGXCmpcWB24qfvYUFhxuDUcQqAbG/wUE2ITRqcVycurd\nt/5T\r\n=CEsZ\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./es5/lib/diagnostics.js","types":"./es5/lib/diagnostics.d.ts","gitHead":"12c3a9e1a02008f4cf1cb129d2a8ebaba2feff01","scripts":{"docs":"rimraf ./docs && typedoc --internal-aliases internal,publicapi --external-aliases external,internalapi --excludePrivate --excludeProtected --theme ./node_modules/typedoc-twilio-theme/bin/default","lint":"tslint -c ./tslint.json --project ./tsconfig.json -t stylish","test":"npm-run-all lint build test:unit test:integration","build":"npm-run-all clean docs build:es5 build:dist build:dist-min","clean":"rimraf ./dist ./coverage ./es5 ./docs","status":"git status","release":"release","build:es5":"rimraf ./es5 && tsc","test:unit":"nyc mocha -r ts-node/register ./tests/unit/index.ts","build:dist":"rimraf ./dist && node ./scripts/build.js ./LICENSE.md ./dist/rtc-diagnostics.js","build:release":"npm-run-all lint build status","build:dist-min":"uglifyjs ./dist/rtc-diagnostics.js -o ./dist/rtc-diagnostics.min.js --comments \"/^! rtc-diagnostics.js/\" -b beautify=false,ascii_only=true","test:integration":"node ./scripts/env.js && karma start"},"_npmUser":{"name":"twilio-ci","email":"twilio-ci@twilio.com"},"_npmVersion":"6.12.1","description":"Various diagnostics functions to help analyze connections to Twilio","directories":{},"_nodeVersion":"12.13.1","dependencies":{"events":"3.0.0","@types/node":"12.12.11","@types/events":"3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"15.0.0","karma":"4.4.1","mocha":"6.2.2","sinon":"9.0.2","tsify":"4.0.1","tslint":"5.20.1","twilio":"3.39.1","request":"^2.88.2","ts-node":"8.5.2","typedoc":"0.16.11","vinyl-fs":"3.0.3","is-docker":"2.0.0","browserify":"16.5.0","typescript":"3.7.2","karma-mocha":"1.3.0","npm-run-all":"4.1.5","@types/mocha":"5.2.7","@types/sinon":"9.0.4","@types/request":"^2.48.5","karma-typescript":"4.1.1","travis-multirunner":"4.6.0","karma-spec-reporter":"0.0.32","twilio-release-tool":"1.0.1","vinyl-source-stream":"2.0.0","typedoc-twilio-theme":"github:charliesantos/typedoc-twilio-theme#1.0.1","karma-chrome-launcher":"3.1.0","karma-env-preprocessor":"^0.1.1","karma-firefox-launcher":"1.2.0","typedoc-plugin-as-member-of":"1.0.2","typedoc-plugin-internal-external":"2.1.1","typedoc-plugin-external-module-name":"3.0.0"},"_npmOperationalInternal":{"tmp":"tmp/rtc-diagnostics_1.0.0_1604439841453_0.6018075953159261","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@twilio/rtc-diagnostics","version":"1.0.1","keywords":["client","diagnostics","twilio","video","voice","voip"],"license":"Apache-2.0","_id":"@twilio/rtc-diagnostics@1.0.1","maintainers":[{"name":"twilio-vblocks-ci","email":"svc.vblocks-ci@twilio.com"}],"contributors":[{"name":"Michael Huynh"},{"name":"Ryan Rowland"},{"name":"Charlie Santos"}],"dist":{"shasum":"bd2a6975fd8ee74f399825286b60d118e2c8e2cc","tarball":"https://registry.npmjs.org/@twilio/rtc-diagnostics/-/rtc-diagnostics-1.0.1.tgz","fileCount":108,"integrity":"sha512-vnSKX8jh5kW0BjAoyC0OXk21gv7eBjzahp8Jo59lEEX/PmszG2gMwlMF9NihSGHaXk3YpXwx4pRKEk+R5L5NQA==","signatures":[{"sig":"MEYCIQD3h5CXLJzVOsWX2nCD/N1xX6TK341y9rTfGwjL432TMAIhANB1Qz1+nnyxV1QajdeTUB3z1ulXxqWltJw8eyI2ubqZ","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":493718,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJj2bjPACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmpo5Q/8CvILfGq0Of3jn3+gu2mUDKEReYtYvlYWFPDIQ0sXTIuf0/AM\r\nYxXdyF3BESeGZW4n1H7wYR6tklitIJ24Frhx2/CwR825vzmZRE0dNefoWoA4\r\nAbH60SAuHi75DMHOO7vm3/+dLRbmyuDQCaV26grSAKbL17UYyFfBfKRwUslt\r\nYkD8DvmGkB1dHOs2JzLSqOYatvg2wHFH5IhSh1hL/0L1XqWQc7+BySCTdbpk\r\nE7AmJTOH9POsRRlvFGT0FMlMtiD6UHJhHdQGuHVWFBQ9AQn6UltzpcmVwP2W\r\nBLo0Pn48exUT5tqkGHTmLRrAhYH1MOX1tyiQd5/9twRN9v/J9WQAEuPUsnNl\r\n8kjzE+RTBCspC0skCcJqU+um6UrhPDRBaLu/Hm6OkmmsmjDnG3PVBtikq7qs\r\nITzjlc1DRi5o4Nby3Rq1IxoSoXZ5zGX0MT3MgIDn1ks1g85JfquQcOCks02Y\r\neGYTEIO+grZ9xbboMQJR9d88EFEQaAD+CP32Y+toO9RuVqPnyxjphlI90fJT\r\nuV6Gm83dbg8q7q3v9lkhysd7Hj8Rv8QMeUFyszTSoEFI2gsgCrq+yVsmhk0n\r\n5ZkDyC5w+xVxLu9BLb8NSwYMlt+5B7jf42xhXMKjr8ipWPVRMN8VLtlWLUKX\r\nmsB/wFZjkvV0IXTy7UrFThQFEvdsexi5cqk=\r\n=ziws\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./es5/lib/diagnostics.js","types":"./es5/lib/diagnostics.d.ts","gitHead":"db968fa6c16aa52bf80acbbae8186d4e98e2f8fe","scripts":{"docs":"rimraf ./docs && typedoc --internal-aliases internal,publicapi --external-aliases external,internalapi --excludePrivate --excludeProtected --theme ./node_modules/typedoc-twilio-theme/bin/default","lint":"tslint -c ./tslint.json --project ./tsconfig.json -t stylish","test":"npm-run-all lint build test:unit test:integration","build":"npm-run-all clean docs build:es5 build:dist build:dist-min","clean":"rimraf ./dist ./coverage ./es5 ./docs","status":"git status","release":"release","build:es5":"rimraf ./es5 && tsc","test:unit":"nyc mocha -r ts-node/register ./tests/unit/index.ts","build:dist":"rimraf ./dist && node ./scripts/build.js ./LICENSE.md ./dist/rtc-diagnostics.js","build:release":"npm-run-all lint build status","build:dist-min":"uglifyjs ./dist/rtc-diagnostics.js -o ./dist/rtc-diagnostics.min.js --comments \"/^! rtc-diagnostics.js/\" -b beautify=false,ascii_only=true","test:integration":"node ./scripts/env.js && karma start"},"_npmUser":{"name":"twilio-vblocks-ci","email":"svc.vblocks-ci@twilio.com"},"_npmVersion":"8.19.1","description":"Various diagnostics functions to help analyze connections to Twilio","directories":{},"_nodeVersion":"18.9.0","dependencies":{"events":"3.0.0","@types/node":"12.12.11","@types/events":"3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"nyc":"15.0.0","karma":"4.4.1","mocha":"6.2.2","sinon":"9.0.2","tsify":"4.0.1","tslint":"5.20.1","twilio":"3.39.1","request":"^2.88.2","ts-node":"8.5.2","typedoc":"0.16.11","vinyl-fs":"3.0.3","is-docker":"2.0.0","browserify":"16.5.0","typescript":"3.7.2","@types/mime":"2.0.2","karma-mocha":"1.3.0","npm-run-all":"4.1.5","@types/mocha":"5.2.7","@types/sinon":"9.0.4","@types/request":"^2.48.5","karma-typescript":"4.1.1","travis-multirunner":"4.6.0","karma-spec-reporter":"0.0.32","twilio-release-tool":"1.0.1","vinyl-source-stream":"2.0.0","typedoc-twilio-theme":"1.0.1","karma-chrome-launcher":"3.1.0","karma-env-preprocessor":"^0.1.1","karma-firefox-launcher":"1.2.0","typedoc-plugin-as-member-of":"1.0.2","typedoc-plugin-internal-external":"2.1.1","typedoc-plugin-external-module-name":"4.0.6"},"_npmOperationalInternal":{"tmp":"tmp/rtc-diagnostics_1.0.1_1675213007091_0.610772515147258","host":"s3://npm-registry-packages"}}},"time":{"created":"2020-06-18T00:09:59.507Z","modified":"2026-07-21T17:16:11.657Z","1.0.0-preview2":"2020-06-17T23:27:31.922Z","1.0.0-preview3":"2020-06-18T00:09:59.754Z","1.0.0-beta1":"2020-07-29T17:05:51.386Z","1.0.0-beta2":"2020-09-25T17:21:00.139Z","1.0.0":"2020-11-03T21:44:01.592Z","1.0.1":"2023-02-01T00:56:47.255Z"},"license":"Apache-2.0","keywords":["client","diagnostics","twilio","video","voice","voip"],"description":"Various diagnostics functions to help analyze connections to Twilio","contributors":[{"name":"Michael Huynh"},{"name":"Ryan Rowland"},{"name":"Charlie Santos"}],"maintainers":[{"email":"secure-supply-chain@twilio.com","name":"twilio-supply-chain"}],"readme":"# RTC Diagnostics SDK\nThe RTC Diagnostics SDK provides functions to test input and output devices (microphone, speaker, camera) as well as functionality to confirm that you meet the network bandwidth requirements required to make a voice call or join a video room.\n\nThis SDK requires the use of Twilio NTS or your own STUN/TURN servers to perform the network tests. Using Twilio NTS will mirror how Twilio uses STUN/TURN in Programmable Video when connecting to a Twilio Video Room and will incur charges as per [NTS pricing](https://www.twilio.com/stun-turn/pricing).\n\n## Features\n* Input audio device tests\n* Input video device tests\n* Output audio device tests\n* Bandwidth requirements tests\n\n## Prerequisites\n* Node.js v12+\n* NPM v6+ (comes installed with newer Node versions)\n\n## Installation\n\n### Building the project locally\n\n```bash\n# Clone repository\ngit clone git@github.com:twilio/rtc-diagnostics.git\ncd rtc-diagnostics\n\n# Install dependencies\nnpm install\n\n# Build the artifacts under dist folder\nnpm run build\n```\n\nIn order to run integration tests, you'll need to copy over the `credentials.example.json` file\nto `credentials.json` in the same folder, and replace the empty fields with valid values.\n\n### NPM\nYou can install directly from npm.\n```\nnpm install @twilio/rtc-diagnostics --save\n```\n\nOr install from a local directory.\n```\nnpm install /local-path-to-repo/rtc-diagnostics\n```\n\nUsing this method, you can import `rtc-diagnostics` like so:\n```ts\nimport { testMediaConnectionBitrate } from '@twilio/rtc-diagnostics';\n```\n\n### Script tag\nYou can also include `rtc-diagnostics.js` directly in your web app using a `<script>` tag.\n ```html\n <script src=\"https://my-server-path/rtc-diagnostics.js\"></script>\n ```\n\n Using this method, `rtc-diagnostics.js` will set a browser global:\n ```ts\n const { testMediaConnectionBitrate } = Twilio.Diagnostics;\n ```\n\n## Usage\nThe following are examples for running tests. For more information, please refer to the [API Docs](https://twilio.github.io/rtc-diagnostics/globals.html)\n\n### MediaConnectionBitrateTest Example\n```ts\nimport { testMediaConnectionBitrate } from '@twilio/rtc-diagnostics';\n\nconst mediaConnectionBitrateTest = testMediaConnectionBitrate({\n iceServers: [{\n   credential: 'bar',\n   username: 'foo',\n   urls: 'turn:global.turn.twilio.com:3478?transport=udp',\n }],\n});\n\nmediaConnectionBitrateTest.on('bitrate', (bitrate) => {\n console.log(bitrate);\n});\n\nmediaConnectionBitrateTest.on('error', (error) => {\n console.log(error);\n});\n\nmediaConnectionBitrateTest.on('end', (report) => {\n console.log(report);\n});\n\nsetTimeout(() => {\n mediaConnectionBitrateTest.stop();\n}, 10000);\n```\nSee `MediaConnectionBitrateTest.Options` for more information for how to obtain the `urls values`\n\n### AudioInputTest Example\n```ts\nimport { testAudioInputDevice, AudioInputTest } from '@twilio/rtc-diagnostics';\n\nconst audioInputDeviceTest = testAudioInputDevice({\n  deviceId: ...,\n});\n\naudioInputDeviceTest.on(AudioInputTest.Events.Volume, (volume) => {\n  console.log(volume);\n});\n\naudioInputDeviceTest.on(AudioInputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\naudioInputDeviceTest.on(AudioInputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  audioInputDeviceTest.stop();\n}, 10000);\n```\n\n### VideoInputTest Example\n```ts\nimport { testVideoInputDevice, VideoInputTest } from '@twilio/rtc-diagnostics';\n\nconst videoInputDeviceTest = testVideoInputDevice({ element: videoElement });\n\nvideoInputDeviceTest.on(VideoInputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\nvideoInputDeviceTest.on(VideoInputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  videoInputDeviceTest.stop();\n}, 10000);\n```\n\n### AudioOutputTest Example\n```ts\nimport { testAudioOutputDevice, AudioOutputTest } from '@twilio/rtc-diagnostics';\n\nconst audioOutputDeviceTest = testAudioOutputDevice({\n  deviceId: ...,\n});\n\naudioOutputDeviceTest.on(AudioOutputTest.Events.Volume, (volume) => {\n  console.log(volume);\n});\n\naudioOutputDeviceTest.on(AudioOutputTest.Events.Error, (error) => {\n  console.error(error);\n});\n\naudioOutputDeviceTest.on(AudioOutputTest.Events.End, (report) => {\n  console.log(report);\n});\n\nsetTimeout(() => {\n  audioOutputDeviceTest.stop();\n}, 10000);\n```\n\n## Related\n\n### Testing Voice and Video calling readiness\n* [Twilio Voice Client JS Preflight Test](https://github.com/twilio/twilio-client.js/blob/preflight/PREFLIGHT.md)\n* [Twilio Video JS Preflight Test](https://github.com/twilio/twilio-video.js/blob/preflight_api/CHANGELOG.md#280-beta1-september-28-2020)\n\n### Applications using Diagnostics and Preflight tests\n* [Twilio Voice Diagnostics Tool](https://github.com/twilio/rtc-diagnostics-react-app)\n* [Twilio Video JS React App](https://github.com/twilio/twilio-video-app-react)\n\n### Voice and Video JS SDKs\n* [Twilio Voice Client JS SDK](https://github.com/twilio/twilio-client.js)\n* [Twilio Voice Client JS Quickstart](https://github.com/TwilioDevEd/client-quickstart-js)\n* [Twilio Video JS SDK](https://github.com/twilio/twilio-video.js)\n* [Twilio Video JS Quickstart](https://github.com/twilio/video-quickstart-js)\n\n### Connectivity requirements\n* [Twilio Client connectivity requirements](https://www.twilio.com/docs/voice/client/javascript/voice-client-js-and-mobile-sdks-network-connectivity-requirements)\n\n## License\nSee [LICENSE.md](LICENSE.md)\n","readmeFilename":"README.md"}