Documentation

Embedding your first recorder

Embedding from the Pipe account area

To embed your first recorder in your website follow these 4 steps:

1. Sign in to your Pipe account area and go to the Embed Recorder section
2. In the lower right area you'll find the 1.0 and 2.0 embed codes. Copy the preferred one
3. Paste the code in your HTML page and make sure to save and upload the modified page back to your website
4. Refresh the page in your browser on your desktop or mobile device

The Pipe recording client will detect the browser used and, depending on your environment settings, will load the appropriate video recording client.

2 versions of the embed code

Pipe has 2 versions of the embed code. The 1.0 version is the initial one used since launch and the 2.0 version is the new one which eliminates some of the limitations of the 1.0 embed code. The 2.0 embed code has 2 further variants: HTML and JavaScript.

• Embed Code v1.0
• Embed Code v2.0

Adding multiple recorders to the page

One of the new things you can do with our new v2.0 embed code is to add multiple recorders to the HTML page.

v2.0 HTML

To do this with the v2.0 HTML embed code you must simply add multiple <piperecorder...> tags to your HTML page, with unique IDs, one for each recorder you want on the page. You can change the attributes for each recorder to fit your needs.

Here's an example with 3 recorders of different sizes, different recording resolutions and different max recording time:

<link rel="stylesheet" href="//cdn.addpipe.com/2.0/pipe.css"/>
<script type="text/javascript" src = "//cdn.addpipe.com/2.0/pipe.js"></script>
<piperecorder id="tag-recorder1" pipe-width="640" pipe-height="510" pipe-qualityurl="avq/480p.xml" pipe-accounthash="ACCOUNT_HASH" pipe-eid="1" pipe-showmenu="1" pipe-mrt="60" pipe-sis="0" pipe-asv="0" pipe-mv="1" pipe-st="1" pipe-ssb="1" pipe-dpv="0" pipe-ao="0" pipe-dup="1" pipe-cornerradius="8" pipe-bgcol="0xf6f6f6" pipe-menucol="0xe9e9e9" pipe-normalcol="0x334455" pipe-overcol="0x556677" pipe-payload='{"userId":"55a95eeb936dd30100e0aff6","jobId":"55a7e6555f1bdc010014d6a1"}'></piperecorder>
<piperecorder id="tag-recorder2" pipe-width="1280" pipe-height="720" pipe-qualityurl="avq/720p.xml" pipe-accounthash="ACCOUNT_HASH" pipe-eid="1" pipe-showmenu="1" pipe-mrt="120" pipe-sis="0" pipe-asv="0" pipe-mv="1" pipe-st="1" pipe-ssb="1" pipe-dpv="0" pipe-ao="0" pipe-dup="1" pipe-cornerradius="8" pipe-bgcol="0xf6f6f6" pipe-menucol="0xe9e9e9" pipe-normalcol="0x334455" pipe-overcol="0x556677" pipe-payload='{"userId":"55a95eeb936dd30100e0aff6","jobId":"55a7e6555f1bdc010014d6a1"}'></piperecorder>
<piperecorder id="tag-recorder3" pipe-width="320" pipe-height="240" pipe-qualityurl="avq/240p.xml" pipe-accounthash="ACCOUNT_HASH" pipe-eid="1" pipe-showmenu="1" pipe-mrt="180" pipe-sis="0" pipe-asv="0" pipe-mv="1" pipe-st="1" pipe-ssb="1" pipe-dpv="0" pipe-ao="0" pipe-dup="1" pipe-cornerradius="8" pipe-bgcol="0xf6f6f6" pipe-menucol="0xe9e9e9" pipe-normalcol="0x334455" pipe-overcol="0x556677" pipe-payload='{"userId":"55a95eeb936dd30100e0aff6","jobId":"55a7e6555f1bdc010014d6a1"}'></piperecorder>

You can move the insertion of pipe.js and pipe.css to the bottom of the page (after the <piperecorder...> tags) to avoid the page stopping from rendering until pipe.js and pipe.css are loaded.

After pipe.js and the rest of the page elements load (DOMContentLoaded), pipe.js will automatically replace the 3 tags with 3 recorders (divs with the same id) in the HTML DOM and fire PipeSDK.onRecordersInserted() if present.

Any JS events and control API implementation that relies on PipeSDK.onRecordersInserted() needs to be placed AFTER the code for inserting pipe.js in the page. Otherwise you'll get a Uncaught ReferenceError: PipeSDK is not defined error in the browser console.

v2.0 JavaScript

To add a video recorder to the page using JavaScript just insert pipe.css and pipe.js in the page and use PipeSDK.insert("div-id",config-object) every time you want to insert a recorder.

Here's for example how to insert 3 video recorders in the page. Each will replace a different DIV and have a different size (as specified in the config object).

<div id="custom-id1" ></div>
<div id="custom-id2" ></div>
<div id="custom-id3" ></div>

<link rel="stylesheet" href="//cdn.addpipe.com/2.0/pipe.css"/>
<script type="text/javascript" src = "//cdn.addpipe.com/2.0/pipe.js"></script>

<script type="text/javascript">
var pipeParams1 = {size: {width:400,height:330}, qualityurl: "avq/360p.xml",accountHash:"ACCOUNT_HASH", eid:1, showMenu:"true", mrt:60,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0};
var pipeParams2 = {size: {width:640,height:430}, qualityurl: "avq/480p.xml",accountHash:"ACCOUNT_HASH", eid:1, showMenu:"true", mrt:120,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0};
var pipeParams3 = {size: {width:1280,height:750}, qualityurl: "avq/720p.xml",accountHash:"ACCOUNT_HASH", eid:1, showMenu:"true", mrt:180,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0};

PipeSDK.insert('custom-id1', pipeParams1, function(myRecorderObject){ });
PipeSDK.insert('custom-id2', pipeParams2, function(myRecorderObject){ });
PipeSDK.insert('custom-id3', pipeParams3, function(myRecorderObject){ });
</script>

You can move the insertion of pipe.js and pipe.css to the bottom of the page to avoid the page stopping from rendering until pipe.js and pipe.css are loaded but any code involving PipeSDK will have to made after the code that inserts pipe.js in the page.

Viewing recordings on your account

Once a recording is made it will show up in your Pipe account area. You can see all the recordings for an environment on your account by clicking on the Recordings tab.

Here's how the list of recordings looks like:

Every recording appears on a table row along with useful information grouped in 7 columns:

Requirements and supported browsers

Changing the recorder size

The space occupied by the recorder client differs between the desktop recorder and mobile native recorder because the technology used is different and thus the UI is different.

Desktop recorder size

The size of the desktop recorder can be changed directly from the embed code or, when generating new embed codes, from our embed panel as shown below.

Changing when generating new embed codes

In your Pipe account area, under the "Embed Recorder" tab, you will find the following panel with the width and height options:

Use the 2 inputs to specify the width and height of the black video area inside the recorder. The values are in pixels.

The height value you specify here does not include the bottom control menu which will add 30px to the height. If you set a 320x240 size for the video area and keep the bottom menu you'll end up with a 320x270 recorder in pages opened on desktop devices.

After you enter your desired size, press the "Generate Embed Code" button to update the preview and the size values in the embed code to the right of the page.

The size of the recorder won't affect the resolution & quality of the videos recorded.

Changing directly in the embed code

If you have a recorder already embedded in your web pages or if you're in the editor and you want to do a quick change you can easily change the size of the desktop recorder.

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

var size = {width:400,height:330};

<piperecorder... pipe-width="400" pipe-height="330" ... >

var pipeParams = {size: {width:320,height:270}, qualityurl: "avq/360p.xml", accountHash:"1edfef4c4967d69b7129ec3ffa534002"};

Mobile native recorder size

• Embed Code v1.0
• Embed Code v2.0 via HTML or JS

Colors and rounded corners

Desktop recorder

Pipe's desktop recorder can be customised in terms of size (see above), colors and square/rounded corners. These styling options are available regardless of the embed code used (1.0 or 2.0).

Colors & rounded corners

You can change the colors of the desktop recorder to better fit your website design.

These can be changed from your account area for new recorders/embed codes or from the embed code directly.

Changing from the Pipe account area for new embed codes

To change the colors from you account area, you will have to open the design options panel:

From here you will be able to change from top to bottom:

1. the radius of the 4 corners of the recorder
2. the background color shown in the inital screen
3. the bottom menu background color
4. the normal and muse over colors for the text buttons in the initial screen

Once you're done, press the "Generate Embed Code" to see the changes and get the new embed code which includes these changes.

Changing in existing embed codes

For existing embed codes that you have in your website or blog posts you can edit the code directly. Here's what you have to do depending on your embed code version and type:

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

var flashvars = {qualityurl: "avq/360p.xml",accountHash:"1edfef4c4967d69b7129ec3ffa534002", eid:1, showMenu:"false", mrt:120,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0, cornerradius:40, bgCol:"0xff0000", menuCol:"0xff00e3", normalCol:"0x00ff77", overCol:"0xffda00"};

<piperecorder id="custom-id" pipe-width="400" pipe-height="300" pipe-qualityurl="avq/360p.xml" pipe-accounthash="1edfef4c4967d69b7129ec3ffa534002" pipe-eid="1" pipe-showmenu="false" pipe-mrt="120" pipe-sis="0" pipe-asv="1" pipe-mv="0" pipe-dpv="0" pipe-ao="0" pipe-dup="0" pipe-cornerradius=40 pipe-bgcol="0xff0000" pipe-menucol="0xff00e3" pipe-normalcol="0x00ff77" pipe-overcol="0xffda00" ></piperecorder>

var pipeParams = {size: {width:400,height:300}, qualityurl: "avq/360p.xml",accountHash:"1edfef4c4967d69b7129ec3ffa534002", eid:1, showMenu:"false", mrt:120,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0, cornerradius:40, bgCol:"0xff0000", menuCol:"0xff00e3", normalCol:"0x00ff77", overCol:"0xffda00"};

Mobile native recorder

Pipe's mobile native recorder can be customised in terms of size (see above) and colors.

Since the mobile recorder is made of 1 or 2 HTML buttons you can easily overwrite the CSS classes that apply to those elements.

1.0 embed code

When using the 1.0 embed code the user is presented with 2 buttons. As soon as the user clicks the top button the OS takes over.

Safari on iOS

Chrome on Android

2.0 embed code

When using the 2.0 embed code the user is only presented with one button. As soon as the user clicks the button the OS takes over.

For the CSS classes used by the 2.0 embed code for the recorder button shown on mobile browsers see below.

Hiding the bottom control menu

You can opt to hide the lower control menu of the desktop recorder. You may want to do this if you decide to control the recorder using the JavaScript Control API (embed code v1.0 or embed code v2.0). The menu has a height of 30px.

When generating an embed code from the Pipe account area you can hide the menu by unchecking the option shown in the image below:

Here's how the newer HTML5 recorder looks without the bottom menu:

Limiting the length of recordings

Desktop recorder

Recordings from the desktop recorder made on the spot using a webcam and/or microphone can be limited in length. Once the length is hit, the recorder stops the recording as if the STOP button had been clicked.

New embed codes

When generating a new embed code from the Pipe account area you can easily change the default length (120 seconds) by editing the Max Recording Time value and pressing the green Generate Embed Code.

The new embed code will create a recorder that will limit the length of the recordings recorded on the spot with the desktop recorder to your specified length.

The value is in seconds.

Existing embed codes

For existing embed codes that you have in your website or blog posts you can edit the code directly. Here's what you have to do depending on your embed code version and type:

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

var flashvars = {qualityurl: "avq/360p.xml",accountHash:"1edfef4c4967d69b7129ec3ffa534002", eid:1, showMenu:"true", mrt:120,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0};

<piperecorder id="custom-id" pipe-width="400" pipe-height="330" pipe-qualityurl="avq/360p.xml" pipe-accounthash="1edfef4c4967d69b7129ec3ffa534002" pipe-eid="1" pipe-showmenu="true" pipe-mrt="120" pipe-sis="0" pipe-asv="1" pipe-mv="0" pipe-dpv="0" pipe-ao="0" pipe-dup="0" ></piperecorder>

var pipeParams = {size: {width:400,height:330}, qualityurl: "avq/360p.xml",accountHash:"1edfef4c4967d69b7129ec3ffa534002", eid:1, showMenu:"true", mrt:120,sis:0,asv:1,mv:0, dpv:0, ao:0, dup:0};

Mobile native recorder

When recording from mobile browsers like Safari on iOS and Chrome on Android with the mobile native recorder we can not control the length of the recorded video. The HTML Media Capture standard we're using relies on the OS capabilities to handle the video recording and it does not have an option to limit the length.

Cut recordings from mobile native recorders (iOS and Android) to length

However, in Pipe, there is an option to cut mobile recordings to the max length specified in the embed code if the recording made with the mobile native recorder is longer than the maximum allowed length.

The option can be found in the Transcoding Engine section.

When relying on this mechanism you should advise your mobile users that their recordings will be cut to length.

You will only be charged for the processed portion of the recording, you will not be charged for the entire length.

Allowing file uploads from the desktop recorder

By default, with the desktop recorder, users can only record a new video or audio file using their webcam and/or microphone.

You can allow users to upload an existing audio or video file they have on their desktop device by turning on the file upload feature in the embed code.

Once the feature is enabled in the embed code, the desktop recorder will show a new option to upload an existing recording:

There is currently a max size limit of 1 GiB (1024*1024*1024 bytes). If the user tries to upload a larger file, the file will not be accepted and a message will be shown to the user.

New embed codes

For new embed codes you can turn on the feature from the Pipe account area. Activate the checkbox highlighted in the image below and press the green Generate Embed Code. Now copy and paste that embed code in your website.

Existing embed codes

For existing embed codes that you have in your website or blog posts you can edit the code directly. Here's what you have to do depending on your embed code version and type:

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

<piperecorder id="custom-id" pipe-width="400" pipe-height="330" pipe-qualityurl="avq/360p.xml" pipe-accounthash="1edfef4c4967d69b7129ec3ffa534002" pipe-eid="1" pipe-showmenu="true" pipe-mrt="120" pipe-sis="0" pipe-asv="1" pipe-mv="0" pipe-dpv="0" pipe-ao="0" pipe-dup="1" ></piperecorder>

var pipeParams = {size: {width:400,height:330}, qualityurl: "avq/360p.xml",accountHash:"1edfef4c4967d69b7129ec3ffa534002", eid:1, showMenu:"true", mrt:120, sis:0, asv:1, mv:0, dpv:0, ao:0, dup:1};

Supported file types (containers)

We’re currently allowing users to upload the following video & audio file types:

When audio only is turned ON (ao:1) users will only be allowed to upload audio files.

Audio and video quality

With Pipe, the amount of control over video quality depends on the recording client being used. With the HTML5 desktop recorder, you have granular control over the resolution. With the mobile native recorder, the resolution, audio and video quality depend on the device and the settings on the device.

Desktop recorder

Pipe has 2 desktop recorders (the HTML5 one for Chrome, Firefox and Edge (version 79+) and the inline desktop one for Chrome on Android) but regardless of the desktop recorder used, the video quality depends hugely on 3 factors:

1. the audio/video quality profile you chose for your embed code (influences resolution to a high degree)
2. the quality of the hardware/camera (affects max resolution, frame rate, picture quality and noise)
3. the light available in the room (low light results in lower fps and higher noise).

To control the resolution, Pipe offers 4 predefined audio/video quality profiles for the desktop recorders:

1. 240p : 320x240px
2. 360p : 640x360px (default)
3. 480p : 640x480px
4. 720p : 1280x720px (HD)

The profile you choose for your desktop recorder has a very high influence on the resolution of the videos recorded with that recorder. Not all cameras support all resolutions so some cameras will return a stream in a different resolution that the one desired. The resolutions we've selected for the profiles above are very safe though.

To use one of the predefined quality profiles (240p, 360p, 480p and 720p) just select it when generating the embed code in the Pipe account area:

The 720p (HD) video quality profile is only available with trial and PRO accounts.

If you'd like to record with a certain resolution (like for example if you want to record square videos or at higher resolutions like Full HD) you can create and use your own quality profiles. See using your own quality profiles for more information.

The recording resolution is not affected by the recorder size in the HTML page. You can have a small recorder embedded on your webpage in a sidebar that records videos at 1280x720 resolution.

HTML5 desktop recorder

The HTML5 desktop recorder will request the resolution mentioned in the quality profile. If the camera does not support it, the camera will return a stream with the closest possible resolution.

A framerate of 30fps is requested from the camera but it depends on the camera if it can supply it. Older webcams in low light situations will not be able to sustain this framerate especially with high resolutions.

Firefox compresses video data using VP8 while Chrome and Edge 79+ uses H.264. Pipe will convert the VP8 video data from Firefox to H.264 for the final .mp4 file that gets delivered to you.

Audio will be recorded as mono or stereo Opus audio at 48 kHz. It will be converted to AAC by Pipe for the final .mp4 file. Stereo audio will only be recorded from capable devices (Logitech C920, Logitech C925e, MacBook PRO with 3 mics, etc) on newer browsers (Chrome 63+ and Firefox 55+) and Edge 79+.

Firefox will apply an auto gain filter (tested with Firefox 68). Chrome will not apply any filters (tested with Chrome 76).

A noise suppression filter is turned on by default by Pipe with on Chrome, Firefox and Edge (tested on Edge 79). If you'd like to turn it off you can use the ns parameter in the embed code as explained in working directly with the embed code.

Inline HTML5 desktop recorder on Chrome on Android

Chrome on Android supports only these resolutions:

• 160x120 (4:3)
• 176x144 (4:3)
• 320x240 (4:3)
• 352x288 (4:3)
• 640x360 (16:9)
• 640x480 (4:3)
• 1280x720 (16:9)
• 1920x1080 (16:9)

So when using custom resolutions with the HTML5 desktop recorder inline in Chrome on Android devices keep in mind there is a high chance resolution requested may not be the resolution that is obtained. A resolution request of 400x300 will actually result in a 640x480 video stream.

Chrome on Android gives us VP8 video and Opus audio in .webm files. The data is converted to H.264 video and AAC audio in .mp4 files on our platform.

Mobile native recorder

The audio and video quality of recordings sent through our native recorder for mobile browsers depends a lot on the OS. iOS will compress the file leading to fast upload times while Android will leave the recording unchanged resulting in high quality videos.

iOS

On iOS, a user can upload videos in 2 resolutions depending on how that video is recorded:

• If, when prompted, the user records a new video, that video will be recorded at 360x480 (portrait) and 480x360 (landscape) at 30 FPS
• If, when prompted, the user chooses an existing video, that video will be compressed by iOS in terms of bitrate (the resolution and FPS will remain the same)

iOS videos will have AAC audio at 48kHz and H.264 video. The data is in a .mov container.

You can read more about the audio and video quality of recordings made with iOS from this article we've written on the topic.

Android

Android devices, on the other hand, will record video at whatever resolution is set on the device and will not compress the video before uploading. This can result in long upload times but high-quality videos.

The audio codec and sample rate will depend on the device itself. We've mostly seen AAC audio at 48kHz but occasionally we do get AMR audio in 3GP container and other exotic audio codecs and containers.

Non AAC audio will be converted by Pipe to AAC for the final .mp4 file.

Some notes

We're seeing videos in various formats from mobile devices: mp4, mov, 3gp, webm, etc. . All these recordings are converted by Pipe to a universally working .mp4 file.

High framerate videos (60 FPS) from mobile devices will keep their FPS value after being processed by Pipe.

When uploading slow motion videos (120 FPS videos played back at 30 FPS), in some cases (iOS, Lenovo Vibe P2 with Android 7.0) the OS compresses the video down to 30 FPS while keeping the slow motion effect, in others (Huawei P20 Lite with Android 8.0) the original FPS value (120) is untouched.

Using your own quality profile

Pipe allows you to use your own audio/video quality profile in the desktop recorder by linking directly to it, in the embed code, using the qualityurl parameter. This ability comes in handy if, for example, you want to record square videos or higher resolution videos - like Full HD - with the desktop recorder.

Step 1: create your own quality profile file and host it

Here are the 4 quality profiles available through the Pipe account area: 240p, 360p, 480p and 720p. Download one, make your changes and upload it to your website.

Here's every setting you can change in the profile, which of the settings are used by each desktop recorder, and their default values:

Step 2: link to the new .xml file in your Pipe embed

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

Step 3: allow Pipe to load the .xml file from your website

In order for Pipe to be able to load your custom .xml video quality profile, you will need to do the following:

In case your are hosting the custom .xml audio-video quality profile file on a different domain than the one you are you are embedding Pipe in, you must enable CORS on the server on which you are hosting the custom .xml audio-video quality profile (necessary for the HTML5 client). For example on Apache, one of the most commonly used webservers, to add the CORS authorization to the header you must simply add the following line in either the Directory, Location, Files or VirtualHost sections of your server config (usually located in a *.conf file, such as httpd.conf or apache.conf), or within a .htaccess file:

Header set Access-Control-Allow-Origin "https://SITE-WHERE-PIPE-IS-EMBEDDED.com"

CSS classes in the v2.0 embed code

Our newer 2.0 embed code uses this CSS file to control the look and feel of the HTML5 desktop recorder and mobile native recorder.

We use classes instead of ids to target HTML UI elements because the 2.0 embed code allows for multiple recorders on the same page. All the recorders on a page will have these CSS classes applied to them.

These are the most important CSS classes:

How to override the CSS classes

To override the classes you can simply add !important to your own implementation of the CSS class, for example let's take the following Pipe CSS class:

.pipeRecordRTC span{
    position:absolute;
    margin: 0;
    left:50%;
    top:50%;
    margin-right: -50%;
    transform: translate(-50%, -50%);
    font-family:sans-serif;
    font-size:18px;
    cursor: pointer;
}

Let's say you wish to make the text in the initial record screen on the desktop recorder a little bit smaller, just 15px. To do this you simply re-declare the CSS class in your custom CSS file that you already probably have and just add the font-size:12px !important; property:

.pipeRecordRTC span{
    font-size:15px !important;
}

That's it. Now the text in the initial record screen on the desktop recorder will have a smaller font size.

Working directly with the embed code

You can change most of the recorder client's options directly in your embed code. The size, the maximum recording time, the payload data and more can all be changed by making changes to the embed code.

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

PipeSDK.insert('my_ID', parametersObject, function(recorderObject){
    //custom code goes here
}

Pipe in different languages

The Pipe recording clients default to English, supports 3 other languages and can also use custom wording or a different language by using an external language file hosted by you.

The Pipe client supports the following languages: English (default), French, German and Spanish.

On PC/Mac

The Pipe desktop recorder auto-detects the preferred language setting of the browser in which it is run (using HTTP Accept Language Headers) and will use that language if available.

On iOS/Android

On mobile devices the preferred language setting in the mobile OS is used, regardless of the recording client you are using (desktop recorder on Chrome 63+ on Android or the mobile native recorder).

Using your own language file

Header set Access-Control-Allow-Origin "https://SITE-WHERE-PIPE-IS-EMBEDDED.com"

HTML5 and legacy Flash clients compared

Troubleshooting connection issues

Our desktop recorder works by streaming data in real-time over WSS (secure websockets) to a media server hosted by us.

The connection process in the HTML5 desktop recording client

The HTML5 desktop recording client connects to our ingestion media servers using WSS (secured WebSockets) over port 443.

The connection is established as soon as the user presses [Record Video] or [Record Audio] or [Record Screen] on the initial screen.

Reconnection mechanism

In case of a network problem resulting in disconnection, the HTML5 desktop recorder will try to reconnect 30 times before giving up.

Each of the 30 attempts to reconnect can timeout after 20 seconds. After each timeout or failed re-connection attempt, the recorder will wait between 0.5 and 5 seconds before making another attempt. Thus, it can take a maximum of 750 seconds ((20s timeout + 5s delay) * 30 attempts = 750 seconds = 12.5 minutes) for the recorder to spend all 30 attempts. This interval can be even higher if there's anything blocking the JavaScript client side.

If a disconnection happens while recording, the recording process will continue, but a message will be shown to the user. If the connection is re-established, the data recorded while the connection was interrupted will start uploading to the media server while the recording process continues.

Connection errors

In case of a connection problem, the HTML5 desktop recorder will show one of the following messages:

Not Connected. Reconnecting in 1s...

The disconnection happens AFTER a successful wss connection has been established.

Causes:

1. A busy or high latency WiFi network might cause continuously open wss connections to disconnect
2. The Internet connection might actually fail (ISP problems, power failure, tripping over the router, etc.)
3. Conditions on the network (proxy, firewall) have changed not allowing web socket connections any more

Not Connected. Reconnecting...

Causes:

After a disconnection, Pipe will make a total of 30 attempts to reconnect to the media server. While the attempts are made, this message is shown. This message is usually shown for a fraction of a second.

Not Connected (wss). Reconnecting in 1s..

After a disconnection, when the attempt to reconnect is made through websockets. This message is shown if that websocket reconnection attempt fails. This can happen if any of the issues that caused the initial disconnect are still present.

Reconnected

Shown for a moment after a successful reconnect attempt.

Your connection to the server has been interrupted

If disconnected, after 30 unsuccessful attempts to reconnect, the connection is considered fully interrupted.

Causes:

1. The user is disconnected form the Internet (ISP problems, power failure, tripping over the router, etc.)
2. The media server might be down or have no Internet connection

Recording recovery mechanism

For recordings made with our desktop HTML5 recorder by capturing from the camera or screen, the ingestion media servers have a recording recovery mechanism in place that recovers the recording if, while streaming the recording (so while recording or uploading it), the connection is interrupted, and a new connection can't be established. This mechanism is triggered only if the autosave option is enabled in the embed code (by default, it is enabled).

HTML5 desktop recorder

Recordings made by capturing from the camera or screen and streaming back to our ingestion servers

In case of a network problem resulting in disconnection, the HTML5 desktop recorder will try to reconnect 30 times before giving up. As shown above, this process can take up to 750 seconds and even more. That's why the ingestion media server, under normal circumstances, will wait 15 minutes - from the moment the disconnection is detected server-side - before attempting to recover an unsaved recording. It needs to give the user all the time it needs to cycle through his 30 reconnect attempts.

Uploading an existing recording

The recovery mechanism does not function with existing recordings uploaded through the desktop recording client.

Native mobile recording client

The recovery mechanism does not function with new or existing recordings uploaded through the mobile recording client.

Using webhooks instead of the JS Events API

We recommend relying on webhooks for integrating the Pipe recording client instead of relying on the JavaScript APIs because webhooks will trigger for recovered recordings. When the disconnection is the result of the user navigating away, closing the tab, browser crash, or the window/tab being accidentally closed, the JS API events will not trigger. As a result, any POST or GET requests (made within your JS) back to your server (to save the data) will never trigger. When the disconnection results from a network connection problem like a high latency wireless connection, the JS will execute on the client, but any POST or GET requests might fail.

Screen recording in HTML5 desktop recorder

Record audio only

How to enable it

From the UI

You can easily enable Pipe to record audio only:

1. Sign into your Pipe account
2. Go to the Embed Recorder page
3. On the left in the Options panel check Record audio only
4. Click Generate Embed Codes
5. Copy and paste the newly generated code in your website

From code

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

Alternatively you can also add the new parameter ao and set it to 1 in your existing embed code like so:

Add the pipe-ao="1" attribute to the piperecorder tag

Add the ao property to your custom javascript object and give it the value of 1: ao:1. Your custom object will be passed as a parameter to PipeSDK.insert()

How it looks

Once audio only recording is enabled the recorder will look as follows:

Desktop recorder

Mobile native recorder

Support

On Desktop

The HTML 5 desktop recorder supports audio only recording.

On Mobile Android Devices

Recording just audio from Android devices is supported with both the mobile native recorder and the desktop recorder.

On Mobile iOS Devices

It is not possible to record just audio from iOS devices at this time because Safari on iOS does not support audio capture through the HTML Media Capture standard. When asked to record only audio it will give the user the (wrong) option to record a video or take a picture. The latest we've tested is iOS 12.3.1.

By looking at our (video recording) data for September 2017 we determined only 0.4% of all recordings were recorded from iOS, the rest were recorded from Android (9.6%) and from desktop devices (90%).

Audio Recording Quality

Desktop recorder

The HTML5 client will record audio using Opus codec at 48 kHz in a .webm container. We convert it to AAC at 48 kHz in an .mp4 file.

Mobile native recorder

When recording audio using the mobile native recorder, a wide range of containers and audio codecs will be used depending on the device and Android version. As of now the following codecs and containers are supported.

Container	Audio Codec
mp3	mp3
m4a	aac
3gp	amr-nb
3gpp	amr-nb
3gpp2	amr-nb
aac	aac

All of them are converted to .mp4 files with AAC while keeping the original sampling frequency.

Transcoding settings

Pushing recordings to Pipe's S3 storage

Depending on the enabled outputs in the Transcoding Engine section, the resulting files (MP4 file, original recording, snapshot and filmstrip) will be pushed to our AWS S3 buckets. Depending on the region setting for the environment you're recording with, the final recording files will be pushed to one of 3 buckets:

• EU (Frankfurt, eu1-addpipe.s3.eu-central-1.amazonaws.com)
• US1 (N. California, us1-addpipe.s3-us-west-1.amazonaws.com)
• US2 (N. Virginia, us2-addpipe.s3.us-east-1.amazonaws.com)

Storage classes:

We use the following S3 storage classes to store the files:

1. S3 Intelligent-Tiering for the resulting .mp4 file
2. S3 Standard for the snapshot and filmstrip
3. S3 Standard-IA (infrequent access) for the raw transcoding file

For more info on Amazon S3 storage classes check out this page.

Not storing recordings on Pipe's S3 storage

Pipe gives you to the option to not store the resulting files (raw recording, processed recording, snapshot and filmstrip) on Pipe's AWS S3 storage. This option is available independently for each environment and you can find it in the storage section.

If you activate this option, we will not push the resulting recording files to our storage. As soon as the files have been pushed to all your configured storage options ((S)FTP, S3, Dropbox) they will be deleted from our processing server.

This affects only the recordings made after the setting is turned on. Prior recordings won't be removed.

Files that fail to be pushed to your storage after up to 13 attempts across 75 hours since the recording was saved to our database are kept for 28 EEST/EET days to allow both parties to access the files and attempt a manual push.

In the case of recordings that fail to transcode after up to 13 attempts across 75 hours since the recording was saved to our database we keep the original recording for 28 EEST/EET days to allow both parties to access the file and understand why the transcoding failed (invalid recording, exotic codecs, empty recording, etc.).

CORS headers

The buckets we use to store recordings have CORS enabled meaning that if you send the Origin header as part of your GET requests, the S3 bucket will reply with the actual recording together with the following headers:

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET
Access-Control-Max-Age: 3000

Here's how the request/response CORS headers look in Postman:

These CORS headers come in handy if for example you want to load a video recording in the browser and apply effects to it using Seriously.js.

Pushing recordings to FTP/SFTP

Configuring

Depending on the enabled outputs in the Transcoding Engine section, the resulting files (MP4 file, original recording, snapshot and filmstrip) can be pushed to any location using FTP or SFTP. You will need the hostname or IP, a user with write permissions and the password.

To set this up, just fill in the form in the "SFTP or FTP" page with the required credentials and you're good to go.

(S)FTP Logs

In this page you will also find the latest 100 attempts to push to the FTP account you povided.

FTP Upload Status Types

SFTP Upload Status Types

Pushing recordings to AWS S3 buckets

The Pipe platform can push the final outputs (MP4 file, original recording, snapshot and filmstrip) to your own AWS S3 bucket for storage and delivery.

For this you'll need an AWS account, an S3 bucket and security credentials. We will cover these below.

In the end, to have Pipe push the files to your bucket, you'll have to provide the following information in the Pipe account area:

• Bucket name
• Bucket region (or custom endpoint)
• Access Key ID
• Secret Access Key

You'll also be able to configure:

• the folder in the bucket where to put the recordings
• type of canned access control list

Let's get started!

Step 1: Create an AWS account

You can sign up for a free AWS account at https://aws.amazon.com/free/. The free account includes 5GB of storage for 12 months.

Step 2: Create an Amazon S3 bucket

With the AWS account created you now need an S3 bucket so let's create one:

1. While signed in to AWS go to the section for the S3 storage service.
2. Click the [Create Bucket] button
3. Give it a name, select a region and click [Next]
4. In Configure options you can turn on versioning, logging, encryption; click [Next]
5. In Set permissions uncheck Block new public ACLs and uploading public objects if you want to play, deliver or download the recording straight from your S3 bucket; click [Next]
6. In Review click [Create bucket]

Step 3: Generate the security credentials

Generating the security credentials is the last part, here's what you need to do:

1. While signed in to AWS go to Security Credentials. The link is in the top right menu under your name
2. If asked, click [Continue to Security Credentials]
3. In the list on the page click on Access keys (access key ID and secret access key)
4. Click on the button
5. Then press the link, your access keys will show up, copy it and paste it somewhere safe

Step 4: Configure Pipe to push files to your bucket

After the 3 steps above you should now have all the required information. You still have to provide it to Pipe, here's what you need to do:

• go to the Amazon S3 section in your Pipe account
• fill in all the information in the form.
• click [Save Amazon S3 Credentials]

Depending on the enabled outputs in the Transcoding Engine section, the resulting files will now be pushed to your S3 bucket.

Be advised: We are using S3 with ACL uploading, so if you are using Amazon's IAM system and you've created a custom policy for your Amazon user that is doing the upload to S3 and you are using a public Canned ACL, add the following permission/action for it: s3:PutObjectAcl. All policies require the s3:PutObject permission, regardless of the type of Canned ACL that you selected.

S3 Logs

The log containing information about the latest 100 attempts to push the converted files to the S3 bucket will show the following:

S3 Upload Status Types

Pushing recordings to Dropbox

The resulting files (MP4 files, original recording, snapshot, filmstrip) can be pushed to your own Dropbox account for storage. For that, you'll need to create a Dropbox app and generate an access token.

Creating your Dropbox application

The 1st thing you need is a Dropbox app so let's create one:

1. Sign in to your Dropbox account at dropbox.com.
2. After signing in, go to the Developer Page and click [Create App] in the top right corner under your name:
3. In the next page:
   • Under Choose an API select Scoped access
   • Under Choose the type of access select App folder
   • Name your app & click [Create App]

Obtaining the Dropbox access token

1. After the app is created you will be redirected to the app settings tab. At the top, switch to the [Permissions] tab.
2. In the Files and folders permission section check the files.content.write permission and click [Submit].
3. Go back in the [Settings] tab, scroll down a bit and, under the OAuth 2 section, from the Access token expiration dropdown select the [No Expiration] option:
   
4. Click [Generate] to generate the access token:
   

Configuring the Pipe environment to push the resulting files to your Dropbox folder using your new token

After you get the acces token, go to the Dropbox tab in your Pipe account and paste it in the form.

For the Dropbox Folder, you can choose any name you wish. The recording files will be pushed to /Apps/{your app name}/{folder name}.

After you click [Save Dropbox Credentials] new recordings (and any associated files like the snapshot or filmstrip) will be pushed to your Dropbox folder.

Dropbox Logs

The Dropbox storage logs (available at https://addpipe.com/dropbox_logs) will show the following:

Dropbox Upload Status Types

Setting up webhooks

Webhooks allow you to create integrations which subscribe to certain events in Pipe. When one of those events happens, we'll trigger a webhook that'll send (POST) the event data to the webhook's URL. Pipe allows webhook URLs with up to 200 characters in length.

Webhooks can be used to receive & save the information about new recordings to your database, trigger a copy action to your own storage or execute any other code.

Multiple webhooks can be set on each environment and each webhook can be triggered on multiple events.

Setting up your first webhook

Go to your account and click on the Webhooks tab. To add a new webhook simply click on the Add New Webhook button. You will be taken to the webhook setup page:

Webhook events

There are 6 events in a recording's timeline you can subscribe to with each webhook:

1. video_recorded: sent as soon as a new recording is finished and saved to our database (recording is not yet converted or pushed to storage).
2. video_converted: sent right after a recording is converted to .mp4.
3. video_copied_pipe_s3: sent right after a recording is successfully stored on the Pipe (S3) storage and thus it is ready to be played back.
4. video_copied_ftp: sent right after a recording is successfully pushed to your (S)FTP storage.
5. video_copied_s3: sent right after a recording is successfully pushed to your Amazon S3 storage.
6. video_copied_dbox sent right after a recording is successfully pushed to Dropbox account.

Data sent

Data can be sent with one of the following Content-Type headers:

• application/x-www-form-urlencoded: a payload variable containing the JSON data about the event will be sent
• application/json: the JSON data will be sent directly as the body of the POST request

• application/x-www-form-urlencoded
• application/json

payload={
	"version":"1.0",
	"event":"video_recorded",
	"data":{
		"videoName":"STREAM_NAME",
		"audioCodec":"NellyMoser ASAO",
		"videoCodec":"H.264",
		"type":"flv",
		"id":"123",
		"dateTime":"2016-03-03 15:51:44",
		"timeZone":"Europe/Bucharest",
		"payload":"your payload data string",
		"httpReferer":"http://site_from_where_video_was_recorded.com",
		"cam_name":"Logitech HD Pro Webcam C920 (046d:082d)",
		"mic_name":"Default",
		"ip":"91.16.93.181",
		"ua":"Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Mobile Safari/537.36"
	}
}

payload={
	"version":"1.0",
	"event":"video_converted",
	"data":{
		"videoName":"STREAM_NAME",	
		"duration":7,
		"cutToLength":0,
		"audioCodec":"AAC",
		"videoCodec":"H.264",
		"type":"mp4",
		"size":194373,
		"width":320,
		"height":240,
		"orientation":"landscape",
		"id":"0",
		"dateTime": "2015-10-10 16:00:36",
		"timeZone":"Europe/Bucharest",
		"payload":"your payload data string"
	}
}

payload={
	"version":"1.0",
	"event":"video_copied_pipe_s3",
	"data":{
	    "storedStatus":"stored successful",
		"videoName":"STREAM_NAME",	
		"size":194373,
		"checksum_md5": "MD5_HASH",
		"checksum_sha1": "SHA-1_HASH",
		"id":"0",
		"url":"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.mp4",
		"rawRecordingUrl":"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_raw.EXTENSION",
		"snapshotUrl":"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.jpg",
		"filmstripUrl:"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_filmstrip.jpg",
		"cdn":{"cdnRecordingUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.mp4",
			"cdnRawRecordingUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_raw.EXTENSION",
			"cdnSnapshotUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.jpg",
			"cdnFilmstripUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_filmstrip.jpg"},
		"bucket":"Pipe bucket name",
		"region": "Pipe bucket region",
		"payload":"your payload data string",
	}
}

payload={
	"version":"1.0",
	"event":"video_copied_ftp",
	"data":{
		"ftpUploadStatus":"upload success",
		"videoName":"STREAM_NAME",
		"type":"MP4",
		"size":493534,
		"id":"123",
		"payload":"your payload data string"
	}
}

payload={
	"version":"1.0",
	"event":"video_copied_s3",
	"data":{
		"s3UploadStatus":"upload success",
		"videoName":"STREAM_NAME",
		"type":"MP4",
		"size":493534,
		"checksum_md5": "MD5_HASH",
		"checksum_sha1": "SHA-1_HASH",
		"id":"123",
		"url":"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.mp4",
		"rawRecordingUrl":"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_raw.EXTENSION",
		"snapshotUrl":"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.jpg",
		"filmstripUrl:"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_filmstrip.jpg",
		"bucket":"bucketname",
		"region":"us-east-1",
		"acl":"public-read",
		"payload":"your payload data string"
	}
}

payload={
	"version":"1.0",
	"event":"video_copied_dbox",
	"data":{
		"dboxUploadStatus":"upload success",
		"videoName":"STREAM_NAME",
		"type":"MP4",
		"size":493534,
		"id":"123",
		"payload":"your payload data string"
	}
}

{
    "version":"1.0",
    "event":"video_recorded",
    "data":{
        "videoName":"STREAM_NAME",
        "audioCodec":"NellyMoser ASAO",
        "videoCodec":"H.264",
        "type":"flv",
        "id":"123",
        "dateTime":"2016-03-03 15:51:44",
        "timeZone":"Europe/Bucharest",
        "payload":"your payload data string",
        "httpReferer":"http://site_from_where_video_was_recorded.com",
        "cam_name":"Logitech HD Pro Webcam C920 (046d:082d)",
        "mic_name":"Default",
        "ip":"91.16.93.181",
        "ua":"Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/64.0.3282.186 Mobile Safari/537.36"
    }
}

{
    "version":"1.0",
    "event":"video_converted",
    "data":{
        "videoName":"STREAM_NAME",  
        "duration":7,
        "cutToLength":0,
        "audioCodec":"AAC",
        "videoCodec":"H.264",
        "type":"mp4",
        "size":194373,
        "width":320,
        "height":240,
        "orientation":"landscape",
        "id":"0",
        "dateTime": "2015-10-10 16:00:36",
        "timeZone":"Europe/Bucharest",
        "payload":"your payload data string"
    }
}

{
    "version":"1.0",
    "event":"video_copied_pipe_s3",
    "data":{
        "storedStatus":"stored successful",
        "videoName":"STREAM_NAME",  
        "size":194373,
        "checksum_md5": "MD5_HASH",
        "checksum_sha1": "SHA-1_HASH",
        "id":"0",
        "url":"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.mp4",
        "rawRecordingUrl":"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_raw.EXTENSION",
        "snapshotUrl":"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.jpg",
        "filmstripUrl:"https://addpipevideos.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_filmstrip.jpg",
        "cdn":{"cdnRecordingUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.mp4",
            "cdnRawRecordingUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_raw.EXTENSION",
            "cdnSnapshotUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.jpg",
            "cdnFilmstripUrl":"https://recordings-eu.addpipe.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_filmstrip.jpg"},
        "bucket":"Pipe bucket name",
        "region": "Pipe bucket region",
        "payload":"your payload data string",
    }
}

{
    "version":"1.0",
    "event":"video_copied_ftp",
    "data":{
        "ftpUploadStatus":"upload success",
        "videoName":"STREAM_NAME",
        "type":"MP4",
        "size":493534,
        "id":"123",
        "payload":"your payload data string"
    }
}

{
    "version":"1.0",
    "event":"video_copied_s3",
    "data":{
        "s3UploadStatus":"upload success",
        "videoName":"STREAM_NAME",
        "type":"MP4",
        "size":493534,
        "checksum_md5": "MD5_HASH",
        "checksum_sha1": "SHA-1_HASH",
        "id":"123",
        "url":"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.mp4",
        "rawRecordingUrl":"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_raw.EXTENSION",
        "snapshotUrl":"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME.jpg",
        "filmstripUrl:"https://bucketname.s3.amazonaws.com/b8e2f5bfd04a93b434bd8c740bff744d/STREAM_NAME_filmstrip.jpg",
        "bucket":"bucketname",
        "region":"us-east-1",
        "acl":"public-read",
        "payload":"your payload data string"
    }
}

{
    "version":"1.0",
    "event":"video_copied_dbox",
    "data":{
        "dboxUploadStatus":"upload success",
        "videoName":"STREAM_NAME",
        "type":"MP4",
        "size":493534,
        "id":"123",
        "payload":"your payload data string"
    }
}

Handling the data

• application/x-www-form-urlencoded
• application/json

payload%7B%22version%22%3A%221.0%22%2C%22event
%22%3A%22video_recorded%22%2C%22data%22%3A%7B%22
videoName%22%3A%22vs1457013120534_862
%22%2C%22audioCodec%22%3A%22NellyMoser%20ASAO
%22%2C%22videoCodec%22%3A%22H.264%22%2C%22
type%22%3A%22FLV%22%2C%22orientation%22%3A%22
landscape%22%2C%22id%22%3A%22123%22%2C%22d
ateTime%22%3A%222016-03-03%2015%3A51%3A44%22%2C%22
timeZone%22%3A%22Europe%2FBucharest%22%2C%22
payload%22%3A%22your%20payload%20data%20string%22%2C%22
httpReferer%22%3A%22http%3A%2F%2F
your_site.com%22%7D%7D

{
	"version":"1.0",
	"event":"video_recorded",
	"data":{
		"videoName":"vs1457013120534_862",
		"audioCodec":"NellyMoser ASAO",
		"videoCodec":"H.264",
		"type":"FLV",
		"orientation":"landscape",
		"id":"123",
		"dateTime":"2016-03-03 15:51:44",
		"timeZone":"Europe/Bucharest",
		"payload":"your payload data string",
		"httpReferer":"http://your_site.com"
	}
}

$data = file_get_contents("php://input");
$retrievedData = json_decode($data, true);

Every parameter explained

Let's talk about the information sent by these webhooks

version contains the current version of the Pipe's webhook API.

event contains the name of the event that triggered this call

videoName contains the name of the recording

duration contains the duration in seconds with two decimals

cutToLength contains a 1 or 0 value, indicating whether the recording was cut to length or not. This is only sent for recordings coming from mobile, desktop recorder uploads or POST API uploads.

audioCodec contains the audio codec used in the original video (video_recorded) or in the final video (video_converted)

videoCodec contains the video codec used in the original video (video_recorded) or in the final video (video_converted). For an audio only recording it will have the value "no_video".

type is the original's recording file type. This can give you a clue on where this recording is coming from. For example, an iPhone will produce .mov files while the HTML5 recorder will produce .webm files.

size is the size in bytes

checksum_md5 contains the 32 characters md5 hash checksum of the final processed mp4 recording file. If the mp4 output is disabled in the Transcoding Engine, the value will be for the the original recording.

checksum_sha1 contains the 40 characters sha-1 hash checksum of the final processed mp4 recording file. If the mp4 output is disabled in the Transcoding Engine, the value will be for the the original recording.

width and height represents the size of the original recording. This can also give you a clue about the device the recording is coming from. For an audio only recording they will have the value 0.

orientation represents the orientation of the device when the recording was made. This could be either "landscape" or "portrait" or "none". For an audio only recording it will have the value "none".

id is the ID of the recording as you will find it in your Pipe account area and as it is stored in our database.

dateTime is the date and time relative to your set timezone at which the recording has been inserted in the db (video_recorded) or has finished converting (video_converted).

timeZone represents your selected time zone in the account settings.

url

• For thevideo_copied_pipe_s3 event, it is the full path to where the MP4 recording is located on our S3 storage. If the MP4 output is not enabled this field will be an empty string.
• For thevideo_copied_s3 event, it is the full path to where the MP4 recording is located on your S3 bucket. If the MP4 output is not enabled this field will be an empty string.

rawRecordingUrl

• For thevideo_copied_pipe_s3 event, it is the full path to where the original recording is located on our S3 storage. If the original recording output is not enabled this field will be an empty string.
• For thevideo_copied_s3 event, it is the full path to where the original recording is located on your S3 bucket. If the original recording output is not enabled this field will be an empty string.

snapshotUrl

• For thevideo_copied_pipe_s3 event, it is the full path to where the snapshot is located on our S3 storage. If the snapshot output is not enabled this will be an empty string. For an audio only recording it will have the value "audio_file".
• For thevideo_copied_s3 event, it is the full path to where the snapshot is located on your S3 bucket. If the snapshot output is not enabled this will be an empty string. For an audio only recording it will have the value "audio_only".

filmstripUrl

• For thevideo_copied_pipe_s3 event, it is the full path to where the filmstrip is located on our S3 storage. If the filmstrip output is not enabled this will be an empty string. For an audio only recording it will have the value "audio_file".
• For thevideo_copied_s3 event, it is the full path to where the filmstrip is located on your S3 bucket. If the filmstrip output is not enabled this will be an empty string. For an audio only recording it will have the value "audio_only".

cdn is the object containing all the CDN URLs for each of the recording outputs. Depending on the S3 origin region, the CDN links will have different specific subdomains: recordings-eu.addpipe.com (EU) or recordings-us.addpipe.com (US). The URLs are in sync with the S3 (origin) URLs. The CDN URLs for each output are named as follows: cdnRecordingUrl,cdnRawRecordingUrl,cdnSnapshotUrl and cdnFilmstripUrl.

payload is the payload data in string format that can be set initially in the embed code of Pipe. Find out more at: Sending custom data using payload. If no custom payload is sent this will be an empty string.

ftpUploadStatus is the status of the (S)FTP upload.

s3UploadStatus is the status of the S3 upload.

bucketname is the name of the S3 bucket.

region is the server region of the S3 bucket.

acl is the Amazon S3 Access Control Lists type.

dboxUploadStatus is the status of the Dropbox upload.

httpReferer is the link to the site from which the recording was made.

Webhook schedule

The Webhook schedule section shows the list of events we've sent data for. Events from the last 72 hours are shown for Standard accounts and from the last 30 days for PRO accounts.

If you have a webhook configured to fire for more than one event, each event will show up in this section. Events are added to this list as the recording goes through our processing pipeline.

If the first attempt of firing the webhook for an event runs into an issue/problem, you can always use this section to re-send the webhook for that particular event. You can also re-send webhooks if you just need them to be sent more than once. For each firing of a webhook, a log entry will be created in the webhook logs section.

The following information is available in the webhook schedule table:

Webhook logs

The Webhook logs section shows the logs associated with events from the last 72 hours (Standard accounts) or 30 days (PRO accounts). Each attempt to push data to your webhook URL for a particular event has an entry here.

For example: a recording was converted and the video_converted webhook that you have setup has been immediately scheduled and fired but for some reason your webhook code fails to run correctly and the web server ends up responding with a 500 Internal Error HTTP status. You re-send the webhook from the schedule section. This time, the webhook fires and your webhook handling code correctly processes the data. In this example, a total of 2 log entries will be created for the same webhook event: the one that failed and the 2nd one that resulted in a successful execution of your code.

The following information is available in webhook logs table:

SSL status codes

The table in the webhook logs section has a column named "SSL status". This is what the numeric status codes in that column (if any) mean:

Authenticating webhooks

Pipe automatically signs the webhook requests so you can (optionally) verify that the requests are coming from Pipe and not a third-party. This is useful if your application exposes sensitive data, but it is not required. It just adds an additional layer of protection.

Pipe adds an additional HTTP header with the webhook POST requests, X-Pipe-Signature, which contains the specific signature for the request. To verify this request, you will need to generate a signature using the same key that Pipe uses (the one in your account webhook tab) and compare the value obtained with the value sent via header.

Getting your webhook authentication key

In the webhook tab of your account, a key is automatically generated. You can use this one or reset it to generate a new one at any time. Pipe will automatically use the newest one.

Generating your own signature for comparison

In the code that receives and processes the webhook request:

1. Create a string of the webhook's URL, exactly as your entered it in Pipe. Pipe will always sign the webhook requests with the exact URL, so any small difference will prevent the signature from validating.
2. Append the JSON POST data received via webhook to the URL string.
3. Hash the resulting string with HMAC-SHA1, using the webhook authentication key from your account and generate a binary signature. Pipe uses binary signatures so be careful not to generate a hexadecimal signature.
4. Base64 encode the binary signature.
5. Compare the generated signature with the one provided by X-Pipe-Signature HTTP header.

Example of a PHP implementation of the steps above

  /**
  * Generates a base64-encoded signature for a Pipe webhook request.
  * @param string $webhook_key the webhook's authentication key
  * @param string $url the webhook url
  * @param array $jsonData the data in JSON format received via $_POST["payload"].
  */
  function generateSignature($webhook_key, $url,  $jsonData){

  $signed_data = $url;
  $signed_data .= $jsonData;

  return base64_encode(hash_hmac('sha1', $signed_data, $webhook_key, true));
  }
          

Handling webhook data on the server side

Handling webhook data is very simple, here's an example in PHP:

• application/x-www-form-urlencoded
• application/json

//we get the URL encoded payload data from the POST 
$payload = $_POST["payload"];

//the data is JSON encoded, so we must decode it in an associative array
$webhookData = json_decode($payload, true);

//you can get the webhook type by accessing the event element in the array
$type = $webhookData["event"];

//if you wish to get the name of the video you simply access it like this
$vidName = $webhookData["data"]["videoName"]

Array
(
    [version] => 1.0
    [event] => video_converted
    [data] => Array
        (
            [videoName] => vsrtc1501002174_491
            [duration] => 3.48
            [audioCodec] => AAC
            [videoCodec] => H.264
            [type] => MP4
            [size] => 442101
            [width] => 1280
            [height] => 720
            [orientation] => landscape
            [id] => 451464
            [dateTime] => 2017-07-25 20:03:05
            [timeZone] => Europe/Bucharest
            [payload] => {"userId":"55a95eeb936dd30100e0aff6","jobId":"55a7e6555f1bdc010014d6a1", "email":"asdasd@adasdae.com", "link":"https://www.amazon.com/D-G-P-4-W/dp/ref=as_li_ss_tl?ie=UTF8"}
        )

)

//we get the JSON data from the POST, that is being sent as is 
$body = file_get_contents("php://input");

//the data is JSON encoded, so we must decode it in an associative array
$webhookData = json_decode($body, true);

//you can get the webhook type by accessing the event element in the array
$type = $webhookData["event"];

//if you wish to get the name of the video you simply access it like this
$vidName = $webhookData["data"]["videoName"]

Array
(
    [version] => 1.0
    [event] => video_converted
    [data] => Array
        (
            [videoName] => vsrtc1501002174_491
            [duration] => 3.48
            [audioCodec] => AAC
            [videoCodec] => H.264
            [type] => MP4
            [size] => 442101
            [width] => 1280
            [height] => 720
            [orientation] => landscape
            [id] => 451464
            [dateTime] => 2017-07-25 20:03:05
            [timeZone] => Europe/Bucharest
            [payload] => {"userId":"55a95eeb936dd30100e0aff6","jobId":"55a7e6555f1bdc010014d6a1", "email":"asdasd@adasdae.com", "link":"https://www.amazon.com/D-G-P-4-W/dp/ref=as_li_ss_tl?ie=UTF8"}
        )

)

Attach custom data to recordings

You can attach custom data to each recorder. The custom data will then be attached to all the recordings made with that recorder and it will be passed back to you through webhooks. This is very useful when you wish to tunnel data - like a user id or a submission id - from your embed code all the way to your webhook receiving code. Custom data can be a simple string or a JSON object.

The custom data will also be shown in the recordings list in the Pipe account area. In the example below, the custom payload data was "user-id:30785".

Sending a simple string as custom data

• Embed Code v1.0
• Embed Code v2.0 via HTML
• Embed Code v2.0 via JavaScript

var flashvars = {qualityurl: "avq/240p.xml",accountHash:"your_account_hash",showMenu:"true", mrt:120};

var flashvars = {qualityurl: "avq/240p.xml",accountHash:"your_account_hash",showMenu:"true", mrt:120, payload:"your_payload_data_string"};

<piperecorder id="test-div" pipe-width="640" pipe-height="510" pipe-qualityurl="avq/480p.xml" pipe-accounthash="your_account_hash" pipe-eid="1" pipe-showmenu="1" pipe-mrt="120"></piperecorder>

<piperecorder id="test-div" pipe-width="640" pipe-height="510" pipe-qualityurl="avq/480p.xml" pipe-accounthash="your_account_hash" pipe-eid="1" pipe-showmenu="1" pipe-mrt="120" pipe-payload="your_payload_data_string" ></piperecorder>

var YOUR_CUSTOM_OBJECT_NAME = {qualityurl: "avq/240p.xml",accountHash:"your_account_hash",showMenu:1, mrt:120};

var YOUR_CUSTOM_OBJECT_NAME = {qualityurl: "avq/240p.xml",accountHash:"your_account_hash",showMenu:1, mrt:120, payload:"your_payload_data_string"};

Sending a JSON object as custom data

To send a JSON object as custom data you'll have to send it as a string through the payload property (or pipe-payload attribute if using the 2.0 HTML embed code).

You have two formating options in order to send the JSON correctly:

• enclose the JSON in quotes and write the JSON normally: payload:'{"a":"b"}'
• enclose the JSON in double quotes and escape the double quotes from inside the JSON payload:"{\"a\":\"b\"}"

Receiving the data

The custom data you've included in the embed code will be sent back to you with (all) the webhooks that fire for the events associated with the recordings made with that recorder. The data will be available as the value of the payload property of the data object:

payload={
	"version":"1.0",
	"event":"video_converted",
	"data":{
		"videoName":"recording name here",
		"duration":"7.56",
		"audioCodec":"AAC",
		"videoCodec":"H.264",
		"type":"MP4",
		"size":194373,
		"width":320,
		"height":240,
		"orientation":"landscape",
		"id":"123",
		"dateTime": "2015-10-10 16:00:36",
		"timeZone":"Europe/Bucharest",
		"payload":"your_payload_data_string"
	}
}

JavaScript Control API v1.0 (Desktop recorder)

The JavaScript Control API allows you to control Pipe's desktop recorder using JavaScript.

With it you can for example create your own UI by hiding the lower menu of the desktop Pipe recorder and control the recording process through the JS Control API using your own buttons.

Controlling the recorder through JavaScript when using the 1.0 embed code

The 1.0 version of the embed code supports only 1 recorder on the page represented by the VideoRecorder object. You can tell it to start recording by calling the record() method on the VideoRecorder object like this:

<input type="button" class="btn" value="Record" id="recordbtn" />
<script>
//wait for onRecorderReady before attaching the click event to the button above
function onRecorderReady(recorderId,recorderType){
 document.getElementById("recordbtn").onclick = function (){
    document.VideoRecorder.record();
 }
}
</script>

Full list of control methods you can use when using the 1.0 embed code

Here is the full list of methods that you can call on the Pipe recorder and that make up the JS Control API:

Removing the Pipe Recorder from page (Embed Code 1.0)

When the Pipe HTML5 recorder is used and it's part of a modal window that the user closes (either through CSS' display: none or by removing the modal DIV from the DOM) the webcam will continue to be acessed and it's light will continue to be turned on.

For this scenario we've built the following JS function that closes the media server connection, turns off the webcam access and clears the contents of the #hdfvr-content DIV returning the HTML source code to its initial state:removePipeRecorder();.

Execute it before closing the modal window.

JavaScript Control API v2.0 (Desktop recorder)

The JavaScript Control API allows you to control Pipe's desktop recorder using JavaScript.

With it you can for example create your own UI by hiding the lower menu of the desktop Pipe recorder and control the recording process through the JS Control API using your own buttons.

• Embed Code v2.0 via HTML
• Embed Code v2.0 via Javascript

<input type="button" class="btn" value="Record" id="recordbtn" />
<script>
PipeSDK.onRecordersInserted = function(){	
    myRecorder =  PipeSDK.getRecorderById('UNIQUE_ID_OF_THE_PIPERECORDER_TAG');
    myRecorder.onReadyToRecord = function(id, type){
    	document.getElementById("recordbtn").onclick = function (){
    		myRecorder.record();
    	}
    }
}
</script>

<input type="button" class="btn" value="Record" id="recordbtn" />
<script>
PipeSDK.insert('UNIQUE_ID_OF_THE_REPLACED_DIV', paramsObject, function(myRecorderObject){
    myRecorderObject.onReadyToRecord = function(id, type){
        document.getElementById("recordbtn").onclick = function (){
            myRecorderObject.record();
        }
    }
}
</script>

JavaScript Events API v1.0 (Desktop recorder)

Every time something happens with the desktop recorder (a button is pressed, the connection succeeds, etc.), the recorder will execute a specific JavaScript function with information about the event.

You can add these event functions to your HTML/JS app and extend them with your own code to do your bidding.

Here are some of the things you can do by extending these event functions:

• show a message, a warning or a timer in the HTML page
• activate an input field or button in the HTML page
• redirect the user to another page

When using the v1 embed code you can just add these JS event functions to your HTML page. The Pipe recorder client will detect their presence and execute them when needed.

Try adding the code below immediately after your v1 Pipe recorder embed code:

<script>
function onRecorderInit(recorderId){
    var args = Array.prototype.slice.call(arguments);
    alert("onRecorderInit("+args.join(', ')+")");
}
</script>

An alert will pop up in your web page whenever the Pipe recording client finishes initializing. You can replace onRecorderInit(recorderId) with any of the event functions below.

The desktop recorder has 2 different set of events and corresponding event functions:

• Event functions executed when recording a new video using the desktop recorder with embed code 1.0
• Event functions executed when uploading an existing file using the desktop recorder with embed code 1.0

Event functions executed when recording a new video using the desktop recorder with embed code 1.0

This is the list of JavaScript event functions the Pipe client will execute when the user is recording from a desktop device using his webcam or microphone.

function onRecorderInit(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onRecorderInit("+args.join(', ')+")");
}

<script>
function onRecorderReady(recorderId, recorderType){
    var args = Array.prototype.slice.call(arguments);
    alert("onRecorderReady("+args.join(', ')+")");
}
</script>

<input type="button" class="btn" value="Record" id="recordbtn" />
<script>
//wait for onRecorderReady before adding the onclick event to the button above
function onRecorderReady(recorderId,recorderType){
 console.log("onRecorderReady executed")
 //when the button is clicked
 document.getElementById("recordbtn").onclick = function (){
      //trigger the recording process
      document.VideoRecorder.record();
 }
}
</script>

function userHasCamMic(cam_number,mic_number, recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("userHasCamMic("+args.join(', ')+")");
}

function btRecordPressed(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("btRecordPressed("+args.join(', ')+")");
}

function btStopRecordingPressed(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("btStopRecordingPressed("+args.join(', ')+")");
}

function btPlayPressed(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("btPlayPressed("+args.join(', ')+")");
}

function btPausePressed(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("btPausePressed("+args.join(', ')+")");
}

function onUploadDone(streamName, streamDuration, userId, recorderId, audioCodec, videoCodec, fileType, audioOnly,location){
	var args = Array.prototype.slice.call(arguments);
	alert("onUploadDone("+args.join(', ')+")");
}

function onUploadProgress(percent){
	var args = Array.prototype.slice.call(arguments);
	alert("onUploadProgress("+args.join(', ')+")");
}

onCamAccess(allowed, recorderId);

Description:

onCamAccess is triggered:

1. when clicking the Allow or Deny radio buttons in Flash Player's camera/microphone Privacy panel. The Privacy panel will be brought up by the Pipe recorder but it can also be manually brought up by the user by right clicking on the Pipe client - your code should cope with onCamAccess being called at any time during Pipe client's lifetime. The function is triggered even if the user clicks the selected/active radio button.
2. automatically if the [ ] Remember checkbox was previously selected in Flash Player's Privacy panel

Flash Player's Privacy Panel when presented by the Pipe recorder client:

Internet browsers like Chrome will ask again for permission to use the webcam through a separate dialog box:

Chrome pausing Flash animations to save battery life

Chrome will intelligently pause Flash content to save battery life.

This applies to smaller Pipe embeds too.

When Pipe is paused by Chrome, onCamAccess will be called, while the Pipe recorder is apparently paused, if all these 3 conditions are met:

1. skip initial screen is on (sis:1 in the embed code)
2. the user has only 1 webcam and 1 microphone
3. you have previously checked [ ] Remember in FP's Privacy panel

In this scenario onCamAccess will be called, followed by onFlashReady, while the Pipe recorder is apparently paused.

Here's how Pipe looks when it's paused by Chrome:

Use 400x300px size or bigger for Pipe embeds to prevent it from being paused by Chrome.

Passed Parameters:
allowed is true if:

• the user clicked the [Allow] button OR
• clicked [Allow] + [Remember] in a previous session (in which case Flash Player's Privacy dialog box is not shown)

and false if

• the user clicked the [Deny] button OR
• if a user clicked [Deny] + [Remember] in a previous session (in which case Flash Player's Privacy dialog box is not shown)

recorderId - value of recorderId property of flashvars object in the embed code

Example:

function onCamAccess(allowed, recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onCamAccess("+args.join(', ')+")");
}

function onPlaybackComplete(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onPlaybackComplete("+args.join(', ')+")");
}

function onRecordingStarted(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onRecordingStarted("+args.join(', ')+")");
}

function onConnectionClosed(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onConnectionClosed("+args.join(', ')+")");
}

function onFPSChange(recorderId,currentFPS){
	var args = Array.prototype.slice.call(arguments);
	alert("onFPSChange("+args.join(', ')+")");
}

function onConnectionStatus(status, recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onConnectionStatus("+args.join(', ')+")");
}

function onMicActivityLevel(recorderId, currentActivityLevel){
	var args = Array.prototype.slice.call(arguments);
	alert("onMicActivityLevel("+args.join(', ')+")");
}

function onSaveOk(streamName, streamDuration, userId, cameraName, micName, recorderId, audioCodec, videoCodec, fileType, videoId, audioOnly,location){
	var args = Array.prototype.slice.call(arguments);
	alert("onSaveOk("+args.join(', ')+")");
}

function onFlashReady(recorderId){
	var args = Array.prototype.slice.call(arguments);
	alert("onFlashReady("+args.join(', ')+")");
}

Event functions executed when uploading an existing file using the desktop recorder with embed code 1.0

Below is the list of JavaScript functions the Pipe client will execute when the user is UPLOADING an existing video using the desktop recorder. You can turn on the feature from your embed code or from the Pipe account area when generating an embed code, details here.

function onDesktopVideoSelected(filename,filetype, audioOnly){
	var args = Array.prototype.slice.call(arguments);
	alert("onDesktopVideoSelected("+args.join(', ')+")");
}

function onDesktopVideoSubmitted(){
	var args = Array.prototype.slice.call(arguments);
	alert("onDesktopVideoSubmitted("+args.join(', ')+")");
}

function onDesktopVideoUploadSuccess(filename,filetype,videoId,audioOnly,location){
	var args = Array.prototype.slice.call(arguments);
	alert("onDesktopVideoUploadSuccess("+args.join(', ')+")");
}

function onDesktopVideoUploadProgress(percent){
	var args = Array.prototype.slice.call(arguments);
	alert("onDesktopVideoUploadProgress("+args.join(', ')+")");
}

function onDesktopVideoUploadFailed(error){
	var args = Array.prototype.slice.call(arguments);
	alert("onDesktopVideoUploadFailed("+args.join(', ')+")");
}

JavaScript Events API v2.0 (Desktop recorder)

Every time something happens with the desktop recorder (a button is pressed, the connection succeeds, etc.), the recorder will execute a specific JavaScript function with information about the event.

You can add these event functions to your HTML/JS app and extend them with your own code to do your bidding.

Here are some of the things you can do by extending these event functions:

• show a message, a warning or a timer in the HTML page
• activate an input field or button in the HTML page
• redirect the user to another page

Since the v2 embed code supports multiple recorders on the same page, to override a recoder's event functions, we need to get the desired recorder object 1st. Here's how to do it:

Getting the recorder object

This is done differently depending on what version of the embed code you are using.

var myRecorderObject = PipeSDK.getRecorderById('UNIQUE_ID_OF_THE_RECORDER');

<script>
PipeSDK.onRecordersInserted = function(){
    myRecorderObject =  PipeSDK.getRecorderById('UNIQUE_ID_OF_THE_RECORDER');  
    myRecorderObject.btRecordPressed = function(id){
        var args = Array.prototype.slice.call(arguments);
        console.log("btRecordPressed("+args.join(', ')+")");
    }
}
</script>

PipeSDK.insert('UNIQUE_ID_OF_THE_RECORDER', paramsObject, function(myRecorderObject){
    myRecorderObject.btRecordPressed = function(id){
        var args = Array.prototype.slice.call(arguments);
        console.log("btRecordPressed("+args.join(', ')+")");
    }
});

The desktop recorder has 2 different set of events and corresponding event functions:

• Event functions executed when recording a new video using the desktop recorder with embed code 2.0
• Event functions executed when uploading an existing file using the desktop recorder with embed code 2.0

Event functions executed when recording a new video using the desktop recorder with embed code 2.0

Below is the list of JavaScript event functions that the Pipe client will trigger when the user is recording a video from a desktop device.

myRecorderObject.onReadyToRecord = function(recorderId, recorderType) {
    var args = Array.prototype.slice.call(arguments);
    console.log("onReadyToRecord("+args.join(', ')+")");
});

myRecorderObject.userHasCamMic = function(recorderId,cam_number,mic_number){
	var args = Array.prototype.slice.call(arguments);
	console.log("userHasCamMic("+args.join(', ')+")");
}

myRecorderObject.btRecordPressed = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("btRecordPressed("+args.join(', ')+")");
}

myRecorderObject.btStopRecordingPressed = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("btStopRecordingPressed("+args.join(', ')+")");
}

myRecorderObject.btPlayPressed = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("btPlayPressed("+args.join(', ')+")");
}

myRecorderObject.btPausePressed = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("btPausePressed("+args.join(', ')+")");
}

myRecorderObject.onUploadDone = function(recorderId, streamName, streamDuration, audioCodec, videoCodec, fileType, audioOnly, location){
	var args = Array.prototype.slice.call(arguments);
	console.log("onUploadDone("+args.join(', ')+")");
}

myRecorderObject.onUploadProgress = function(recorderId, percent){
	var args = Array.prototype.slice.call(arguments);
	console.log("onUploadProgress("+args.join(', ')+")");
}

onCamAccess(recorderId, allowed)

Description:

onCamAccess is triggered:

1. when clicking the Allow or Deny radio buttons in Flash Player's camera/microphone Privacy panel. The Privacy panel will be brought up by the Pipe recorder but it can also be manually brought up by the user by right clicking on the Pipe client - your code should cope with onCamAccess being called at any time during Pipe client's lifetime. The function is triggered even if the user clicks the selected/active radio button.
2. automatically if the [ ] Remember checkbox was previously selected in Flash Player's Privacy panel

Flash Player's Privacy Panel when presented by the Pipe recorder client:

Internet browsers like Chrome will ask again for permission to use the webcam through a separate dialog box:

At the moment there is no way to catch the user's response to Chrome's dialog box.

Passed Parameters:
recorderId - the recorder id
allowed is true if:

• the user clicked the [Allow] button OR
• clicked [Allow] + [Remember] in a previous session (in which case Flash Player's Privacy dialog box is not shown)

and false if

• the user clicked the [Deny] button OR
• if a user clicked [Deny] + [Remember] in a previous session (in which case Flash Player's Privacy dialog box is not shown)

Example:

myRecorderObject.onCamAccess = function(recorderId, allowed){
	var args = Array.prototype.slice.call(arguments);
	console.log("onCamAccess("+args.join(', ')+")");
}

myRecorderObject.onPlaybackComplete = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("onPlaybackComplete("+args.join(', ')+")");
}

myRecorderObject.onRecordingStarted = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("onRecordingStarted("+args.join(', ')+")");
}

myRecorderObject.onConnectionClosed = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("onConnectionClosed("+args.join(', ')+")");
}

myRecorderObject.onFPSChange = function(recorderId,currentFPS){
	var args = Array.prototype.slice.call(arguments);
	console.log("onFPSChange("+args.join(', ')+")");
}

myRecorderObject.onConnectionStatus = function(recorderId, status){
	var args = Array.prototype.slice.call(arguments);
	console.log("onConnectionStatus("+args.join(', ')+")");
}

myRecorderObject.onMicActivityLevel = function(recorderId, currentActivityLevel){
	var args = Array.prototype.slice.call(arguments);
	console.log("onMicActivityLevel("+args.join(', ')+")");
}

myRecorderObject.onSaveOk = function(recorderId, streamName, streamDuration, cameraName, micName, audioCodec, videoCodec, fileType, videoId, audioOnly, location){
	var args = Array.prototype.slice.call(arguments);
	console.log("onSaveOk("+args.join(', ')+")");
}

myRecorderObject.onFlashReady = function(recorderId){
	var args = Array.prototype.slice.call(arguments);
	console.log("onFlashReady("+args.join(', ')+")");
}

Event functions executed when uploading an existing file using the desktop recorder with embed code 2.0

Below is the list of JavaScript events that the Pipe client will dispatch when the user is UPLOADING an existing video using the desktop recorder. You can turn on the feature from your embed code or from the Pipe account area when generating an embed code, details here.

myRecorderObject.onDesktopVideoUploadStarted = function(recorderId, filename,filetype, audioOnly){
	var args = Array.prototype.slice.call(arguments);
	console.log("onDesktopVideoUploadStarted("+args.join(', ')+")");
}

myRecorderObject.onDesktopVideoUploadSuccess = function(recorderId, filename,filetype,videoId,audioOnly,location){
	var args = Array.prototype.slice.call(arguments);
	console.log("onDesktopVideoUploadSuccess("+args.join(', ')+")");
}

myRecorderObject.onDesktopVideoUploadProgress = function(recorderId, percent){
	var args = Array.prototype.slice.call(arguments);
	console.log("onDesktopVideoUploadProgress("+args.join(', ')+")");
}

myRecorderObject.onDesktopVideoUploadFailed = function(recorderId, error){
	var args = Array.prototype.slice.call(arguments);
	console.log("onDesktopVideoUploadFailed("+args.join(', ')+")");
}

JavaScript Events API v1.0 (Mobile native recorder)

Every time something happens with the mobile native recorder (a video is starting to upload, an upload has finished, etc.) the recorder will execute a specific JavaScript function with information about the event.

You can add these mobile native recorder event functions to your HTML/JS app and extend them with your own code to do your bidding.

When using the v1.0 embed code you can just add these JS event functions to your HTML page. The Pipe mobile native recorder will detect their presence and execute them when needed.

Try adding the code below immediately after your v1 Pipe recorder embed code:

<script>
function onVideoRecorded(filename,filetype, audioOnly){
    var args = Array.prototype.slice.call(arguments);
    alert("onVideoRecorded("+args.join(', ')+")");
}
</script>

An alert will pop up in your web page whenever you close the iOS/Android controlled recording UI.

You can replace onVideoRecorded(filename,filetype, audioOnly) in the example above with any of the mobile event functions below.

function onVideoRecorded(filename,filetype, audioOnly){
	var args = Array.prototype.slice.call(arguments);
	alert("onVideoRecorded("+args.join(', ')+")");
}

function onClickUpload(){
	var args = Array.prototype.slice.call(arguments);
	alert("onClickUpload("+args.join(', ')+")");
}

function onVideoUploadSuccess(filename,filetype,videoId,audioOnly,location){
	var args = Array.prototype.slice.call(arguments);
	alert("onVideoUploadSuccess("+args.join(', ')+")");
}

function onVideoUploadProgress(percent){
	var args = Array.prototype.slice.call(arguments);
	alert("onVideoUploadProgress("+args.join(', ')+")");
}

function onVideoUploadFailed(error){
	var args = Array.prototype.slice.call(arguments);
	alert("onVideoUploadFailed("+args.join(', ')+")");
}

JavaScript Events API v2.0 (Mobile native recorder)

Every time something happens with the mobile native recorder (a video is starting to upload, an upload has finished, etc.) the recorder will execute a specific JavaScript function with information about the event.

You can add these mobile native recorder event functions to your HTML/JS app and extend them with your own code to do your bidding.

Since the v2.0 embed code supports multiple recorders on the same page, to override a recorder's event functions, we need to get the desired recorder object 1st.

Getting the recorder object

This is done differently depending on what version of the embed code you are using.

var myRecorderObject = PipeSDK.getRecorderById('UNIQUE_ID_OF_THE_RECORDER');

<script>
PipeSDK.onRecordersInserted = function(){
    myRecorderObject =  PipeSDK.getRecorderById('UNIQUE_ID_OF_THE_RECORDER');  
    myRecorderObject.onVideoUploadStarted = function(id, filename, filetype, audioOnly){
        var args = Array.prototype.slice.call(arguments);
        console.log("onVideoUploadStarted("+args.join(', ')+")");
    }
}
</script>

PipeSDK.insert('UNIQUE_ID_OF_THE_RECORDER', paramsObject, function(myRecorderObject){
    myRecorderObject.onVideoUploadStarted = function(id, filename, filetype, audioOnly){
        var args = Array.prototype.slice.call(arguments);
        console.log("onVideoUploadStarted("+args.join(', ')+")");
    }
});

You can replace onVideoUploadStarted(id, filename, filetype, audioOnly) in the example above with any of the 2.0 mobile event functions below.

myRecorderObject.onVideoUploadStarted = function(recorderId, filename,filetype, audioOnly){
	var args = Array.prototype.slice.call(arguments);
	console.log("onVideoUploadStarted("+args.join(', ')+")");
}

myRecorderObject.onVideoUploadSuccess = function(recorderId, filename,filetype,videoId,audioOnly,location){
	var args = Array.prototype.slice.call(arguments);
	console.log("onVideoUploadSuccess("+args.join(', ')+")");
}

myRecorderObject.onVideoUploadProgress = function(recorderId, percent){
	var args = Array.prototype.slice.call(arguments);
	console.log("onVideoUploadProgress("+args.join(', ')+")");
}

myRecorderObject.onVideoUploadFailed = function(recorderId, error){
	var args = Array.prototype.slice.call(arguments);
	console.log("onVideoUploadFailed("+args.join(', ')+")");
}

REST API

The REST API allows you to request information from our servers programmatically and in a standardized manner, using JSON.

All requests are made against https://api.addpipe.com and are authenticated by sending the API key as the value of the X-PIPE-AUTH header.

API Key

The API Key can be found in your Pipe account details page and it should be kept in a safe place, like any other password. If compromised, the API key can be replaced with a new one.

API endpoints

{
  "status": "OK",
  "message": "Request successful",
  "request_method": "GET",
  "total_videos": 35,
  "videos": [
    {
      "id":"60372",
      "name":"vs1458574806017_16",
      "original_container": "webm",
      "length":"5.00",
      "datetime":"2016-03-21 17:39:22",
      "ipv4": "1565594519",
      "orig_width": null,
      "orig_height": null,
      "mrt": null,
      "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0",
      "http_referer":"https://addpipe.com",
      "converted":"1",
      "size":"417346",
      "original_container":"flv",
      "width":"320",
      "height":"240",
      "hasAudio":"1",
      "source":"DESK",
      "ftped":"0",
      "s3ed":"1",
      "sftped":"1",
      "dboxed":"1",
      "ytubed":"0",
      "rotation":"0",
      "payload":"",
      "camera_name":"Logitech HD Pro Webcam C920",
      "microphone_name":"Microphone (HD Pro Webcam C920)",
      "not_stored":"0",
      "retry_interval": "-1",
      "has_original": "0",
      "has_mp4": "1",
      "has_snapshot": "1",
      "has_filmstrip": "0",
      "anonymized": "0",
      "env_id": "1",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "date_anonymized": null,
      "region": "us1",
      "datetimeAdjusted":"2016-03-21 17:39:22",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458574806017_16.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458574806017_16.jpg"
    },
    {
      "id":"60373",
      "name":"vs1458574990422_278",
      "original_container": "webm",
      "length":"6.00",
      "datetime":"2016-03-21 17:42:26",
      "last_retry_time": "2016-03-21 18:45:54",
      "ipv4": "1565594519",
      "orig_width": null,
      "orig_height": null,
      "mrt": null,
      "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0",
      "http_referer":"https://addpipe.com",
      "converted":"1",
      "size":"282309",
      "original_container":"flv",
      "width":"320",
      "height":"240",
      "hasAudio":"1",
      "source":"DESK",
      "ftped":"0",
      "s3ed":"1",
      "sftped":"1",
      "dboxed":"1",
      "ytubed":"0",
      "rotation":"0",
      "payload":"",
      "camera_name":"Logitech HD Pro Webcam C920",
      "microphone_name":"Microphone (HD Pro Webcam C920)",
      "not_stored":"0",
      "retry_interval": "-1",
      "has_original": "0",
      "has_mp4": "1",
      "has_snapshot": "1",
      "has_filmstrip": "0",
      "anonymized": "0",
      "env_id": "1",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "date_anonymized": null,
      "region": "us1",
      "datetimeAdjusted":"2016-03-21 17:42:26",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458574990422_278.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458574990422_278.jpg"
    },
    {
      "id":"60382",
      "name":"vs1458578379324_24",
      "original_container": "webm",
      "length":"16.00",
      "datetime":"2016-03-21 18:39:05",
      "last_retry_time": "2016-03-21 18:45:54",
      "ipv4": "1565594519",
      "orig_width": null,
      "orig_height": null,
      "mrt": null,
      "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0",
      "http_referer":"https://addpipe.com",
      "converted":"1",
      "size":"958462",
      "original_container":"flv",
      "width":"320",
      "height":"240",
      "hasAudio":"1",
      "source":"DESK",
      "ftped":"0",
      "s3ed":"1",
      "sftped":"1",
      "dboxed":"1",
      "ytubed":"0",
      "rotation":"0",
      "payload":"",
      "camera_name":"Logitech HD Pro Webcam C920",
      "microphone_name":"Microphone (HD Pro Webcam C920)",
      "not_stored":"0",
      "retry_interval": "-1",
      "has_original": "0",
      "has_mp4": "1",
      "has_snapshot": "1",
      "has_filmstrip": "0",
      "anonymized": "0",
      "env_id": "1",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "date_anonymized": null,
      "region": "us1",
      "datetimeAdjusted":"2016-03-21 18:39:05",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578379324_24.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578379324_24.jpg"
    },
    {
      "id":"60384",
      "name":"vs1458578462703_775",
      "original_container": "webm",
      "length":"7.00",
      "datetime":"2016-03-21 18:40:20",
      "last_retry_time": "2016-03-21 18:45:54",
      "ipv4": "1565594519",
      "orig_width": null,
      "orig_height": null,
      "mrt": null,
      "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0",
      "http_referer":"https://addpipe.com",
      "converted":"1",
      "size":"600022",
      "original_container":"flv",
      "width":"320",
      "height":"240",
      "hasAudio":"1",
      "source":"DESK",
      "ftped":"0",
      "s3ed":"1",
      "sftped":"1",
      "dboxed":"1",
      "ytubed":"0",
      "rotation":"0",
      "payload":"",
      "camera_name":"Logitech HD Pro Webcam C920",
      "microphone_name":"Microphone (HD Pro Webcam C920)",
      "not_stored":"0",
      "retry_interval": "-1",
      "has_original": "0",
      "has_mp4": "1",
      "has_snapshot": "1",
      "has_filmstrip": "0",
      "anonymized": "0",
      "env_id": "1",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "date_anonymized": null,
      "region": "us1",
      "datetimeAdjusted":"2016-03-21 18:40:20",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578462703_775.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578462703_775.jpg"
    },
    {
      "id":"60385",
      "name":"vs1458578985192_39",
      "original_container": "webm",
      "length":"7.00",
      "datetime":"2016-03-21 18:49:02",
      "last_retry_time": "2016-03-21 18:45:54",
      "ipv4": "1565594519",
      "orig_width": null,
      "orig_height": null,
      "mrt": null,
      "ua":"Mozilla/5.0 (Windows NT 6.1; WOW64; rv:45.0) Gecko/20100101 Firefox/45.0",
      "http_referer":"https://addpipe.com",
      "converted":"1",
      "size":"579632",
      "original_container":"flv",
      "width":"320",
      "height":"240",
      "hasAudio":"1",
      "source":"DESK",
      "ftped":"0",
      "s3ed":"1",
      "sftped":"0",
      "dboxed":"1",
      "ytubed":"0",
      "rotation":"0",
      "payload":"",
      "camera_name":"Logitech HD Pro Webcam C920",
      "microphone_name":"Microphone (HD Pro Webcam C920)",
      "not_stored":"0",
      "retry_interval": "-1",
      "has_original": "0",
      "has_mp4": "1",
      "has_snapshot": "1",
      "has_filmstrip": "0",
      "anonymized": "0",
      "env_id": "1",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "date_anonymized": null,
      "region": "us1",
      "datetimeAdjusted":"2016-03-21 18:49:02",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578985192_39.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578985192_39.jpg"
    },
    {
      "id":"61071",
      "name":"mvs556696771",
      "original_container": "webm",
      "length":"9.00",
      "datetime":"2016-03-23 15:48:57",
      "last_retry_time": "2016-03-21 18:45:54",
      "ipv4": "1565594519",
      "orig_width": null,
      "orig_height": null,
      "mrt": null,
      "ua":"Mozilla/5.0 (iPhone; CPU iPhone OS 9_3 like Mac OS X) AppleWebKit/601.1.46 (KHTML, like Gecko) Version/9.0 Mobile/13E234 Safari/601.1",
      "http_referer":"https://addpipe.com",
      "converted":"1",
      "size":"2348347",
      "original_container":".mov",
      "width":"480",
      "height":"480",
      "hasAudio":"1",
      "source":"MOB",
      "ftped":"0",
      "s3ed":"1",
      "sftped":"1",
      "dboxed":"1",
      "ytubed":"0",
      "rotation":"0",
      "payload":"",
      "camera_name":"mobile_device",
      "microphone_name":"mobile_device",
      "not_stored":"0",
      "retry_interval": "-1",
      "has_original": "0",
      "has_mp4": "1",
      "has_snapshot": "1",
      "has_filmstrip": "0",
      "anonymized": "0",
      "env_id": "1",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "date_anonymized": null,
      "region": "us1",
      "datetimeAdjusted":"2016-03-23 15:48:57",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/mvs556696771.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/mvs556696771.jpg"
    }
  ]
}
                                            

{
  "status": "OK",
  "status_code": 200,
  "message": "Request successful",
  "request_method": "GET",
  "total_videos": 1,
  "videos": [
    {
      "id": "13360",
      "env_id": "1",
      "length": "3.00",
      "size": "145695",
      "width": "640",
      "height": "480",
      "hasAudio": "1",
      "ytubed": "0",
      "rotation": "0",
      "not_stored": "0",
      "retry_interval": "-1",
      "has_original": "1",
      "has_mp4": "0",
      "has_snapshot": "1",
      "has_filmstrip": "1",
      "anonymized": "0",
      "datetime": "2020-08-18 17:51:58",
      "last_retry_time": "2020-08-18 17:52:05",
      "orig_width": "176",
      "orig_height": "176",
      "mrt": "120",
      "audio_only": "0",
      "recovered": "0",
      "transcoded": "1",
      "date_anonymized": null,
      "name": "vs1458578985192_39",
      "original_container": "flv",
      "source": "DESK",
      "payload": "bc5cq87vt3yv4t94t325af97c9e836e7bd2,1",
      "region": "us1",
      "ipv4": "1565594519",
      "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/45.0.2454.93 Safari/537.36",
      "http_referer": "https://site.com/test/test2.php",
      "camera_name": "Built-in iSight (05ac:8502)",
      "microphone_name": "Default",
      "checksum_md5": "311dbcd10a590c79cce3d3ccb8733560",
      "checksum_sha1": "b8fb07eb4b18e891800535278f8493ce045d4f3c",
      "converted": "1",
      "datetimeAdjusted":"2016-03-23 16:23:19",
      "timezone":"Europe/Bucharest",
      "pipeS3Link":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578985192_39.mp4",
      "snapshotURL":"eu1-addpipe.s3.eu-central-1.amazonaws.com/2123b9efed932689c4081a749a877413/vs1458578985192_39.jpg",
      "ftped": "0",
      "s3ed": "0",
      "sftped": "0",
      "dboxed": "0"
    }
  ]
}
                                            

{
  "status": "OK",
  "status_code": 200,
  "message": "Request successful",
  "request_method": "GET",
  "account_details": [
    {
      "api_requests": "13",
      "name": "Gloria Foster",
      "email": "myAwesome@Email.com"
    }
  ]
}
                                            

{
  "status": "OK",
  "status_code": 200,
  "message": "Request successful",
  "request_method": "GET",
  "environment_details": [
    {
      "id": "5167",
      "env_id": "1",
      "env_code": "1deF5t",
      "env_name": "Inline HTML5 recorder demos",
      "do_not_store": "0",
      "send_video_email": "1",
      "region": "auto-us"
    },
    {
      "id": "14444",
      "env_id": "3",
      "env_code": "ytvcfr",
      "env_name": "EU (HTML5 only)",
      "do_not_store": "0",
      "send_video_email": "1",
      "region": "eu1"
    },
    {
      "id": "14678",
      "env_id": "4",
      "env_code": "65d14v",
      "env_name": "EU (HTML5 +Flash)",
      "do_not_store": "0",
      "send_video_email": "1",
      "region": "eu1"
    },
    {
      "id": "18662",
      "env_id": "6",
      "env_code": "34dcxx",
      "env_name": "US regions",
      "do_not_store": "0",
      "send_video_email": "1",
      "region": "auto-us"
    }
  ]
}
                                            

{
  "status":"OK",
  "status_code":200,
  "message":"Request successful",
  "request_method":"GET",
  "environment_details":[
    {
      "id":"1537",
      "env_id":"7",
      "env_code": "j2HCiP",
      "env_name":"test-rtc",
      "do_not_store":"1",
      "send_video_email":"0",
      "region": "auto-us"
    }
  ]
}
                                            

{
    "status": "OK",
    "status_code": 200,
    "message": "Request successful",
    "request_method": "GET",
    "webhook_details": [
        {
            "id": "3157",
            "webhook": "https://webhook.site/b7495225-4ad8-495e-8140-d74fda5be972",
            "webhook_recorded": "1",
            "webhook_transcoded": "0",
            "webhook_converted": "1",
            "webhook_copied_pipe_s3": "1",
            "webhook_copied_s3": "0",
            "webhook_copied_ftp": "0",
            "webhook_copied_dbox": "0",
            "env_id": "1",
            "active": "1"
        },
        {
            "id": "3487",
            "webhook": "https://hooks.zapier.com/hooks/catch/123456/oz1amxx/",
            "webhook_recorded": "0",
            "webhook_transcoded": "0",
            "webhook_converted": "0",
            "webhook_copied_pipe_s3": "1",
            "webhook_copied_s3": "0",
            "webhook_copied_ftp": "0",
            "webhook_copied_dbox": "0",
            "env_id": "4",
            "active": "1"
        }
    ]
}
                                            

{	
  "webhook": "http://your-fancy-website.com/webhook",
  "webhook_recorded": "0",
  "webhook_transcoded": "1",
  "webhook_converted": "1",
  "webhook_copied_pipe_s3":"0",
  "webhook_copied_s3": "0",
  "webhook_copied_ftp": "0",
  "webhook_copied_dbox": "0",
  "active":"1"
}                           

{
  "status": "OK",
  "status_code": 200,
  "message": "Request successful",
  "request_method": "GET",
  "amazon_details": [
    {
      "id":"69",	    
      "amz_bucket": "my-pipe-recordings",
      "amz_bucket_region": "us-east-1",
      "amz_acl": "public-read",
      "env_id":"1"
    }
  ]
}
                                            

{
  "amz_key": "YourAmazonKey",
  "amz_secret": "YourAmazonSecret",
  "amz_bucket": "TheBucket",
  "amz_bucket_region": "us-east-1"
}                       

{
  "status": "OK",
  "status_code": 200,
  "message": "Request successful",
  "request_method": "GET",
  "ftp_details": [
    {
      "id":"69",    
      "ftp_host": "",
      "ftp_port": "21",
      "ftp_username": "",
      "ftp_dir": "",
      "sftp_host": "",
      "sftp_port": "22",
      "sftp_username": "",
      "sftp_dir": "",
      "env_id":"1"
    }
  ]
}
                                            

{
  "ftp_host": "FtpHost",
  "ftp_port": "21",
  "ftp_username": "FtpUsername",
  "ftp_password": "FtpPass",
  "ftp_dir": "/dir/to/saved_videos",
  "sftp_host": "SftpHost",
  "sftp_port": "22",
  "sftp_username": "SftpUser",
  "sftp_password": "SftpPass"
  "sftp_dir": "/dir/to/saved_videos"
}                       

{
  "status": "OK",
  "status_code": 200,
  "message": "Request successful",
  "request_method": "GET",
  "dropbox_details": [
    {
      "id": "5163",
      "dbox_folder": "",
      "env_id": "1"
    },
    {
      "id": "5976",
      "dbox_folder": "",
      "env_id": "2"
    }
  ]
}
                                            

{
  "dbox_token": "YourDropboxAccessToken",
  "dbox_folder": "YourDropboxFolder"
}                       

Code Examples

• PHP
• JavaScript
• GO
• Python
• Ruby
• Bash (Wget)
• Bash (cURL)

$headers = array(
    'x-pipe-auth: YOUR-PIPE-API-KEY'
);

// init curl object        
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.addpipe.com/video/YOUR-RECORDING-ID');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET"); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Timeout in seconds
curl_setopt($ch, CURLOPT_TIMEOUT, 30);

$content = curl_exec($ch);

echo $content;

$headers = array(
    'x-pipe-auth: YOUR-PIPE-API-KEY'
);

// init curl object        
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.addpipe.com/video/YOUR-RECORDING-ID');
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE"); 
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Timeout in seconds
curl_setopt($ch, CURLOPT_TIMEOUT, 30);

$content = curl_exec($ch);

echo $content;

var data = JSON.stringify({
  "amz_key": "",
  "amz_secret": "",
  "amz_bucket": "",
  "amz_bucket_region": ""
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.addpipe.com/amazon");
xhr.setRequestHeader("x-pipe-auth", "Your-Pipe-Api-Key");
xhr.setRequestHeader("content-type", "application/json");
xhr.setRequestHeader("cache-control", "no-cache");

xhr.send(data);

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://api.addpipe.com/amazon"

	payload := strings.NewReader("{\n  \"amz_key\": \"\",\n  \"amz_secret\": \"\",\n  \"amz_bucket\": \"\",\n  \"amz_bucket_region\": \"\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-pipe-auth", "Your-Pipe-Api-Key")
	req.Header.Add("content-type", "application/json")
	req.Header.Add("cache-control", "no-cache")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

import http.client

conn = http.client.HTTPConnection("api.addpipe.com")

payload = "{\n  \"amz_key\": \"\",\n  \"amz_secret\": \"\",\n  \"amz_bucket\": \"\",\n  \"amz_bucket_region\": \"\"\n}"

headers = {
    'x-pipe-auth': "Your-Pipe-Api-Key",
    'content-type': "application/json",
    'cache-control': "no-cache"
    }

conn.request("PUT", "/account", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

require 'uri'
require 'net/http'

url = URI("https://api.addpipe.com/amazon")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Put.new(url)
request["x-pipe-auth"] = 'Your-Pipe-Api-Key'
request["content-type"] = 'application/json'
request["cache-control"] = 'no-cache'
request.body = "{\n  \"amz_key\": \"\",\n  \"amz_secret\": \"\",\n  \"amz_bucket\": \"\",\n  \"amz_bucket_region\": \"\"\n}"

response = http.request(request)
puts response.read_body

wget --quiet \
  --method PUT \
  --header 'x-pipe-auth: Your-Pipe-Api-Key' \
  --header 'content-type: application/json' \
  --header 'cache-control: no-cache' \
  --body-data '{\n  "amz_key": "",\n  "amz_secret": "",\n  "amz_bucket": "",\n  "amz_bucket_region": ""\n}' \
  --output-document \
  - https://api.addpipe.com/amazon

curl --request PUT \
  --url https://api.addpipe.com/amazon \
  --header 'cache-control: no-cache' \
  --header 'content-type: application/json' \
  --header 'x-pipe-auth: Your-Pipe-Api-Key' \
  --data '{\n  "amz_key": "",\n  "amz_secret": "",\n  "amz_bucket": "",\n  "amz_bucket_region": ""\n}'