{"_id":"@addpipe/pipe-recording-client","_rev":"6-c13fb60a62f9ba40231e94c21ce6f1aa","name":"@addpipe/pipe-recording-client","dist-tags":{"latest":"2.0.5"},"versions":{"2.0.0":{"name":"@addpipe/pipe-recording-client","version":"2.0.0","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"author":{"url":"https://addpipe.com","name":"Pipe"},"license":"Elastic-2.0","_id":"@addpipe/pipe-recording-client@2.0.0","maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"homepage":"https://addpipe.com","bugs":{"url":"https://addpipe.com/contact"},"dist":{"shasum":"3b2f26c271282566bee46233eec637ad31584215","tarball":"https://registry.npmjs.org/@addpipe/pipe-recording-client/-/pipe-recording-client-2.0.0.tgz","fileCount":9,"integrity":"sha512-o07+2q5VVY2TPjN3QzdvyuVuBeBd/o57G6gB4dzlnz4Ql+PHoUvh52kkaN2d3fDFiSjGMUa+le2sRLFGcHzR4Q==","signatures":[{"sig":"MEUCIAtjR8/lQDlqHPM1d/h/tu/u/DArSMAUOh9w6C0pwYmAAiEA6iUacBScqY72FuriizaXDxCHTvSkhQCugvnfwXSVc30=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":376690},"main":"./dist/pipe.cjs","types":"./dist/pipe.d.ts","unpkg":"./dist/pipe.min.js","module":"./dist/pipe.mjs","exports":{".":{"types":"./dist/pipe.d.ts","import":"./dist/pipe.mjs","require":"./dist/pipe.cjs"},"./pipe.css":"./dist/pipe.css","./pipe.min.js":"./dist/pipe.min.js","./package.json":"./package.json","./pipe.min.css":"./dist/pipe.min.css"},"gitHead":"f2f6789c0408822c2342dbdfd0a3fbb97ed5475d","_npmUser":{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},"jsdelivr":"./dist/pipe.min.js","_npmVersion":"11.9.0","description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","directories":{},"sideEffects":["*.css","./dist/pipe.min.js","./dist/pipe.mjs","./dist/pipe.cjs"],"_nodeVersion":"25.6.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/pipe-recording-client_2.0.0_1782303449054_0.9892010541093088","host":"s3://npm-registry-packages-npm-production"}},"2.0.1":{"name":"@addpipe/pipe-recording-client","version":"2.0.1","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"author":{"url":"https://addpipe.com","name":"Pipe"},"license":"Elastic-2.0","_id":"@addpipe/pipe-recording-client@2.0.1","maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"homepage":"https://addpipe.com","bugs":{"url":"https://addpipe.com/contact"},"dist":{"shasum":"769b9819147bc9dca9fcbba87514fb7ea6364406","tarball":"https://registry.npmjs.org/@addpipe/pipe-recording-client/-/pipe-recording-client-2.0.1.tgz","fileCount":9,"integrity":"sha512-Zz7A3oiSR3U8GxDX+0p7SApj75ribMEr0mrQrkUurqotWOxyklHaQj4VGwUki0Yqf93jtOjq/OFYk9zKBFgjEw==","signatures":[{"sig":"MEYCIQDleKa+tyxtCR4JmsClicrjwU+nkM7GhEn0dhtQ7etEWgIhAPrukDFcnKmDB/gw2o5MWGpb8qsTo7cmyQZCPb0lN9L6","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":377508},"main":"./dist/pipe.cjs","types":"./dist/pipe.d.ts","unpkg":"./dist/pipe.min.js","module":"./dist/pipe.mjs","exports":{".":{"types":"./dist/pipe.d.ts","import":"./dist/pipe.mjs","require":"./dist/pipe.cjs"},"./pipe.css":"./dist/pipe.css","./pipe.min.js":"./dist/pipe.min.js","./package.json":"./package.json","./pipe.min.css":"./dist/pipe.min.css"},"gitHead":"6add7a963930dc09414deee5c1e0deda6b826820","_npmUser":{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},"jsdelivr":"./dist/pipe.min.js","_npmVersion":"11.9.0","description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","directories":{},"sideEffects":["*.css","./dist/pipe.min.js","./dist/pipe.mjs","./dist/pipe.cjs"],"_nodeVersion":"25.6.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/pipe-recording-client_2.0.1_1783410129282_0.5258946580530266","host":"s3://npm-registry-packages-npm-production"}},"2.0.2":{"name":"@addpipe/pipe-recording-client","version":"2.0.2","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"author":{"url":"https://addpipe.com","name":"Pipe"},"license":"Elastic-2.0","_id":"@addpipe/pipe-recording-client@2.0.2","maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"homepage":"https://addpipe.com","bugs":{"url":"https://addpipe.com/contact"},"dist":{"shasum":"4e945d70a20d40a7d202e2782359ea5059cdd47a","tarball":"https://registry.npmjs.org/@addpipe/pipe-recording-client/-/pipe-recording-client-2.0.2.tgz","fileCount":9,"integrity":"sha512-m1O472VIMtrr7CzDkjm7sDYBhGRgu8or97CHSibiB0GiibpMKvVaZNB44A03G+u9v/35Hx8eM+Mq6Z59O5VVlA==","signatures":[{"sig":"MEQCIC53bQgh59IsMhyhrHsB9R4uFLdtFycGAxU3z+B+lbfwAiAbbcRje3F4Y5i5gNk0eHJ4FaU/kZQaT40Wl4mXxHo8FQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":377334},"main":"./dist/pipe.cjs","types":"./dist/pipe.d.ts","unpkg":"./dist/pipe.min.js","module":"./dist/pipe.mjs","exports":{".":{"types":"./dist/pipe.d.ts","import":"./dist/pipe.mjs","require":"./dist/pipe.cjs"},"./pipe.css":"./dist/pipe.css","./pipe.min.js":"./dist/pipe.min.js","./package.json":"./package.json","./pipe.min.css":"./dist/pipe.min.css"},"gitHead":"e255f3270ed3419bb30d6320c342ae73371e7d69","_npmUser":{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},"jsdelivr":"./dist/pipe.min.js","_npmVersion":"11.9.0","description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","directories":{},"sideEffects":["*.css","./dist/pipe.min.js","./dist/pipe.mjs","./dist/pipe.cjs"],"_nodeVersion":"25.6.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/pipe-recording-client_2.0.2_1783496563106_0.4035626383977149","host":"s3://npm-registry-packages-npm-production"}},"2.0.3":{"name":"@addpipe/pipe-recording-client","version":"2.0.3","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"author":{"url":"https://addpipe.com","name":"Pipe"},"license":"Elastic-2.0","_id":"@addpipe/pipe-recording-client@2.0.3","maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"homepage":"https://addpipe.com","bugs":{"url":"https://addpipe.com/contact"},"dist":{"shasum":"288159c6ee6ef4b343146a88f0329a4b1d1596ba","tarball":"https://registry.npmjs.org/@addpipe/pipe-recording-client/-/pipe-recording-client-2.0.3.tgz","fileCount":9,"integrity":"sha512-9q5tyegIutxBCZ15YxtX7Dva1ibwfVaMsrNXS1UyqLN01OQeUKdqSD6Mu5uDsnyCUTBslKplWJeGA4H1ozfjmQ==","signatures":[{"sig":"MEQCIHaihZS6d3u/twYKod6Ihd0V/TqLYVC7bdoFwxa+CI5CAiAGy4y4V1YE+vtgyNizeRJR/mT1jgfMbTxYEd0RCOC2/w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":377455},"main":"./dist/pipe.cjs","types":"./dist/pipe.d.ts","unpkg":"./dist/pipe.min.js","module":"./dist/pipe.mjs","exports":{".":{"types":"./dist/pipe.d.ts","import":"./dist/pipe.mjs","require":"./dist/pipe.cjs"},"./pipe.css":"./dist/pipe.css","./pipe.min.js":"./dist/pipe.min.js","./package.json":"./package.json","./pipe.min.css":"./dist/pipe.min.css"},"gitHead":"3812cdd9e90b0178997a5f6e58d5ca9fe6d500d5","_npmUser":{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},"jsdelivr":"./dist/pipe.min.js","_npmVersion":"11.9.0","description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","directories":{},"sideEffects":["*.css","./dist/pipe.min.js","./dist/pipe.mjs","./dist/pipe.cjs"],"_nodeVersion":"25.6.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/pipe-recording-client_2.0.3_1784187720540_0.14297485826372758","host":"s3://npm-registry-packages-npm-production"}},"2.0.4":{"name":"@addpipe/pipe-recording-client","version":"2.0.4","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"author":{"url":"https://addpipe.com","name":"Pipe"},"license":"Elastic-2.0","_id":"@addpipe/pipe-recording-client@2.0.4","maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"homepage":"https://addpipe.com","bugs":{"url":"https://addpipe.com/contact"},"dist":{"shasum":"80b6ca1be4341e67f97dc6ddf17eeb275e73a635","tarball":"https://registry.npmjs.org/@addpipe/pipe-recording-client/-/pipe-recording-client-2.0.4.tgz","fileCount":9,"integrity":"sha512-qscngYdmlLQfJHPjzNnxwUmkxP8NN0zomgxQSyXCV0tsodFhfwwI0PMK+WFsAk32jmij2A1gH8FWI2LCwT4Cqg==","signatures":[{"sig":"MEYCIQDvc6SSZRfL5DObk9TGT16vnBzDKFeqLQab8Nc873JDfgIhAK5hAEd/K+A0/Pd7g6USEZ/N3McXRdsJqrI8K07VAADu","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":380197},"main":"./dist/pipe.cjs","types":"./dist/pipe.d.ts","unpkg":"./dist/pipe.min.js","module":"./dist/pipe.mjs","exports":{".":{"types":"./dist/pipe.d.ts","import":"./dist/pipe.mjs","require":"./dist/pipe.cjs"},"./pipe.css":"./dist/pipe.css","./pipe.min.js":"./dist/pipe.min.js","./package.json":"./package.json","./pipe.min.css":"./dist/pipe.min.css"},"gitHead":"21f8ce42cb459f271109b777b309eeeaaafb6d83","_npmUser":{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},"jsdelivr":"./dist/pipe.min.js","_npmVersion":"11.9.0","description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","directories":{},"sideEffects":["*.css","./dist/pipe.min.js","./dist/pipe.mjs","./dist/pipe.cjs"],"_nodeVersion":"25.6.1","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/pipe-recording-client_2.0.4_1784620976203_0.6895662388165269","host":"s3://npm-registry-packages-npm-production"}},"2.0.5":{"name":"@addpipe/pipe-recording-client","version":"2.0.5","description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"homepage":"https://addpipe.com","bugs":{"url":"https://addpipe.com/contact"},"author":{"name":"Pipe","url":"https://addpipe.com"},"license":"Elastic-2.0","main":"./dist/pipe.cjs","module":"./dist/pipe.mjs","unpkg":"./dist/pipe.min.js","jsdelivr":"./dist/pipe.min.js","types":"./dist/pipe.d.ts","exports":{".":{"types":"./dist/pipe.d.ts","import":"./dist/pipe.mjs","require":"./dist/pipe.cjs"},"./pipe.min.js":"./dist/pipe.min.js","./pipe.css":"./dist/pipe.css","./pipe.min.css":"./dist/pipe.min.css","./package.json":"./package.json"},"sideEffects":["*.css","./dist/pipe.min.js","./dist/pipe.mjs","./dist/pipe.cjs"],"publishConfig":{"access":"public"},"gitHead":"364548d0480a1fc56b4ee44f09ba3b3226a8fb5c","_id":"@addpipe/pipe-recording-client@2.0.5","_nodeVersion":"25.6.1","_npmVersion":"11.9.0","dist":{"integrity":"sha512-x7f5XTHugj6Y0d+vggY96atEMjy1OUfpGuwq4Yw0Jpfc4FOoPhAC6amEp+I1KHo2C1xZyrAnnaJgvb4ULLk1rQ==","shasum":"27411080b48ef359354d4c13df4d14f3f16e6b16","tarball":"https://registry.npmjs.org/@addpipe/pipe-recording-client/-/pipe-recording-client-2.0.5.tgz","fileCount":9,"unpackedSize":380602,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIAy+tX+ATGOXcgmU7225Y+e2jGd6tjwSnTkGqQGKh7qRAiEA4PZ8VHw41M+bAvQVXzRXHD2EYrS9+Z/3Qi3hmIMv4CY="}]},"_npmUser":{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},"directories":{},"maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/pipe-recording-client_2.0.5_1785231876052_0.403090936497003"},"_hasShrinkwrap":false}},"time":{"created":"2026-06-24T12:17:28.904Z","modified":"2026-07-28T09:44:36.435Z","2.0.0":"2026-06-24T12:17:29.226Z","2.0.1":"2026-07-07T07:42:09.462Z","2.0.2":"2026-07-08T07:42:43.247Z","2.0.3":"2026-07-16T07:42:00.692Z","2.0.4":"2026-07-21T08:02:56.380Z","2.0.5":"2026-07-28T09:44:36.198Z"},"bugs":{"url":"https://addpipe.com/contact"},"author":{"name":"Pipe","url":"https://addpipe.com"},"license":"Elastic-2.0","homepage":"https://addpipe.com","keywords":["pipe","addpipe","video recording","audio recording","screen recording","webrtc","recorder","camera","microphone","webcam"],"description":"The Pipe 2.0 recording client. The easiest way to add video, audio, and screen + camera recording to a web app.","maintainers":[{"name":"octavn","email":"octavian@addpipe.com"},{"name":"alexgarbacea","email":"alexgrb0909@gmail.com"},{"name":"remusn","email":"remusnegrota@gmail.com"}],"readme":"# Pipe Recording Client\n\nThe easiest way to add video, audio, and screen + camera recording to your web app. This package provides the [Pipe](https://addpipe.com) 2.0 recording client directly via npm, so no `<script>` or `<link>` tags needed.\n\n> **Note:** You will need a [free trial or paid Addpipe account](https://addpipe.com) to use this package. Your account hash and environment ID are required when initializing the recorder.\n\nThis is the **exact same** Pipe 2.0 recording client, packaged for npm. The recorder still communicates with Pipe's servers at runtime. Installing via npm changes how you load the client, not how it works.\n\n## Install\n\n```bash\nnpm install @addpipe/pipe-recording-client\n```\n\n## React\n\nFor React projects, use the official hook instead:\n[@addpipe/react-pipe-media-recorder](https://www.npmjs.com/package/@addpipe/react-pipe-media-recorder)\n\n## Usage Examples\n\n### With a bundler (Vite, webpack, Rollup, Next.js, …)\n\n```js\nimport PipeSDK from '@addpipe/pipe-recording-client';\nimport '@addpipe/pipe-recording-client/pipe.min.css';\n\nPipeSDK.insert(\n  'recorder-container',\n  {\n    size: { width: 640, height: 390 },\n    qualityurl: 'avq/720p.xml',\n    accountHash: 'YOUR_ACCOUNT_HASH',\n    eid: 'YOUR_ENV_ID',\n    mrt: 600,\n    showMenu: 1,\n  },\n  (recorder) => {\n    recorder.onReadyToRecord = (id, type) => console.log('Ready:', id, type);\n    recorder.onSaveOk = (id, name, duration) => console.log('Saved:', name, duration + 's');\n  }\n);\n```\n\nAdd a target element in your HTML:\n\n```html\n<div id=\"recorder-container\"></div>\n```\n\n### Inserting multiple recorders into the page\n\nEach recorder needs its own container ID and a separate `PipeSDK.insert()` call:\n\n```js\nimport PipeSDK from '@addpipe/pipe-recording-client';\nimport '@addpipe/pipe-recording-client/pipe.min.css';\n\nconst pipeParams = {\n  size: { width: 640, height: 390 },\n  qualityurl: 'avq/720p.xml',\n  accountHash: 'YOUR_ACCOUNT_HASH',\n  eid: 'YOUR_ENV_ID',\n  mrt: 600,\n};\n\nPipeSDK.insert('recorder-1', pipeParams, (r1) => {\n  r1.onSaveOk = (id, name) => console.log('Recorder 1 saved:', name);\n});\n\nPipeSDK.insert('recorder-2', pipeParams, (r2) => {\n  r2.onSaveOk = (id, name) => console.log('Recorder 2 saved:', name);\n});\n```\n\n```html\n<div id=\"recorder-1\"></div>\n<div id=\"recorder-2\"></div>\n```\n\n## Choosing the delivery server (CDN or S1/EU)\n\nBy default the recorder loads its static assets from the global CDN at `cdn.addpipe.com`. To load\nthem from Pipe's EU client-delivery servers (S1) instead, call `PipeSDK.setServer()`\n**before** `PipeSDK.insert()`:\n\n```js\nimport PipeSDK from '@addpipe/pipe-recording-client';\nimport '@addpipe/pipe-recording-client/pipe.min.css';\n\nPipeSDK.setServer('s1'); // 'cdn' (default) | 's1'\n\nPipeSDK.insert('recorder-container', pipeParams, (recorder) => {\n  /* … */\n});\n```\n\n- `'cdn'` (default) — the global CDN, `cdn.addpipe.com`.\n- `'s1'` — Pipe's EU client-delivery servers, `s1.addpipe.com`.\n\n`setServer()` returns the resolved host. It has no effect once a recorder has been\ninserted, so call it first.\n\n## Controlling the Recorder\n\nTo control the recorders, you can use the API control methods, such as:\n\n- `record()`: Starts a new recording.\n- `stopVideo()`: Stops the recording.\n\nA full list of the recorder's API control methods can be found in the official [Pipe API Documentation](https://addpipe.com/docs/javascript/js-api-v2/#methods-list).\n\n## Embed Code Parameters\n\nThe `pipeParams` object is used to configure the Pipe recorder. Here’s an example of its structure:\n\n```js\nconst pipeParams = {\n  size: { width: 640, height: 390 },\n  qualityurl: \"avq/360p.xml\",\n  accountHash: \"YOUR_ACCOUNT_HASH\",\n  eid: \"YOUR_ENV_CODE\",\n  mrt: 600,\n  avrec: 1,\n  // Additional options available in the official documentation\n};\n```\n\nFor more detailed embed code options, refer to the [Addpipe Embed Code Options](https://addpipe.com/docs/desktop-recording-client/embed-code-options-desktop/#20-javascript).\n\n## Documentation and Pricing\n\nOfficial Developer Documentation: [Addpipe Docs](https://addpipe.com/docs)\nPricing Information: [Addpipe Pricing](https://addpipe.com/pricing)\n\n## Features\n\n- **Video, Audio, and Screen Recording**: Add high-quality media recording functionality to any project, supporting both desktop and mobile devices.\n- **Up to 4K Video**: Supports recording up to 4K resolution.\n- **No Upload Time**: Stream recordings while they are created, minimizing the wait time for users.\n- **Mobile Compatibility**: Supports HTML Media Capture for mobile video/audio recording.\n- **Screen + Camera Recording**: Capture both the screen and camera simultaneously for enhanced recording capabilities.\n- **Multilingual Support**: Available in multiple languages: English, French, German, and Spanish, with custom language support.\n- **Keyboard Accessibility**: Fully controllable via keyboard for improved accessibility.\n- **Connection Resilience**: Auto-reconnect ensures data recovery if the connection drops during recording.\n\n## Changelog\n\nA changelog is available [here](https://changelog.addpipe.com/).","readmeFilename":"README.md"}