You can also view

You are viewing documentation for version 14. This version is in beta!
The current version is version 13

Documentation

Introduction

Overview New in V14 Browser Support

Apps

Overview Configuration

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Videos

Overview Embedding Configuration JS Methods & Events

Overview Embedding Configuration JS Methods

Overview Embedding Configuration Custom Interface JS Methods JS Events

<photo>

Overview Embedding

Overview Embedding Configuration Custom Interface JS Methods JS Events Collecting Audio

REST API

Overview List Assets Show Asset Update Asset Delete Asset List Apps Show App Create App Update App Video Object Photo Object Audio Object

Advanced Photobooth Configuration

Beyond the two required settings for a <photobooth> there are several optional advanced settings. You can configure these using our Embed Sandbox by clicking on the link labled "Advanced Configuration" or by using data attributes on your own hand-rolled <photobooth>

App
ID
Width
Height
Mirror Camera Preview
Metadata
Force Full Frame Images
Skip Zoom

App

Choose the CameraTag App form which this photobooth should publish its assets

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-app-id=''></photobooth>

ID

A unique identifier for this photobooth (in case you have more than one on the page) The default value is "myPhotobooth"

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' id='myPhotobooth'></photobooth>

Width

The width of the photobooth on the page (does not effect image resolution) The default value is "320"

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-width='320'></photobooth>

Height

The height of the photobooth on the page (does not effect image resolution) The default value is "240"

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-height='240'></photobooth>

Mirror Camera Preview

When set to false the photobooth will NOT horizontally flip the camera preview. The default value is "true"

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-mirror-preview='true'></photobooth>

Metadata

A JSON string to be stored along with the video. This data will be made available in the server callback and the REST API. **Value must be validly formatted JSON (using double quotes)

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-metadata='{"user_id": 1234, "user_name": "Jon Doe"}'></photobooth>

Force Full Frame Images

The default value is "false"

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-force-full-frame='false'></photobooth>

Skip Zoom

By default the photobooth will display pan/zoom options if a file is selected with a different aspect ratio than target. Set this to true to bypass this step. The default value is "false"

<photobooth id='MyWall1' data-app-id='[YOUR_CAMERA_UUID]' data-skip-zoom='false'></photobooth>