wiki:OvaReleaseNote-1.0.0-RC7

Version 11 (modified by paul, 16 months ago) (diff)

--

What's New? (1.0.0 Release Candidate 7)

BEING WRITTEN

The following versions have been issued as "release candidates".

  • OVA for AS3 v1.0.0 RC7
  • OVA for JW Player 4 v1.0.0 RC7
  • OVA for JW Player 5 v1.0.0 RC7
  • OVA for Flowplayer v1.0.0 RC7

RC7 follows RC6 - please refer to the RC6 release note for a full account of all changes made up to and including RC6.

Summary of Changes

RC7 includes a number of key changes over RC6:

  • Non-linear ads can now be displayed using HTML5, this allows OVA to support iFrame and Javascript non-linear ad types in overlay and non-overlay format
  • A new player display definition model has been introduced into OVA to allow margins etc. to be more effectively specified for various playback types
  • The configuration structure has been cleaned up somewhat. Various options have moved around and been renamed

1. SWF and Javascript File Name Changes

The following SWF and Javascript file name changes have occurred in this release:

  • In preparation for the V1.0 production release, the OVA for JW5 and OVA for JW4 SWFs have been renamed to "ova-jw.swf" - in addition the OVA for JW5 Javascript plugin has been renamed to "ova-jw.js". These will be the official names of the OVA for JW V1.0 plugins (renaming them allows the pre V1.0 plugins/setups to continue operating untouched on the Longtail plugin repository). It is also worth noting that existing OVA configurations will work with the new names (e.g. your JW5 external config files do not require change as the <ova.XXXX> tagset will work with the "ova-jw" SWF naming)
  • The previously named OVA jQuery companion support Javascript file ova-jquery-companions.js has been renamed to ova-jquery.js to better reflect the new "non-companion" functionality that it now includes

2. Depreciated Configuration Options

While OVA will attempt to remain backward compatible, a number of configuration options have been moved around in the RC7 release as part of a general clean up to the configuration structure. These include:

Regions and Overlay configuration changes

  • "overlays:{}" config block has become "regions:{}"
  • "overlays.controlButton" has become "regions.controlButton"
  • "overlays.regions[]" has become "regions.declarations[]"
  • "ads.replayNonLinearAds" has become "overlays.replay"
  • "ads.acceptedNonLinearAdMimeTypes" has become "overlays.acceptedMimeTypes"
  • "ads.enableOverlayScaling" has become "overlays.enableScaling"
  • "ads.enforceOverlayRecommendedSizing" has become "ads.overlays.enableScaling"

Companion configuration changes

  • "ads.companions[]" has become "ads.companions.regions"
  • "ads.processCompanionsExternally" has become "ads.companions.html5"
  • "ads.millisecondDelayOnCompanionInjection" has become "ads.companions.millisecondDelayOnInjection"
  • "ads.displayCompanions" has become "ads.companions.enable"
  • "ads.restoreCompanions" has become "ads.companions.restore"
  • "ads.additionalParamsForSWFCompanions" has become "ads.companions.additionalParamsForSWFCompanions"

Skip Ads and Control Bar configuration changes

  • "ads.controls.skipAd" has become "ads.skipAd"
  • "ads.controls{}" has become "player.modes.linear.controls"
  • "ads.disableControls" has become "player.modes.linear.controls.manage"

VPAID configuration changes

  • "ads.vpaid.controls.hideOnLinearPlayback" has become "player.modes.linear.controls.vpaid.visible"

Ad scheduling configuration changes

  • "ads.schedule[].position" for non-linear ads has become "ads.schedule[].region"

If you use any of these options you are advised to move to the new configuration structure/options as soon as possible.

For an illustration of the configuration option changes, please consult the  OVA RC7 Examples.

2. API Changes

The following API changes have occurred in this release:

  • StageDimensions have been removed and replaced with a new Player description model - see "Section 5: Configuring the Player Display" for further information. This means that VASTController.hasStageDimensions() has been removed
  • ControlsConfig has been removed and replaced with the new Player description model - see Section 5 below for details. As a result VASTController.config.adsConfig.controlsConfig is no longer available
  • VASTController.enableNonLinearAdDisplay() has been replaced with VASTController.enableDisplayRegions()
  • The structure of the DisplayProperties class has been modified.

4. X

X