Framey

This add-on is operated by Q Labs

Easily let users record video on any website!

Framey

Last Updated: 19 March 2014

The Framey add-on is currently in beta.

Table of Contents

The Framey add-on makes it easy to create a profile with Framey.com, so that you can quickly embed video players and recorders into your site.

Deploying to Heroku

To use Framey on Heroku, install the Framey add-on:

$ heroku addons:add framey

This will provision a user with API and secret keys, that you can then use for embedding Framey services or to implement the Framey gem.

Usage

To embed Framey in a site, first retrieve your API and secret keys from the Framey dashboard:

$ heroku addons:open framey

You can then embed Framey using the language (and player) of your choice.

Recorder embed example (HAML)

= javascript_include_tag "http://framey.com/javascripts/swfobject.js"
- api_key = "<API_KEY>"
- api_secret = "<SECRET>"
- sig_expires_in = 20.minutes
- max_record_time = 25 # value in seconds
- session_data = {}

// ONLY EDIT BELOW THIS LINE IF YOU ARE A 133t H@x0R
- timestamp = (Time.now.utc + sig_expires_in).to_i
- signature = Digest::MD5.hexdigest(api_secret + "&" + timestamp.to_s)
- session_data = session_data.map { |k,v| "#{k.to_s}=#{v.to_s}" }.join(",")
- divid = "frameyRecorderContainer_#{(rand*999999999).to_i}"
- objid = "the#{divid}"

%div{:id => divid}
:javascript
  var flashvars = {
    api_key: "#{api_key}",
    signature: "#{signature}",
    time_stamp: "#{timestamp}",
    session_data: "#{session_data}",
    max_time: "#{max_record_time.to_s}"
  };
  var params = {
    'allowscriptaccess': 'always',
    "wmode": "transparent"
  };
  var attributes = {
    'id': "#{objid}",
    'name': "#{objid}"
  };
  swfobject.embedSWF("http://framey.com/recorder.swf", "#{divid}", "340", "340", "8", "", flashvars, params, attribute

The Framey Gem

The Framey gem takes care of several tasks for you automatically. It includes a scaffold generator, defines logic for handling callbacks, and includes helper methods to cleanly include recorder and player code in your views.

View the Framey gem documentation for more details.