| 359 | | Being written |
| | 371 | OVA for Flowplayer can now be built using ant build scripts. The build scripts are located in the `build` directory of the distribution package. |
| | 372 | |
| | 373 | The OVA for Flowplayer SWF can be built using either one of two approaches: |
| | 374 | |
| | 375 | * Using the pre-built OVA SWF located in the distribution `lib` directory or |
| | 376 | * Using the local source tree of an installed OVA for AS3 package |
| | 377 | |
| | 378 | In either case, to build OVA for Flowplayer use the following command from the OVA for Flowplayer `build` directory: |
| | 379 | |
| | 380 | {{{ |
| | 381 | ant <command> |
| | 382 | }}} |
| | 383 | |
| | 384 | where `command` can be any one of the following instructions: |
| | 385 | |
| | 386 | * `help` - lists all available build commands |
| | 387 | * `build` - the default build that includes the standard OVA plugin related debug output - equivalent to the `build-debug` instruction |
| | 388 | * `build-debug` - the standard OVA build which results in OVA plugin related debug output being available |
| | 389 | * `build-release` - a reduced OVA build that excludes the plugin related debug output calls |
| | 390 | * `build-local` - the default local build - equivalent to `build-local-debug` |
| | 391 | * `build-local-debug` - the standard OVA build that includes the OVA plugin related debug output calls - built via a local version of the OVA for AS3 source tree |
| | 392 | * `build-local-release` - the reduced OVA "local" build that excludes the OVA plugin related debug output calls |
| | 393 | |
| | 394 | The following table illustrates the difference in size between various forms of the OVA SWC and the OVA for Flowplayer plugin build: |
| | 395 | |
| | 396 | ||=OVA FOR FLOWPLAYER BUILD TYPE =||=OVA SWC "DEBUG" =||=OVA SWC "RELEASE" =||=OVA SWC "MINIMAL" =|| |
| | 397 | || build-debug || 221K (default) || N/A || N/A || |
| | 398 | || build-release || 215K || 197K || 188K || |
| | 399 | |
| | 400 | ==== 4.4.1 Customising the Build Properties ==== |
| | 401 | |
| | 402 | Before OVA for Flowplayer (or any OVA product) can be built, a number of environmental variables need to be set in the `build.properties` file that is located in the distribution `build directory. |
| | 403 | |
| | 404 | For OVA for Flowplayer, the `FLEX_DIR` variable is the only mandatory entry that needs to be set. It must point to the base directory of your Flex SDK install so that the compilers etc. can be located by the OVA build scripts. |
| | 405 | |
| | 406 | {{{ |
| | 407 | FLEX_DIR = /Applications/flex_sdk_3 |
| | 408 | }}} |
| | 409 | |
| | 410 | If you intend to build against the OVA for AS3 source tree rather than the pre-build OVA for AS3 SWC, you will also need to set the location of the OVA for AS3 package in your workspace if that package is not co-located with the OVA for Flowplayer distribution. |
| | 411 | |
| | 412 | {{{ |
| | 413 | OVA_AS3_BUILD_DIR = ../../ova.as3 |
| | 414 | }}} |
| | 415 | |
| | 416 | ==== 4.4.2 Using the Pre-Built OVA SWC ==== |
| | 417 | |
| | 418 | By default, the OVA for Flowplayer distribution includes a pre-built version of the OVA for AS3 SWC. This SWC is the standard OVA for AS3 SWC that includes the OVA debug output and methods. |
| | 419 | |
| | 420 | If you wish to use the `build`, `build-debug` or `build-release` ant commands to build a version of the OVA for JW5 plugin against a "release" or "minimal" OVA for AS3 SWC, then the OVA for AS3 SWC must be pre-build and "deployed" as per the OVA for AS3 build instructions above in section 4.2. |
| | 421 | |
| | 422 | Note: You cannot build a "debug" version of the OVA for Flowplayer plugin with a "release" or "minimal" version of the OVA SWC (or source tree) because the OVA for AS3 debug functions will not be available for use by the plugin source code. |
| | 423 | |
| | 424 | ==== 4.4.3 Using the Local OVA for AS3 Source Tree ==== |
| | 425 | |
| | 426 | It is possible to do a local "minimal" build of the OVA for Flowplayer plugin that configures a "minimal" version of the OVA for AS3 source tree. |
| | 427 | |
| | 428 | To build a minimal OVA for Flowplayer plugin: |
| | 429 | |
| | 430 | * Use `ant release` to build a "release" version of the plugin |
| | 431 | * Modify the `build.properties` file in the OVA for Flowplayer `build` directory to identify the library components to be excluded. |
| | 432 | |
| | 433 | By default, a "release" build of the plugin using the local OVA for AS3 source tree includes the buttons, callbacks and ad server connectors. To exclude all of these, the following variables should be set in the OVA for JW5 `build.properties` file: |
| | 434 | |
| | 435 | {{{ |
| | 436 | INCLUDE_CONNECTORS = false |
| | 437 | INCLUDE_CALLBACKS = false |
| | 438 | INCLUDE_BUTTONS = false |
| | 439 | }}} |