Pipe Docs

Discover our detailed documentation for a quick understanding of key concepts and effective use of our tools

Introduction

Making Your First Recording
Embedding Your First Recorder
Loading Pipe.js in a Non-blocking Way
Two Versions of the Embed Code
Adding Multiple Recorders to the Page
Using the Minified Version of Pipe.js
Viewing Recordings from Your Account
Requirements and Supported Browsers
Avoiding Layout Shift

Desktop Recording Client

Introduction to the Desktop Recording Client
Changing the Size, Colors & CSS Classes
Allowing File Uploads from the Desktop Recorder
Audio and Video Quality
Embed Code Options
Hiding the Bottom Control Menu
HTML5 and Legacy Flash Clients Compared
Limiting the Length of Recordings
File Size Limits
Troubleshooting Connection Issues
Screen + Camera Recording
Record Audio Only

Mobile Recording Client

Introduction to the Mobile Recording Client
Changing the Size, Colors & CSS Classe
Limiting the Length of Recordings
File Size Limits
Forcing Users to Record on the Spot
Audio and Video Quality
Embed Code Options
Recording Audio Only

Pipe Languages

Pipe in Different Languages

Transcoding

Transcoding Engine

Security

Security at Pipe
Whitelisted Hosts
Recordings Security

Storage

Pipe's Complimentary Storage
Pushing Recordings to Amazon S3 Buckets or Compatible Services
SFTP
FTP(S)
Dropbox

Webhooks

Setting up Webhooks
Signing Webhooks

JavaScript API's

JavaScript API v1.0
JavaScript API v2.0

Custom Data

Attach Custom Data to Recordings

Rest API's

Rest Api V1

Plugins

Pipe Recorder Plugin for WordPress
NPM Package for React