MediaPlug

Image API

Thu, 09 Oct 2008 08:12:55 Z

HomePage | REST API | Javascript Usage? | Ruby Wrapper?

Image API

Resize

resize width=x height=y format=f 
x: dimension of desired width
y: dimension of desired height
f: jpg|gif|png

mpaction=resize width=200 height=100 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=400 height=100 format=gif

The following geometry qualifiers can also be used with x and y when resizing:

% + - > <

Increase the width by 150 pixels, and decrease the height by 30 pixels.

mpaction=resize width=+150 height=-30 http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=+150 height=-30

Decrease the width to 80 percent of the original width, and increase the height to 120 precent of the original height.

mpaction=resize width=80% height=120% http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=80% height=120%

Resize the width to 100, and resize the height proportionally. So a 200×100 image will become 100×50 after this operation.

mpaction=resize width=100 height=     
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=100 height=*

Resize the width to at least 100 pixels, and resize the height to at most 50. So a 200×40 image will not change, but a 80×100 images will be resized to 100×50.

mpaction=resize width=>100 height=<50
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=>100 height=<50>

Note: ‘>’, ‘<’, and ’%’ should be encoded (to ”%3E”, ”%3C”, and ”%25”) in the url as they are HTML special characters.

Crop

crop location=l x-origin=xo y-origin=ye x-end=xe y-end=ye width=w height=h format=f
l: absolute|center
xo: integer, x-origin, the location relative to height to start the crop (can only be used with absolute location)
yo: integer, y-origin, the location relative to the width to start the crop (can only be used with absolute location)
xe: integer, x-end, the location relative to the height to end the crop (can only be used with absolute location)
ye: integer y-end, the location relative to the width to end the crop (can only be used with absolute location)
w: width to crop the resulting image (can only be used with center location)
h: heigh to crop the resulting image (can only be used with center location)
f: jpg|gif|png

mpaction=crop location=absolute x-origin=1 y-origin=10 x-end=70 y-end=70 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop location=absolute x-origin=1 y-origin=10 x-end=70 y-end=70 format=gif

mpaction=crop location=center width=100 height=100 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop location=center width=100 height=100 format=gif

Rotate

rotate degree=x format=f
x: degree to rotate the image
f: jpg|gif|png

mpaction=rotate degree=45 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=rotate%20degree=45%20format=gif

Flip

flip direction=v|h|b format=f
v: vertical flip
h: horizontal flip
b: vertical and horizontal flip
f: jpg|gif|png

mpaction=flip direction=v format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=flip%20direction=v%20format=gif

mpaction=flip direction=h format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=flip%20direction=h%20format=gif

mpaction=flip direction=b format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=flip%20direction=b%20format=gif

Watermark

watermark url=u|t position=p alpha=a text-font-size=s bold=b italic=i format=f 
u: url of watermark image
t: text to watermark the image with
p: top|top-left|top-right|middle|bottom|bottom-left|bottom-right (optional, default is middle)
a: 0.0-1.0 (this specifies the transparency, optional, default is 0.6)
s: integer, size of font if using text to watermark
b: true|false (optional, default is false)
i: true|false (optional, default is false)
f: jpg|gif|png

Note: Spaces can be added to the text watermark by inserting ’\’ between words.

mpaction=watermark text=watermark\ demo format=gif position=middle alpha=0.7 text-font-size=32 bold=true italic=true           
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=watermark text=watermark\ demo format=gif position=middle text-font-size=32 alpha=0.7 bold=true italic=true

mpaction=watermark text=watermark\ demo format=gif position=bottom-right alpha=1 text-font-size=24
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=watermark text=watermark\ demo format=gif position=bottom-right alpha=1 text-font-size=24

Note: Image actions can be chained together by separating them with a ’;’ in the mpaction. For example mpaction=flip direction=h format=gif;rotate degree=90 format=gif will first flip the image horizontally then rotate it 90 degrees.

Metadata API

Tue, 09 Sep 2008 10:03:16 Z

Metadata

You can query MediaPlug for information about a file. Among other things this is useful for retrieving the S3 URL for the encoded file so you don’t have to go through MediaPlug to serve the file after it is encoded.

To retrieve metadata replace ‘get’ in URL’s with ‘metadata’.

If your original URL was:

http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=400 height=100 format=gif

To retrieve metadata about that file your URL would look like:

http://demo.gomediaplug.com/mp/metadata?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=400 height=100 format=gif

The returned metadata for the action above would look like:

<?xml version="1.0" encoding="UTF-8"?>
    
    <FIELD>
    <NAME>ETag</NAME>
    <VALUE>"6ff5ee10da272e7589cfb85f4fee1e1e"</VALUE>
    </FIELD>
    <FIELD>
    <NAME>imageleftposition</NAME>
    <VALUE>0</VALUE>
    </FIELD>
    <FIELD>
    <NAME>imageheight</NAME>
    <VALUE>100</VALUE>
    </FIELD>
    <FIELD>
    <NAME>transparentcolorindex</NAME>
    <VALUE>0</VALUE>
    </FIELD>
    <FIELD>
    <NAME>imagetopposition</NAME>
    <VALUE>0</VALUE>
    </FIELD>
    <FIELD>
    <NAME>Content-Length</NAME>
    <VALUE>7607</VALUE>
    </FIELD>
    <FIELD>
    <NAME>Last-Modified</NAME>
    <VALUE>Tue Sep 02 08:36:09 PDT 2008</VALUE>
    </FIELD>
    <FIELD>
    <NAME>request-id</NAME>
    <VALUE>9F964F1C7213C100</VALUE>
    </FIELD>
    <FIELD>
    <NAME>userinputflag</NAME>
    <VALUE>false</VALUE>
    </FIELD>
    <FIELD>
    <NAME>type</NAME>
    <VALUE>image/gif</VALUE>
    </FIELD>
    <FIELD>
    <NAME>url</NAME>
    <VALUE>http://s3.amazonaws.com/intridea_mediaplug_demo/http://gomediaplug.com/images/mediaplug.gif resize width=400 height=100 format=gif</VALUE>
    </FIELD>
    <FIELD>
    <NAME>delaytime</NAME>
    <VALUE>0</VALUE>
    </FIELD>
    <FIELD>
    <NAME>Date</NAME>
    <VALUE>Mon Sep 08 22:44:49 PDT 2008</VALUE>
    </FIELD>
    <FIELD>
    <NAME>id-2</NAME>
    <VALUE>rTw6dkapV7u7k1HwdBT9Q30i6Id00fyduwdOC6GHGjENbgIkTagm8YQeia1NA6ON</VALUE>
    </FIELD>
    <FIELD>
    <NAME>name</NAME>
    <VALUE>RGB</VALUE>
    </FIELD>
    <FIELD>
    <NAME>value</NAME>
    <VALUE>0</VALUE>
    </FIELD>
    <FIELD>
    <NAME>imagewidth</NAME>
    <VALUE>400</VALUE>
    </FIELD>
    <FIELD>
    <NAME>disposalmethod</NAME>
    <VALUE>none</VALUE>
    </FIELD>
    <FIELD>
    <NAME>Content-Type</NAME>
    <VALUE>image/gif</VALUE>
    </FIELD>
    <FIELD>
    <NAME>interlaceflag</NAME>
    <VALUE>true</VALUE>
    </FIELD>
    <FIELD>
    <NAME>transparentcolorflag</NAME>
    <VALUE>false</VALUE>
    </FIELD>

REST API

Tue, 09 Sep 2008 10:01:42 Z

HomePage | REST API | Javascript API? | Ruby API

REST API Usage

Some actions are performed in real-time and others, such as video transcoding, are queued and processed asynchronously.

The first call to the url may return a status of 202 which means the content is queued and will be available once it’s encoded. Subsequent calls to the same url will return the encoded file if it is completed.

Here’s a good source for sample video and audio files which you can test with demo.gomediaplug.com.

URL Structure

http://[mediaplug_server]/mp/get?mpsrc=[mpsrc]&mpaction=[mpaction]

mediaplug_server: The IP address or domain name of your MediaPlug Server. If you plan on using more than one instance of MediaPlug we suggest you load balance them with round-robin DNS, a software load balancer, or hardware load balancer and make them available through a single URL which you can use for your mediaplug_server. Using DNS for this value is also a good idea if you ever replace a server since you won’t have to change any application code to use the new server.

mpsrc: Full URL of the original file you would like to perform an action on

mpaction: The action you would like to perform. Further REST API documentation refers to the mpaction variable. For each action an example is given for the mpaction variable as well as an example of a full REST URL to perform the action.

Note: For testing, mediaplug_server is demo.gomediaplug.com

Note: all url’s must be url encoded.

Images

MediaPlug can handle a range of image manipulation tasks including resizing, cropping, flipping, rotating, and watermarking with images or text.

Image API

Audio:

convert mp3 bitrate=[BITRATE] samplerate=[SAMPLERATE]
mpaction=convert format=mp3 bitrate=64k samplerate=128

example:
http://ec2-72-44-48-174.compute-1.amazonaws.com/mp/get?mpsrc=http://freewavesamples.com/files/Applause.wav&mpaction=convert%20format=mp3%20bitrate=128k%20samplerate=44.1

Video:

format can be flv, ipod, psp, 3gpp:

convert format=flv
mpaction=convert format=flv

Video Thumbnailing

thumbnail [frame]
mpaction=thumbnail frame=5

Recaching

All encoded files are cached on S3 so that processing occurs once. MediaPlug allows you to recache files you wish to update.

Recache API

Virus scanning

mpaction=scanvirus

examples of files with viruses:
http://demo.gomediaplug.com/mp/get?mpsrc=http://www.eicar.org/download/eicar.com&mpaction=scanvirus
http://demo.gomediaplug.com/mp/get?mpsrc=http://www.eicar.org/download/eicar_com.zip&mpaction=scanvirus
http://demo.gomediaplug.com/mp/get?mpsrc=http://www.eicar.org/download/eicar.com.txt&mpaction=scanvirus

examples of clean file:
http://demo.gomediaplug.com/mp/get?mpsrc=http://www.ccp14.ac.uk/ccp/ccp14/ftp-mirror/nist-texture/test.txt&mpaction=scanvirus

YouTube Videos:

MediaPlug can accept YouTube videos by providing the YouTube video URL as the mpsrc

mpsrc=[youtube url]
mpaction=convert format=[format]
http://demo.gomediaplug.com/mp/get?mpsrc=http://www.youtube.com/watch?v=c2JChnwv2Ws&mpaction=convert%20format=flv

Metadata:

MediaPlug allows for the retrieval of metadata for an encoded file.

Metadata API

HomePage

Tue, 09 Sep 2008 09:52:16 Z

REST API
1. Image API
2. Audio API?
3. Video API
4. Recache API
5. Virus Scan API?
6. YouTube API?
7. Metadata API
Javascript
Ruby API

Ruby API

Tue, 09 Sep 2008 09:51:36 Z

Ruby API

MediaPlug provides a Ruby gem which wraps the REST API to integrate directly in your Ruby or Ruby on Rails applications.

Installation:

git clone git@intridea.unfuddle.com:intridea/mediaplug-ruby.git
cd mediaplug-ruby
gem build mediaplug-ruby.gemspec
sudo gem install mediaplug-ruby-0.0.2.gem

Usage:

require 'mediaplug-ruby'

Look at the RDocs for further API info.

Recache API

Tue, 09 Sep 2008 09:48:17 Z

Recache

All encoded files are cached on S3 so that processing occurs once. To recache (e.g. you update a video file and need to re-encode) you can prepend ‘recache’ to the mpaction.

original encoding:

mpaction='convert format=flv'

to recache (re-encode):

mpaction='recache;convert format=flv'

Note: The subsequent call to retrieve the file should not prepend recache as this would force the file to be re-encoded again.

Ruby

Tue, 09 Sep 2008 09:23:19 Z

Back to HomePage

Installation:

git clone git@intridea.unfuddle.com:intridea/mediaplug-ruby.git
cd mediaplug-ruby
gem build mediaplug-ruby.gemspec
sudo gem install mediaplug-ruby-0.0.2.gem

Usage:

require 'mediaplug-ruby'

to get started, and look at the RDocs for API info.

Image Manipulation API

Mon, 08 Sep 2008 07:35:58 Z

Homepage? | REST API | Javascript Usage? | Ruby Wrapper?

Image API

Resize | Crop | Flip | Watermark

Resize

resize width=x height=y format=z 
where x and y are the dimensions of the resized image and z is the format of the resulting image (jpg, gif, png)

mpaction=resize width=200 height=100 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=400 height=100 format=gif

The following geometry qualifiers can also be used with x and y:

% + - > <

Increase the width by 150 pixels, and decrease the height by 30 pixels.

mpaction=resize width=+150 height=-30 http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=+150 height=-30

Decrease the width to 80 percent of the original width, and increase the height to 120 precent of the original height.

resize width=80% height=120% http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=80% height=120%

Resize the width to 100, and resize the height proportionally. So a 200×100 image will become 100×50 after this operation.

resize width=100 height=     
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=100 height=*

Resize the width to at least 100 pixels, and resize the height to at most 50. So a 200×40 image will not change, but a 80×100 images will be resized to 100×50.

resize width=>100 height=<50
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=resize width=>100 height=<50>

Note: ‘>’, ‘<’, and ’%’ should be encoded (to ”%3E”, ”%3C”, and ”%25”) in the url as they are HTML special characters.

Crop

crop location=absolute|center x-origin=[x-origin] y-origin=[y-origin] x-end=[x-end] y-end=[y-end] format=[format]
absolute: 
center:
x-origin
y-origin
x-end
y-end
format: jpg|gif|png

crop location=absolute x-origin=10 y-origin=10 x-end=30 y-end=30 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop location=absolute x-origin=10 y-origin=10 x-end=30 y-end=30 format=gif

crop location=center width=100 height=100 format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop location=center width=100 height=100 format=gif

crop location=absolute x-origin y-origin x-end y-end [format]
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop location=absolute x-origin=10 y-origin=10 x-end=100 y-end=100 format=gif

crop location=center width height [format]
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop location=absolute x-origin=10 y-origin=10 x-end=100 y-end=100 format=gif

example: 
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=crop%20location=center%20width=100%20height=100%20format=gif

Rotate

rotate degree=x format=[format]

example: 
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=rotate%20degree=45%20format=gif

Flip

flip direction=v|h|b format=[format]
v: vertical flip
h: horizontal flip
b: vertical and horizontal flip
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=flip%20direction=v%20format=gif

mpaction=flip direction=v format=gif

mpaction=flip direction=h format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=flip%20direction=h%20format=gif

mpaction=flip direction=b format=gif
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=flip%20direction=b%20format=gif

Watermark

watermark url=watermark_image_url|text=watermark_text format=[format] position=[position] alpha=[alpha] text-font-size=[text-font-size] bold=[bold] italic=[italic]
position: top|top-left|top-right|middle|bottom|bottom-left|bottom-right (optional, default is middle)
alpha=0.0-1.0 (optional, default is 0.6)
bold=true|false (optional, default is false)
italic=true|false (optional, default is false)

Note: Spaces can be added to the text watermark by inserting ’\’ between words.

mpaction=watermark text=watermark\ demo format=gif position=middle alpha=0.7 text-font-size=32 bold=true italic=true           
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=watermark text=watermark\ demo format=gif position=middle text-font-size=32 alpha=0.7 bold=true italic=true

mpaction=watermark text=watermark\ demo format=gif position=bottom-right alpha=1 text-font-size=24
http://demo.gomediaplug.com/mp/get?mpsrc=http://gomediaplug.com/images/mediaplug.gif&mpaction=watermark text=watermark\ demo format=gif position=bottom-right alpha=1 text-font-size=24

MediaPlug

Image API

Image API

Resize

Crop

Rotate

Flip

Watermark

Metadata API

Metadata

REST API

REST API Usage

URL Structure

Images

Audio:

Video:

Video Thumbnailing

Recaching

Virus scanning

YouTube Videos:

Metadata:

HomePage

Ruby API

Ruby API

Installation:

Usage:

Recache API

Recache

Ruby

Image Manipulation API

Image API

Resize

Crop

Rotate

Flip

Watermark

Video API

Video API

Convert

Watermark

Thumbnail

Javascript

Using mediaplug.js for HTML integration