Changes between Version 70 and Version 71 of OvaRCNotes-011211-3


Ignore:
Timestamp:
03/08/11 18:24:22 (2 years ago)
Author:
paul
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • OvaRCNotes-011211-3

    v70 v71  
    114114For a detailed account of the VPAID API as defined by the IAB, please refer to the [http://www.iab.net/vpaid VPAID specification]. 
    115115 
    116 === 4.1 Enabling VPAID for OVA for JW Player 5 === 
     116=== 4.1 Enabling VPAID for OVA for Flowplayer === 
     117 
     118VPAID ads will be played by default with OVA for Flowplayer. No specific configuration is required. 
     119 
     120To see an example VPAID linear ad in action with Flowplayer, click [http://static.openvideoads.org/qa/rc3-8/ova.flowplayer/examples/vpaid here]. 
     121 
     122==== 4.1.1 VPAID and Flowplayer 3.2.6 Control Bars ==== 
     123 
     124The standard Flowplayer 3.2.6 Control Bars currently have a small issue that may cause problems with the sizing of VPAID linear ads. 
     125 
     126Flowplayer 3.2.6 when used with flowplayer-controls.3.2.4 or flowplayer-controls.3.2.5 will report the height of the controls as 0. 
     127 
     128OVA uses the sizing information for the control bars when configuring VPAID ads. Incorrect sizing information will result in the VPAID ad not displaying correctly around the control bar area. 
     129 
     130To force the sizing of the control bar to be correctly recognised by OVA, a control bar "height" option has been introduced. 
     131 
     132Use this option as follows: 
     133 
     134{{{ 
     135   "ads": { 
     136        "controls": { 
     137             "height": 30 
     138        } 
     139   } 
     140}}} 
     141 
     142==== 4.1.2 VPAID Ads and "always" autoHide control bars ==== 
     143 
     144By default, VPAID ads will cover "always" autoHide configured control bars. 
     145 
     146For some reason however, the control bar may occasionally appear over the VPAID ad when the mouse is moved over the control bar area. This is not a consistent bug and seems to happen randomly. 
     147 
     148If you notice this behaviour and wish to size the VPAID ad so that it is not appearing over the control bar area, use the following option in conjunction with the "autoHide": "always" Flowplayer player configuration: 
     149 
     150{{{ 
     151    "ads": { 
     152          "vpaid": { 
     153                "controls": { "hideOnLinearPlayback": "false" } 
     154          } 
     155    } 
     156}}} 
     157 
     158=== 4.2 Enabling VPAID for OVA for JW Player 5 === 
    117159 
    118160VPAID ads will be played by default by OVA for JW Player 5. No specific configuration is required. 
    … …  
    122164The default behaviour for OVA is to hide the control bar during VPAID Linear Ad playback. This behaviour can be overridden (see below). 
    123165 
    124 === 4.2 Enabling VPAID for OVA for JW Player 4 === 
     166=== 4.3 Enabling VPAID for OVA for JW Player 4 === 
    125167 
    126168For VPAID Linear Ads to work with OVA for JW Player 4, a "holding" clip must be placed in the position of the linear ad within the playlist. A holding clip is a "minimal" image - a single black pixel image file. 
    … …  
    147189To see an example JW4 VPAID linear ad in action, click [http://static.openvideoads.org/rc/2/ova.jwplayer.4x/examples/pages/vpaid here]. 
    148190 
    149 === 4.3 Showing the Control Bar during VPAID Linear Playback === 
     191=== 4.4 Showing the Control Bar during VPAID Linear Playback === 
    150192 
    151193OVA for JW Player 4/5 hides the control bar by default during VPAID Linear Ad playback. 
    … …  
    164206An example can be found [http://static.openvideoads.org/rc/2/ova.jwplayer.5x/examples/pages/vpaid/example1.2.html here]. 
    165207 
    166 === 4.4 Instructing OVA to pass a Referrer URL to the VPAID Ads === 
     208=== 4.5 Instructing OVA to pass a Referrer URL to the VPAID Ads === 
    167209 
    168210Sometimes VPAID ads require a "referrer" URL to be passed to them. 
    … …  
    181223An example can be found [http://static.openvideoads.org/rc/2/ova.jwplayer.5x/examples/pages/vpaid/example3.1.html here]. 
    182224 
    183 === 4.5 Setting the Maximum Timeout Option === 
     225=== 4.6 Setting the Maximum Timeout Option === 
    184226 
    185227If a VPAID ad has an internal exception that cannot be caught by OVA, a default timer can be set to ensure that OVA will eventually close down the VPAID ad and continue on to the next clip. 
    … …  
    199241An example can be found [http://static.openvideoads.org/rc/2/ova.jwplayer.5x/examples/pages/vpaid/example3.2.html here]. 
    200242 
    201 === 4.6 Integrating VPAID Into your Custom Player via OVA for AS3 === 
     243=== 4.7 Integrating VPAID Into your Custom Player via OVA for AS3 === 
    202244 
    203245''The code shown in this section has been taken from the OVA for JW Player 5 implementation. Please use that implementation as a reference implementation when integrating the OVA VPAID functionality into your custom player.'' 
    204246 
    205 ==== 4.6.1 How OVA Treats VPAID Ads ==== 
     247==== 4.7.1 How OVA Treats VPAID Ads ==== 
    206248 
    207249VPAID ads are delivered to OVA via a VAST response. 
    … …  
    237279In principal, OVA does all the work to playback a VPAID ad. The custom player just has to recognise when an ad to be played is a VPAID ad and trigger the OVA VPAID playback functionality accordingly. 
    238280 
    239 ==== 4.6.2 The Three Steps to Integration ==== 
     281==== 4.7.2 The Three Steps to Integration ==== 
    240282 
    241283To implement OVA VPAID functionality within your player, three steps should be taken: 
    … …  
    245287    3. Implement the clip control logic to ensure that if the active ad to play is a VPAID ad, play it using the OVA "playVPAID" method rather than loading it as a clip into the player 
    246288      
    247 ==== 4.6.3 The VPAID Events ==== 
     289==== 4.7.3 The VPAID Events ==== 
    248290 
    249291Two sets of VPAID events are provided by OVA - those generated by linear VPAID ads, and those generated by non-linear VPAID ads. 
    … …  
    273315Typically a full set of event handlers implemented for the type  of VPAID ads (linear, non-linear) that you are delivering. 
    274316 
    275 ==== 4.6.4 Implementing The VPAID Event Handlers ==== 
     317==== 4.7.4 Implementing The VPAID Event Handlers ==== 
    276318 
    277319A VPAID Event handler is declared using the "addEventListener" VASTController method. The following code snippet illustrates how to declare event listeners for the full set of linear VPAID events: 
    … …  
    322364   * The VPAIDAdDisplayEvent passed to VPAID Time Change handlers will contain an int that represents the time remaining in the playback of the VPAID ad. Note, this "remaining time" notification mechanism does not seem to be reliably implemented across ad providers so it should not be relied upon. 
    323365 
    324 ==== 4.6.5 Triggering the Playback of a VPAID Ad ==== 
     366==== 4.7.5 Triggering the Playback of a VPAID Ad ==== 
    325367 
    326368OVA AdSlots now have an "isInteractive()" method. This method can be used to query the AdSlot type. If AdSlot.isInteractive() == true, the AdSlot is a VPAID linear or non-linear ad.  
    … …  
    343385   * On completion of the VPAID ad, the OVA VASTController takes care of cleaning up the VPAID ad resources and hiding the overlay used to display the VPAID ad 
    344386 
    345 ==== 4.6.6 Getting hold of the active VPAID ad and then manipulate it ==== 
     387==== 4.7.6 Getting hold of the active VPAID ad and then manipulate it ==== 
    346388 
    347389The following code snippet illustrates how to get hold of the active VPAID ad and change the volume on it: 
    … …  
    359401}}} 
    360402 
    361 === 4.7 Known Limitations === 
     403=== 4.8 Known Limitations === 
    362404 
    363405   * An exception in the VPAID ad that does not throw an Error event will hang the player (unless timeout is defined)