Changeset 1102


Ignore:
Timestamp:
06/04/10 18:19:57 (3 years ago)
Author:
pablo
Message:

RST cleanup, adding plugin compiling tutorial

Location:
trunk/fl5/doc
Files:
1 added
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/fl5/doc/developers/buildingplugins.rst

    r1070 r1102  
    1010================= 
    1111 
    12 A JW Player plugin is a separate SWF file, written in Actionscript 3, which is loaded by the player at runtime. Plugins integrate seamlessly with the player, both in terms of coding (through the :ref:`api`) and graphics (stacked on top of the player). Plugins are loaded into player by setting the :ref:`plugins <options-api>` option. For example, if you wanted to load two plugins named **advertising.swf** and **delicious.swf**, the corresponding flashvar would be *plugins=advertising,delicious*.  If you used SWFObject 2.x to embed the JW Player, the code would look something like this: 
     12A JW Player plugin is a separate SWF file, written in Actionscript 3, which is loaded by the player at runtime. Plugins integrate seamlessly with the player, both in terms of coding (through the :ref:`pluginapi`) and graphics (stacked on top of the player). Plugins are loaded into player by setting the :ref:`plugins <options-api>` option. For example, if you wanted to load two plugins named **advertising.swf** and **delicious.swf**, the corresponding flashvar would be *plugins=advertising,delicious*.  If you used SWFObject 2.x to embed the JW Player, the code would look something like this: 
    1313 
    1414 
  • trunk/fl5/doc/developers/developers.rst

    r1082 r1102  
    88   :maxdepth: 2 
    99    
    10    buildingplugins 
    1110   mediaproviders 
    1211   pluginapi 
     12   buildingplugins 
     13   compilingplugins 
  • trunk/fl5/doc/publishers/httpstreaming.rst

    r1079 r1102  
    2727--------- 
    2828 
    29 Under water, HTTP pseudostreaming works as follows: 
     29Under the hood, HTTP pseudostreaming works as follows: 
    3030 
    3131When the video is initially loaded, the player reads and stores a list of *seekpoints* as part of the video's metadata. These seekpoints are offsets in the video (both in seconds and in bytes) at which a new *keyframe* starts. At these offsets, a request to the server can be made. 
  • trunk/fl5/doc/publishers/mediaformats.rst

    r1082 r1102  
    1010The JW Player always tries to recognize a file format by its extension. If no suitable extension is found, **the player will presume you want to load a** :ref:`playlist <playlistformats>`! Get around this issue by setting the :ref:`provider  option <options>`, e.g. *provider=video*. 
    1111 
    12 .. csv-table:: Supported Media Formats 
    13         :widths: 5 5 5 10 
    14         :header: "Format",                                                                                                      "Media Type",           :ref:`Provider <playlistitem>`, Notes 
    15  
    16         `FLV <http://en.wikipedia.org/wiki/Flv>`_,                                                      Video,                          video,                                                  "" 
    17         `MP4 <http://en.wikipedia.org/wiki/H.264>`_,                                            Video,                          video,                                                  "MP4 files must be encoded in the H.264 format" 
    18         `AAC <http://en.wikipedia.org/wiki/Advanced_Audio_Coding>`_,            Audio,                          video,                                                  "Audio in AAC format must use the *video* provider." 
    19         `MP3 <http://en.wikipedia.org/wiki/MP3>`_,                                                      Audio,                          sound,                                                  "" 
    20         `JPG <http://www.w3.org/Graphics/JPEG/>`_,                                                      Image,                          image,                                                  "" 
    21         `GIF <http://en.wikipedia.org/wiki/Gif>`_,                                                      Image,                          image,                                                  "" 
    22         `PNG <http://en.wikipedia.org/wiki/Portable_Network_Graphics>`_,        Image,                          image,                                                  "" 
     12=================================================================  ==========  ==================================  =================================================== 
     13Format                                                             Media Type  :ref:`Provider <options-playlist>`  Notes 
     14=================================================================  ==========  ==================================  =================================================== 
     15`FLV <http://en.wikipedia.org/wiki/Flv>`_                          Video       video                            
     16`MP4 <http://en.wikipedia.org/wiki/H.264>`_                        Video       video                               MP4 files must be encoded in the H.264 format 
     17`AAC <http://en.wikipedia.org/wiki/Advanced_Audio_Coding>`_        Audio       video                               Audio in AAC format must use the *video* provider. 
     18`MP3 <http://en.wikipedia.org/wiki/MP3>`_                          Audio       sound 
     19`JPG <http://www.w3.org/Graphics/JPEG/>`_                          Image       image 
     20`GIF <http://en.wikipedia.org/wiki/Gif>`_                          Image       image 
     21`PNG <http://en.wikipedia.org/wiki/Portable_Network_Graphics>`_    Image       image 
     22=================================================================  ==========  ==================================  =================================================== 
    2323 
    2424For example, to load an MP3 file, set the *provider* flashvar or playlist property to *sound*. 
     
    4646=============== 
    4747 
    48 The JW Player supports two types of streaming servers, :ref:`RTMP Streaming <rtmpstreaming>` and :ref:`HTTP Pseudo-Streaming <httpstreaming>`.  See :ref:`rtmpstreaming` and :ref:`httpstreaming` for information on how to configure the JW Player to play content from these types of streaming server. 
     48The JW Player supports two types of streaming servers, :ref:`RTMP Streaming <rtmp>` and :ref:`HTTP Pseudo-Streaming <http>`.  See :ref:`rtmp` and :ref:`http` for information on how to configure the JW Player to play content from these types of streaming server. 
    4949 
    5050CDNs 
     
    5353Certain `CDNs <http://en.wikipedia.org/wiki/Content_delivery_network>`_ have special configuration options which have built-in shortcuts for the JW Player.  These are: 
    5454 
    55 .. csv-table:: CDN Provider Shortcuts 
    56         :widths: 5 5 
    57         :header: "CDN",                                                         "Provider Shortcut" 
    58  
    59         `BitGravity <http://www.bitgravity.com/>`_, bitgravity 
    60         `EdgeCast <http://www.edgecast.com/>`_,         edgecast 
    61         `HighWinds <http://www.highwinds.com/>`_,       highwinds 
    62         `VDO-X <http://www.vdo-x.net/>`_,                       vdox 
     55==========================================  ================= 
     56CDN                                         Provider Shortcut 
     57==========================================  ================= 
     58`BitGravity <http://www.bitgravity.com/>`_  bitgravity 
     59`EdgeCast <http://www.edgecast.com/>`_      edgecast 
     60`HighWinds <http://www.highwinds.com/>`_    highwinds 
     61`VDO-X <http://www.vdo-x.net/>`_            vdox 
     62==========================================  ================= 
    6363 
    6464Custom Providers 
  • trunk/fl5/doc/publishers/playlistformats.rst

    r1082 r1102  
    1 .. _playlistformats: 
     1.. _playlists: 
    22 
    33============= 
     
    2323 
    2424 
    25  * ASX_ feeds (`example <http://developer.longtailvideo.com/player/testing/files/asx.xml>`_) 
    26  * ATOM_ feeds with MediaRSS_ extensions (`example <http://developer.longtailvideo.com/player/testing/files/atom.xml>`_) 
    27  * RSS_ feeds with iTunes_ (`example <http://developer.longtailvideo.com/player/testing/files/irss.xml>`_) extensions and MediaRSS_ extensions (`example <http://developer.longtailvideo.com/player/testing/files/mrss.xml>`_) 
    28  * XSPF_ feeds (`example <http://developer.longtailvideo.com/player/testing/files/xspf.xml>`_) 
     25 * ASX_ feeds (`ASX example <http://developer.longtailvideo.com/player/testing/files/asx.xml>`_) 
     26 * ATOM_ feeds with MediaRSS_ extensions (`ATOM example <http://developer.longtailvideo.com/player/testing/files/atom.xml>`_) 
     27 * RSS_ feeds with iTunes_ (`iTunes RSS example <http://developer.longtailvideo.com/player/testing/files/irss.xml>`_) extensions and MediaRSS_ extensions (`MRSS example <http://developer.longtailvideo.com/player/testing/files/mrss.xml>`_) 
     28 * XSPF_ feeds (`XSPF example <http://developer.longtailvideo.com/player/testing/files/xspf.xml>`_) 
    2929 
    3030 
    31 Here is an overview of all the tags for each playlist format the player processes, and the :ref:`Playlist Item <playlistitem>` property they correspond to: 
     31Here is an overview of all the tags for each playlist format the player processes, and the :ref:`Playlist Item <options-playlist>` property they correspond to: 
    3232 
    33 .. csv-table:: Playlist Properties for XML Formats 
    34         :widths: 25 10 10 10 10 10 10 
    35         :header: "Property",                            XSPF_,          RSS_,                   iTunes_,        MediaRSS_,              ASX_,           ATOM_ 
    36          
    37         :ref:`author <playlistitem>`,           creator,        --,                     author,         credit,                 author,         -- 
    38         :ref:`date <playlistitem>`,             --,             pubDate,                --,             --,                     --,             published 
    39         :ref:`description <playlistitem>`,      annotation,     description,    summary,        description,    abstract,       summary 
    40         :ref:`duration <playlistitem>`,         duration,       --,                     duration,       content,                duration,       -- 
    41         :ref:`file <playlistitem>`,             location,       enclosure,      --,             content,                ref,            -- 
    42         :ref:`link <playlistitem>`,             info,           link,                   --,             --,                     moreinfo,       link 
    43         :ref:`image <playlistitem>`,            image,          --,                             --,                     thumbnail,              --,                     -- 
    44         :ref:`start <playlistitem>`,            --,             --,                     --,             --,                     starttime,      -- 
    45         :ref:`streamer <playlistitem>`,         --,                     --,                             --,                     --,                             --,             -- 
    46         :ref:`tags <playlistitem>`,             --,                     category,               keywords,       keywords,               --,             -- 
    47         :ref:`title <playlistitem>`,            title,          title,                  --,                     title,                  title,          title 
    48         :ref:`provider <playlistitem>`,         --,                     --,                             --,                     --,                             --,                     --               
    4933 
     34======================================  =========== ==============  ==========  ==============  ==========  ========== 
     35Property                                XSPF_       RSS_            iTunes_     MediaRSS_       ASX_        ATOM_ 
     36======================================  =========== ==============  ==========  ==============  ==========  ========== 
     37:ref:`author <options-playlist>`        creator     (none)          author      credit          author      (none) 
     38:ref:`date <options-playlist>`          (none)      pubDate         (none)      (none)          (none)      published 
     39:ref:`description <options-playlist>`   annotation  description     summary     description     abstract    summary 
     40:ref:`duration <options-playlist>`      duration    (none)          duration    content         duration    (none) 
     41:ref:`file <options-playlist>`          location    enclosure       (none)      content         ref         (none) 
     42:ref:`link <options-playlist>`          info        link            (none)      (none)          moreinfo    link 
     43:ref:`image <options-playlist>`         image       (none)          (none)      thumbnail       (none)      (none) 
     44:ref:`start <options-playlist>`         (none)      (none)          (none)      (none)          starttime   (none) 
     45:ref:`streamer <options-playlist>`      (none)      (none)          (none)      (none)          (none)      (none) 
     46:ref:`tags <options-playlist>`          (none)      category        keywords    keywords        (none)      (none) 
     47:ref:`title <options-playlist>`         title       title           (none)      title           title       title 
     48:ref:`provider <options-playlist>`      (none)      (none)          (none)      (none)          (none)      (none)     
     49======================================  =========== ==============  ==========  ==============  ==========  ========== 
    5050 
    5151All **media:** tags can be embedded in a **media:group** element. A **media:content** element can also act as a container. Additionally, iTunes_ and MediaRSS_ tags can be mixed in one RSS_ feed. The player will pick the last matching element for each property. 
  • trunk/fl5/doc/publishers/releasenotes.rst

    r1070 r1102  
    1818 
    1919 * Support for customized font settings 
     20  
    2021  * Controlbar text fields (**elapsed**, **duration**) can specify font face (*_sans*, *_serif*, *_typewriter*), font weight (*bold*), font style (*italic*) and font color (*0x123456*) 
    2122  * Playlist text fields (**title**, **description**, **duration**) can specify font face (*_sans*, *_serif*, *_typewriter*), font weight (*bold*), font style (*italic*) and font color (*0x123456*) 
     23   
    2224 * Customized controlbar layout 
     25  
    2326  * Allows placement of any button, text field or slider available in the controlbar 
    2427  * Adds the ability to insert arbitrary divider images 
     
    7376 
    7477* Replaces general SWF-skin colorization settings (*frontcolor*, *backcolor*, *lightcolor*, *screencolor*) with component-specific settings 
     78 
    7579 * Controlbar 
     80  
    7681  * *fontcolor*: Color for elapsed time and duration 
    7782  * *buttoncolor*: Colorization setting for controlbar icons 
     83   
    7884 * Playlist 
     85  
    7986  * *fontcolor*: Color for all text fields 
    8087  * *overcolor*: Colorization for playlist text fields when the mouse moves over the playlist item 
    8188  * *activecolor*: Color for the text fields in the currently active playlist item 
    8289  * *backgroundcolor*: Color of the background that sits behind the playlist items. 
     90   
    8391 * Display 
     92  
    8493  * *backgroundcolor*: replaces *screencolor* setting 
     94   
    8595* New skinning elements 
     96 
    8697 * Playlist 
     98  
    8799  * Active state for playlist item background (*itemActive* element) 
    88100  * Image placeholder for playlist images (*itemImage* element) 
    89101  * Top and bottom end caps for playlist slider (*sliderCapTop*, *sliderCapBottom*) 
     102   
    90103 * Controlbar 
     104  
    91105  * Left and right end caps for time and volume sliders (*timeSliderCapLeft*, *timeSliderCapRight*, *volumeSliderCapLeft*, *volumeSliderCapRight*) 
    92106  * Background images for text fields (*elapsedBackground*, *durationBackground*) 
     107   
    93108 * Display 
     109  
    94110  * Over states for display icons (*playIconOver*, *muteIconOver*, *errorIconOver*, *bufferIconOver*) 
     111   
    95112* Ability to use SWF assets in addition to JPGs and PNGs in XML skinning 
    96113 
     
    115132 
    116133 * Since 5.0 branched off from 4.5, version 5.1 re-integrates changes from 4.6+ into the 5.x branch, including: 
     134  
    117135  * Bitrate Switching 
    118136  * Bandwidth detection 
     137   
    119138 * DVR functionality for [wiki:FlashMediaServerDVR RTMP live streams]. 
    120139 
     
    145164 * Bitmap Skinning (PNG, JPG, GIF) 
    146165 * API Update for V5 plugins 
     166  
    147167  * Player resizes plugins when needed 
    148168  * Player sets X/Y coordinates of plugins 
    149169  * Plugins can request that the player block (stop playback) or lock (disable player controls). 
     170   
    150171 * MXMLC can be used to [browser:/trunk/fl5/README.txt compile the player]. 
    151172 * Backwards compatibility 
     173  
    152174  * SWF Skins 
    153175  * Version 4.x plugins 
Note: See TracChangeset for help on using the changeset viewer.