root/lang/javascript/aerial.js/README @ 18575

aerial.js
---

*What's this?

  aerial.js is one of the implementations of Aerial client library.

  Aerial is a technology that enables interactive RPC between the server and
  JavaScript by using Flash for communication.


*Components

  - aerial.js
      JavaScript library.

  - aerial-multicast.js
      An extension library that extends aerial.js.

  - Aerial.as
      ActionScript library that implements JSON-RPC.


*Compiling swf

   Aerial.as file needs to be compiled by Flex SDK.

   Aerial.as depends on 'as3corelib' library, which is hosted on:

       http://code.google.com/p/as3corelib/

   Compile it with following command:

       $ mxmlc -compiler.library-path=corelib.swc Aerial.as


*How to embed aerial.js to the HTML.

  This library depends on swfobject 2.0 library, which is hosted on:

    http://code.google.com/p/swfobject/

  Add following lines to the HTML.

    <!-- in 'head' tag -->
      <script type="text/javascript" src="/path/to/swfobject.js"></script>
      <script type="text/javascript" src="/path/to/aerial.js"></script>

      <!-- This is optional -->
      <script type="text/javascript" src="/path/to/aerial-multicast.js"></script>


    <!-- in 'body' tag -->
      <div id="aerial_swf"></div>

      <script type="text/javascript">
      //<![CDATA[
          var aerial = new Aerial("/path/to/Aerial.swf", "aerial_swf", function(){
              // your code ....
          }
          // ...
      //]]>
      </script>


*API Reference

  TODO



*Copyright and license

Copyright (C) 2008 FURUHASHI Sadayuki <fr _at_ syuki.skr.jp>

Licensed under the Apache License Version 2.0.