Ramune
======
Hector G. Parra 

Ramune is an Adobe Flash 10 application and accompanying JavaScript library specializing in Microphone/Camera acquisition and Audio/Video communication and presentation. It is meant to interface entirely through JavaScript and contains no chrome.

NOTE: This README is formatted in AsciiDoc (http://powerman.name/doc/asciidoc)

== Requirements

Ramune requires Adobe Flash 10: http://www.adobe.com/products/flashplayer/

Ramune requires certain JavaScript libraries. See Dependencies.

Ramune has been thoroughly tested on Firefox 3.0+. It was also been tested on Safari and Chrome. It does not yet work with Internet Explorer.

=== Building Dependencies

* Java
* Ant
* Flex 3.5 SDK
* as3corelib: 
* as3base64: http://github.com/spjwebster/as3base64

sudo cp ~/flex_sdk_3/ant/lib/flexTasks.jar /usr/share/ant/lib/

=== Dependencies

Ramune currently depends on three libraries, two of which we wish to deprecate in the future. Ramune.js actually checks for these libraries and throws an exception if one of them was not found. It does not yet support dependency injection.

* SWFObject: http://code.google.com/p/swfobject/
* FABridge: http://livedocs.adobe.com/flex/3/html/help.html?content=ajaxbridge_1.html
* jQuery: http://jquery.com/

The Telios group at Calit2 maintains a mirror of tested versions of these dependencies:

* SWFObject: http://marco.calit2.uci.edu/lib/swfobject/2.2/swfobject.js
* FABridge: http://marco.calit2.uci.edu/lib/swfobject/fabridge/FABridge.js
* jQuery: http://marco.calit2.uci.edu/lib/jquery/jquery-1.3.2.js



== Installation

There are three ways to acquire Martinelli by two code sources which require building and the Nightly Mirror where you can download the latest Ramune.js and Ramune.swf:

* Compressed Released: http://telios.calit2.uci.edu/framework.html
* Github Repository: https://github.com/hparra/ramune
* Nightly Mirror: http://marco.calit2.uci.edu/ramune/

IMPORTANT: Only the Nightly Mirror has compiled Ramune

== Usage

Using Ramune can be difficult since it does so much! Ramune outputs plenty of debug information, so we encourage you to use Firefox with the Firebug plug-in: http://getfirebug.com/


=== Dependency Origin

Adobe Flash Player has a standard Same-Origin Policy. Your HTML file and Ramune.swf should originate from the same domain or else the ability to interface with Ramune using JavaScript will be denied. Ramune.js assumes that Ramune.swf is in this directory as itself.


=== Load Dependencies

Assuming the following are in your local directory, load the SWFObject, FABridge, jQuery, and Ramune JavaScripts using the 
	
	
	
	

=== Load Ramune

You can specify where Ramune will live by using the following HTML tag:

	

	
If Ramune.js does not find this tag, it will create it for you and append it to the very end of your HTML document.

IMPORTANT: SWFObject will actually replace this tag with .

You may want to add a callback. A callback is a function that executes when an event associated with a function has fired. In this case, you can specify a function to execute after Ramune has been initialized:

	Ramune.addEventListener(Ramune.INITIALIZED, function() {
		// your code
	});

Initialize Ramune:

	Ramune.initialize();

Ramune is 0 x 0 pixels in size by default. You should resize it when appropriate:

	Ramune.resize(640, 480);
	
IMPORTANT: Don't forget to resize it's containing