header_graphic
header_gradient
The ESA HD Media Player has been discontinued and is no longer available for sale or download. This page will remain active in support of existing customers.
:: Documentation :: HD Media Player

General File Descriptions For Default Player Packages:
* Asterisk symbol indicates new or altered v.4.0.1 feature

HTML:
index.html - sample web page showing how the default player swf should be embedded in a webpage using Object/Embed tags

PHP:
*share.php - sample web page showing how to set up dynamic metatags when sharing on Facebook

XML:
media.xml - sample playlist file with configuration settings
wizard.xml - sample playlist file without configuration settings (use with Skin Wizard)
crossdomain.xml - sample permissions file that allows you to transfer your swf and xml files across domains
captions.dxfp.xml - sample external captions xml file for the CCForFlash component

SWF:
default.swf - published player file that is ready for immediate use on a website (requires Flash Player 10 or later)

FLA:
default.fla - default player source file that can be opened and modified using Flash CS4/CS5 (includes compiled components)
Controller.fla - controller component source file (Flash Pro Package only)
MediaPlayer.fla - media player component source file (Flash Pro Package only)
Playlist.fla - playlist component source file (Flash Pro Package only)

AS:
Controller.as - controller component action script source file (Flash Pro Package only)
MediaPlayer.as - media player component action script source file (Flash Pro Package only)
Playlist.as - playlist component action script source file (Flash Pro Package only)
PlaylistCellRenderer.as - playlist component cell renderer action script source file (Flash Pro Package only)

MXP:
ESAMediaPlayer.mxp - Macromedia Extension Package that can be installed into your Flash CS4/CS5 component menu

dd

Basic use of the Default HD Media Player files WITH the Skin Wizard (link to Skin Wizard):

  1. Upload the default.swf file to your server along with the videos, audio tracks, images, and caption files that you wish to display.
  2. Enter the path to the default.swf on your server into the Skin Wizard's "Player SWF" field
  3. If you are loading a single media file enter the path to your media file into the Skin Wizard's "Media" field and skip to step 4 below. If you are using the XML playlist, you should modify the sample wizard.xml playlist file to refer to your own content and upload it to your server; then enter the path for the playlist file into the Skin Wizard's "XML Playlist" field. See the "Working with the XML playlist" section below for more details. You also need to modify the crossdomain.xml file to refer to your own domain (e.g. open the file and replace the text that reads "YOUR_DOMAIN"), then upload it to the root of your domain (e.g. the path to the modified crossdomain file on your server should look like: http://www.yoursite.com/crossdomain.xml).
  4. Choose the rest of your player options in the Skin Wizard and press the "Preview Player & Embed Code" button to test your custom player and content. If everything is working properly, press the "Copy Embed Code to Clipboard" button and paste the embed code into your web page wherever you want the player to appear.
  5. You can also press the "Copy Settings URL To Clipboard" button if you want to save your settings for later use (this will produce a url that you can use to revisit the Skin Wizard and reload your settings)

Basic use of the Default HD Media Player files WITHOUT the Skin Wizard:

  1. Upload the following example files and folders to the same location on your server:
    default.swf
    index.html (or use share.php for dynamic metatags on Facebook)
    media.xml
  2. Once the HD Media Player is up and running, you can alter the size of the player using the width and height attributes in the html embed code. See the "Adding the default HD media player to your webpage" secion below for more details.
  3. Edit the "media.xml" file to begin playing your own content, and to change the playback behaviors (e.g. autoplay, looping, random, link target, bandwidth test, etc.). See the "Working with the XML playlist" section below for more details.
  4. Edit the "media" FlashVars in the "index.html" file to load a different XML or single audio/video file. See the "Working with FlashVars " section below for more details.
  5. You can open the "default.fla" to change the layout and other properties of the HD Media player and publish a new SWF. See the "Modify the default HD Media Player... " section below for more details.
  6. You can install the "ESAMediaPlayer.mxp" file to add the HD Media player components to your Flash CS4/CS5 Component Menu, which makes it easier to access for future projects. See the "Install and use the MXP..." section below for more details.

dd

Adding the default HD Media Player to your webpage:

To add the published HD Media Player (default.swf) to your webpage you must add the player's embed code to your web document wherever you want the player to appear.

  • Sample embed code when NOT using the Skin Wizard: Please note that the swf path (red text), Flash player size (gray text), and media path (dark blue text; path can refer to a single audio/video file or XML playlist) are specified in two places; and you can alter these variables to meet your needs. Since the default player includes autoresizing scripts (starting with v.1.5.3), you can set the width equal to your desired media width in pixels, and set the height equal to your desired media height in pixels plus the height of the controls (default controller height is 30 pixels). For example, if you want to play videos at 320 x 240, then you would set the "width=320" and "height=270"). The minimum width for the default skin is 320 pixels.

    <object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=10,0,0,0"
    width="640" height="390" id="ESAHDMP" >
    <
    param name="movie" value="default.swf" />
    <param name="allowfullscreen" value="true"/>
    <param name="allowscriptaccess" value="always"/>
    <
    param name="FlashVars" value="media=media.xml" />
    <param name="wmode" value="transparent" />
    <embed
    src="default.swf" width="640" height="390" FlashVars="media=media.xml" allowfullscreen="true" allowscriptaccess="always" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" wmode="transparent" name="ESAHDMP"/>
    </object>

  • Sample embed code generated by the Skin Wizard: The Skin Wizard is used to build custom embed codes, which should not be modified outside of the Skin Wizard.

    <object classid="clsid:d27cdb6e-ae6d-11cf-96b8-444553540000" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=10,0,0,0" width="640" height="390" id="ESAHDMP" >
    <param name="movie" value="http://www.thegospelbeat.net/esa/default.swf" />
    <param name="allowfullscreen" value="true"/>
    <param name="allowscriptaccess" value="always"/>
    <param name="FlashVars" value="wizard=640,360, 2,30,2,0,3,0,1,1,1,1,0,0,3,3,0,5,1,0,3,0,1,0,30,24,6,24,0,, bbbbbb,000000,000000,ffffff,777777,ffffff,777777,ffffff,666666,717388,000000,999999,990000,006600, 006600,006600,ffffff,006600,000000,,,,,, http://www.thegospelbeat.net/esa/wizard.xml,http://www.thegospelbeat.net/esa/default.swf,ESAHDMP,0,0" />
    <param name="wmode" value="transparent" />
    <embed src="http://www.thegospelbeat.net/esa/default.swf" width="640" height="390" FlashVars="wizard=640,360, 2,30,2,0,3,0,1,1,1,1,0,0,3,3,0,5,1,0,3,0,1,0,30,24,6,24,0,, bbbbbb,000000,000000,ffffff,777777,ffffff,777777,ffffff,666666,717388,000000,999999,990000,006600, 006600,006600,ffffff,006600,000000,,,,,, http://www.thegospelbeat.net/esa/wizard.xml,http://www.thegospelbeat.net/esa/default.swf,ESAHDMP,0,0" allowfullscreen="true" allowscriptaccess="always" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" wmode="transparent" name="ESAHDMP"/>
    </object>

dd

Modify the default HD Media Player FLA and publish a new SWF file:

  • Using your Flash CS4/CS5 authoring software, open the "default.fla" file.
  • Move the MediaPlayer component around the stage by selecting it on the stage and dragging it to a new location, or you can use the Properties Inspector to accurately position the component using x and y coordinates (use the same approach for the Playlist and Controller components). You should always use integers for the x and y coordinates to avoid cutting pixels.
  • Change the size of the MediaPlayer component by selecting it on the stage, then open the Properties Inspector and type in your desired dimensions (use the same approach for the Playlist and Controller components). You should always use even numbered integers for the width and height values to avoid cutting pixels. Please note: the default player includes autoresizing scripts (starting with v.1.5.3), so you don't have to alter the dimensions in Flash unless you want to change the layout (see the previous section for more details).
  • If you have altered the size or location of any of the components on the stage you will also need to modify a small amount of action script in the actions panel (scene 1: frame 1). The code you need to modify is the "arrangeItemsOnStage" function (for v.1.5.3 or later) or the "fullscreen" event listener/handler (v.1.0.1 - v.1.4.2), both of which are used to arrange all items on the stage whenever the stage size is redefined (e.g. when you enter/exit fullscreen). You will need to modify the coordinates and dimensions so they reflect the changes you have made on the stage.
  • Modify the media player settings and behaviors (see Table 2 below for options) by selecting it on the stage, then open the Component Inspector to access the list of configurable parameters (use the same approach for the Playlist and Controller components).
  • Once you have finished modifying the component, resize the stage background to fit your modified player, and save your project.
  • Publish or Export your new SWF file. Please note: you should not attemp to use the Skin Wizard with customized player SWF files.

dd

Install and use the MXP in your Flash CS4/CS5 Authoring Software:

  • Before installing the MXP file, shut down your Flash CS4/CS5 authoring software if it is open.
  • Double click the file named "ESAMediaPlayer.mxp" on your desktop. This will open the Extension Manager, which will prompt you to complete your installation.
  • Open your copy of Flash CS4/CS5 and create a new document.
  • Open the Components Panel and look for a folder named "ESA Media Player ". In this folder, there will be three components named MediaPlayer, Playlist, and Controller.
  • Add an instance of the MediaPlayer component to the stage and give it an instance name of "myMediaPlayer". Use the same approach to add the Playlist (give it the instance name "myPlaylist") and Controller (give it the instance name "myController") components to the stage, and make sure to reference "myMediaPlayer" in the Playlist and Controller component inspector's "playerInstance" parameter fields.
  • Move the MediaPlayer component around the stage by selecting it on the stage and dragging it to a new location, or you can use the Properties Inspector to accurately position the component using x and y coordinates (use the same approach for the Playlist and Controller components). You should always use integers for the x and y coordinates to avoid cutting pixels.
  • Change the size of the MediaPlayer component by selecting it on the stage, then open the Properties Inspector and type in your desired dimensions (use the same approach to resize the Playlist and Controller components). You should always use even numbered integers for the width and height values to avoid cutting pixels.
  • Modify the MediaPlayer settings and behaviors (see Table 2 below for options) by selecting it on the stage, then open the Component Inspector to access the list of configurable parameters (use the same approach to configure the Playlist and Controller components).
  • Once you have finished modifying the component(s), resize the stage background to fit your modified media player, and save your project.
  • Publish or Export your new SWF file. Please note: you should not attemp to use the Skin Wizard with customized player SWF files.

dd

Modifying the component source files and compiling a new SWC file (Flash Pro Package Only):

  • Using your Flash CS4/CS5 authoring software, open the files named MediaPlayer.fla and MediaPlayer.as (located in the /source/ folder; not available in Demo version).
  • Alter the source files according to your own specifications, and save them.
  • In the MediaPlayer.fla file, right click the uncompiled MediaPlayer component in the ‘Library’, and export a new SWC file to the $flash/Components folder on your computer.
  • To get the new SWC to show up in the Component list within your Flash CS4/CS5 authoring software (in the Windows menu), you’ll either need to close and reopen Flash CS4/CS5, or you can use the “reload” button (open the components menu, click the small button just below the close button, and hit reload). Once the component list has been refreshed, you will double click the new MediaPlayer component to load it on the stage.
  • Use the same approach to create a new Playlist component (files associated with the Playlist component include: Playlist.fla, Playlist.as, and PlaylistCellRenderer.as - located in the /source/ folder; not available in the Demo version).
  • Use the same approach to create a new Controller component (files associated with the Controller component include: Controller.fla and Controller.as - located in the /source/ folder; not available in the Demo version).

Updating a component in an existing project:

  • First you have to get the new component to show up in the Components Menu within your Flash authoring software (in the Window Menu). If you have downloaded an update from our site, you should install the new MXP then open your existing project FLA (Flash CS4/CS5 must be closed when you install the MXP). If you have created your own SWC using the steps above, you either need to close and reopen Flash, or you can use the “reload” button (open the Components Menu, click the small button just below the close button, and hit reload).
  • Once the Component Menu has been refreshed, you will locate and double click the new component in the list to load it on the stage.
  • Flash will open a "Resolve Library Conflict" window, and ask if you want to replace the existing item in the library - toggle the "Replace existing items" button and click "OK".
  • You should now see 2 components on the stage; one in the same position as the original, and a new component near the middle of your screen.
  • Select the new component near the middle of your screen and delete it.
  • The remaining component on the stage is the updated component with your previous settings.
  • You can now modify the component parameters in the Component Inspector, save your project, and publish a new SWF.

dd

Table1. Default HD Media Player Skin with the MediaPlayer, Playlist, and Controller Components

 

Table2. Configurable Parameters that can be set for the MediaPlayer, Playlist, and Controller components using the Component Inspector in Flash CS4/CS5.

Description of each configurable parameter available within the MediaPlayer's Component Inspector:

- Brown text indicates key parameter
* Asterisk symbol indicates new or altered v.4.0.1 feature

  • bandwidthSource: Used to enable the automated bandwidth detection. You can use an absolute or relative "http" path to a JPEG image on your own web server that is ~100kb in size; or you can use the native FMS 3/4 bandwidth checker by using the "rtmp" path to the server and application. Leave this field blank if you do not want to perform the bandwidth test, or if you are specifying the bandwidth test location in the external XML file.
  • bgAlpha: Background transparency: 0 = transparent, 1=opaque.
  • bgColor: Background color.
  • bgFilter: Background filter. Options include: null, Glow, DropShadow.
  • bgFilterAlpha: Background filter transparency: 0 = transparent, 1=opaque.
  • bgFilterAngle: Background filter angle. DropShadow filter only.
  • bgFilterBlurX: Background horizontal filter blur. Ranges from 0-255.
  • bgFilterBlurY: Background vertical filter blur. Ranges from 0-255.
  • bgFilterColor: Background filter color.
  • bgFilterDistance: Background filter distance in pixels. DropShadow filter only.
  • bgFilterHide: Background filter hide (whether the object is hidder or not). DropShadow filter only.
  • bgFilterInner: Background filter location. True = inner, False = outer.
  • bgFilterKnockout: Background filter knockout effect (makes the object's fill transparent).
  • bgFilterQuality: Background filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • bgFilterStrength: Background filter strength (strength of imprint or spread). Ranges from 0-255.
  • bgOutlineAlpha: Background outline transparency: 0 = transparent, 1=opaque.
  • bgOutlineColor: Background outline color.
  • bgOutlinePixelHinting: Background outline pixel hinting: true, false.
  • bgOutlineWidth: Background outline width in pixels.
  • blankMediaSource: Path to blank media file that is used to attach a timeline to image files. This field is only required if you are using the player to display images instead of streaming media files. The blank file should be encoded in the FLV format without the video portion (encode blank audio portion only). See the section entitled "Converting your media files..." below for links to sample blank files (10 sec, 1 minute, 10 minute). Leave this field blank if you are specifying the blankMedia location in the external XML file.
  • btnAlpha1: Button gradient transparency for point 1: 0 = transparent, 1=opaque.
  • btnAlpha2: Button gradient transparency for point 2: 0 = transparent, 1=opaque.
  • btnAlphaOver1: Button gradient transparency on mouse over for point 1: 0 = transparent, 1=opaque.
  • btnAlphaOver2: Button gradient transparency on mouse over for point 2: 0 = transparent, 1=opaque.
  • btnColor1: Button gradient color for point 1.
  • btnColor2: Button gradient color for point 2.
  • btnColorOver1: Button gradient color on mouse over for point 1.
  • btnColorOver2: Button gradient color on mouse over for point 2.
  • btnEllipseHeight: Play button vertical rounding effect: 0=square corners, >0=rounded corners.
  • btnEllipseWidth: Play button horizontal rounding effect: 0=square corners, >0=rounded corners.
  • btnEnable: Play button display options. Options include: always (displayed whenever media file is paused), never (disables this feature), first-frame (only displayed on first frame), last-frame (only displayed when paused on last frame), first-last-frame (only displayed on first frame and when paused on last frame). This parameter can also be set in the external XML file, which will override this component inspector setting.
  • btnFilter: Play button filter. Options include: null, Glow, DropShadow.
  • btnFilterAlpha: Play button filter transparency: 0 = transparent, 1=opaque.
  • btnFilterAngle: Play button filter angle. DropShadow filter only.
  • btnFilterBlurX: Play button horizontal filter blur. Ranges from 0-255.
  • btnFilterBlurY: Play button vertical filter blur . Ranges from 0-255.
  • btnFilterColor: Play button filter color.
  • btnFilterDistance: Play button filter distance in pixels. DropShadow filter only.
  • btnFilterHide: Play button filter hide (whether the object is hidder or not). DropShadow filter only.
  • btnFilterInner: Play button filter location. True = inner, False = outer.
  • btnFilterKnockout: Play button filter knockout effect (makes the object's fill transparent).
  • btnFilterQuality: Play button filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • btnFilterStrength: Play button filter strength (strength of imprint or spread). Ranges from 0-255.
  • btnGradientFocalPoint: Button gradient focal point: -1=shift to left, 0=center, 1=shift to right.
  • btnGradientRatio1: Button gradient color distribution ratio for point 1: 0-255.
  • btnGradientRatio2: Button gradient color distribution ratio for point 2: 0-255.
  • btnGradientRotation: Button gradient rotation in degrees: 0-180.
  • btnGradientType: Button gradient type: linear, radial.
  • btnHeight: Play button height in pixels. For best results use an even-number integer.
  • btnOutlineAlpha: Play button outline transparency: 0 = transparent, 1=opaque.
  • btnOutlineColor: Play button outline color.
  • btnOutlinePixelHinting: Button outline pixel hinting: true, false.
  • btnOutlineWidth: Play button outline width in pixels.
  • btnWidth: Play button width in pixels. For best results use an even-number integer.
  • captionEnable: Captions display options; true, false. When true and captions are available (requires CCForFlash component), they wil be displayed by default.
  • controlsEnable: Controls display options; true, false. When true and the controller component is available, it wil be displayed by default.
  • controlsHide: Controls autohide options. Options include: always (autohide in normal and fullscreen modes), fullscreen (autohides in fullscreen only), never (never autohides).
  • controlsHideDelay: Controls autohide delay in seconds. Determines how long the player will wait to hide the controls when there is no mouse activity.
  • debug: Troubleshooting degugger mode: true, false. When true and tested in Flash CS4/CS5, trace statements are dispatched when key events and errors occur. This variable also applies to the debugger for the Google Analytics component.
  • droppedFrameLimit: Max number of dropped frames allowed before the dynamic auto switching will occur; in order for this to work you must enable the dynamic auto switching and bandwidth detection, and you must define multiple bit rate options for the current media item in the XML.
  • dynamicAutoSwitch: Dynamic auto switching: true, false. In order for this to work you must enable the bandwidth detection, and you must define multiple bit rate options for the current media item in the XML. This parameter can also be set in the external XML file, which will override this component inspector setting.
  • dynamicBufferMax: Max number of buffer stops allowed before the dynamic auto switching will occur; in order for this to work you must enable the dynamic auto switching and bandwidth detection, and you must define multiple bit rate options for the current media item in the XML.
  • dynamicStreaming: Dynamic streaming: true, false. If "true" and the bandwidth detection is enabled and there are multiple bit rate options for the current media item in the XML and you are using FMS 3.5 or 4 to stream your media content, the player uses the "play2" method to seamlessly transition from one bit rate option to another (in all switching scenarios); otherwise the player will use the more traditional switching routine and the user will see a brief blank screen (streaming videos will start at the current time, progressive files will restart at time 0). This parameter can also be set in the external XML file, which will override this component inspector setting.
  • googleAccount: Google Analytics account number. You must set up a Google Analytics account to use this feature.
  • googleTracking: Google Analytics Tracking. Options include: file (tracks filename), id (tracks id attributes in xml), name (tracks name attributes in XML).
  • imageEnable: Image display options. Options include: always (displayed for the duration of the media file), never (disables this feature), first-frame (only displayed on first frame), last-frame (only displayed on last frame), first-last-frame (only displayed on first and last frames). This setting is automatically set to "always" when audio-only tracks are loaded. This parameter can also be set in the external XML file, which will override this component inspector setting.
  • imageSource: Path to image that can serve as a preloader, pause image, or in support of an audio-only track. The image should be located on your own web server. Leave this field blank if you do not want to display an image, or if you are specifying the image location in the external XML file.
  • keyFrameInterval: Key frame interval of streaming media content; used by seek features.
  • mediaAutoPlay: Autoplay options that determine how the player will respond to newly loaded media. Options include: Yes-always (always autoplays), No-always (always pauses on first frame), Yes-on first video (autoplays first media file, pauses on first frame of remaining media files), No-on first video (pauses on first frame of first media file, autoplays remaining media files). This parameter can also be set in the external XML file, which will override this component inspector setting.
  • mediaBuffer: Buffer time in seconds (amount of media that must be loaded before it begins to play). Should be several seconds for streaming/progressive media, and 1-second for live streams.
  • mediaBufferPause: Maximum amount of buffer while streaming files are paused (saves bandwidth). Should be >= mediaBuffer.
  • mediaLink: URL where users will be directed if they click the player screen. Leave this field blank if you do not want the screen to be clickable, or if you are specifying the link in the external XML file.
  • mediaLinkTarget: Target for media link. Options include: _self, _blank, _parent, _top. This parameter can also be set in the external XML file, which will override this component inspector setting.
  • mediaLooping: Looping options that determine how the player will respond when it reaches the end of a media file. Options include: continuous (moves onto next media file), singleFile (loops through current media file), oneTime (loops through playlist once), endStop (stops on last frame of current media file). This parameter can also be set in the external XML file, which will override this component inspector setting.
  • mediaPreloading: Preloading option determines if the current media file is automatically loaded, or if the Play button must be pressed to load the current media item. Options include: Yes-always (always preloads), No-always (preloading always disabled), Yes-on first video (preloads first media file, preloading disabled for all others), No-on first video (preloading disabled on first media item, preloads all others). This parameter can also be set in the external XML file, which will override this component inspector setting.
  • mediaRandom: Random playback options include (only work with XML): Yes-always (random always enabled), No-always (random always disabled), Yes-on first video (randomly enabled for first media file, disabled for all others), No-on first video (plays first video in playlist, then random is enabled). This parameter can also be set in the external XML file, which will override this component inspector setting.
  • mediaSmoothing: Smoothing option that prevents pixilation when video files are scaled (true). This option is critical when using the fullscreen option, but it does put a greater demand on the user's CPU. This parameter can also be set in the external XML file, which will override this component inspector setting.
  • mediaSource: Path to audio, video, or XML file that will be loaded into the player by default. Leave this field blank if you are using FlashVars to specify the path to the default media.
  • mediaSourceInstance: Determines if the first instance in a rtmp path should be attributed to the application or stream name. The options are "application" and "stream". For example: if your rtmp path is rtmp://www.server.com/application/instance/stream, and /instance/ is part of the stream name choose "stream"; or if /instance/ is part of the application name choose "application".
  • *mediaDescription: Brief description of media file that can be displayed when sharing media content on Facebook and Twitter. This parameter can also be set in the XML for each media file using the "desc" attribute.
  • *mediaTitle: Title of media file that is displayed as a message on the screen or when sharing media content on Facebook and Twitter. Set "messageMouseOver" to "title" if you want the mediaTitle to be displayed on mouse over. This parameter can also be set in the XML for each media file using the "name" attribute.
  • messageBandwidth: Text string that will be displayed while the player detects the user's bandwidth.
  • messageBuffer: Text string that will be displayed while the player buffers a media file.
  • messageColor: Text color for message strings.
  • messageFilter: Message filter. Options include: null, Glow, DropShadow.
  • messageFilterAlpha: Message filter transparency: 0 = transparent, 1=opaque.
  • messageFilterAngle: Message filter angle. DropShadow filter only.
  • messageFilterBlurX: Message horizontal filter blur. Ranges from 0-255.
  • messageFilterBlurY: Message vertical filter blur. Ranges from 0-255.
  • messageFilterColor: Message filter color.
  • messageFilterDistance: Message filter distance in pixels. DropShadow filter only.
  • messageFilterHide: Message filter hide (whether the object is hidder or not). DropShadow filter only.
  • messageFilterInner: Message filter location. True = inner, False = outer.
  • messageFilterKnockout: Message filter knockout effect (makes the object's fill transparent).
  • messageFilterQuality: Message filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • messageFilterStrength: Message filter strength (strength of imprint or spread). Ranges from 0-255.
  • messageFont: Message font options.
  • messageLoading: Text string that will be displayed while the player loads a media file.
  • messageMouseOver: Text string that will be displayed when a user mouses over the player. Set to "title" if you want the mediaTitle (or "name" from the xml; or "title" flashvars) to be displayed on mouse over.
  • *messagePlaying: Text string that will be displayed when media items are playing. Set to "title" if you want the mediaTitle (or "name" from the xml; or "title" flashvars) to be displayed while the associated file plays.
  • messageRoll: Text string that will be displayed during prerolls.
  • messageSize: Message size in normal mode.
  • messageSizeFS: Message size in fullscreen mode.
  • messageStyle: Message style: italic or normal.
  • messageSwitch: Text string that will be displayed while the player switched to a different bit rate.
  • messageWeight: Message weight: bold or normal.
  • messageX: X-location of messge strings relative to upper-left corner of player.
  • messageY: Y-location of message strings relative to upper-left corner of player.
  • overlayAlign: Overlay alignment options: right, left, center, external. If 'external', you must use the 'overlayExternalX' and 'overlayExternalY' coordinates to position the overlay feature (in fullscreen the placement is assumed to be lower right, so if you don't want the overlay to appear set the 'overlayYFS' to a high number like 10000, so it is moved outside of the viewable area).
  • overlayAlpha: Overlay transparency: 0 = transparent, 1=opaque.
  • overlayBG: Overlay background: true, false.
  • overlayBgColor: Overlay background color.
  • overlayBgPadding: Overlay background padding determines the distance from the edge of the player in pixels (repositions the overlay both horizontally and vertically to fit within the player with the specified padding). Should be an integer value.
  • overlayBorder: Overlay border: true, false.
  • overlayBorderColor: Overlay border color.
  • overlayEnable: Enable overlays: true, false. This feature requires the external XML file, and is always positioned at the bottom of the player unless 'overlayAlign = external'.
  • overlayExternalX: Overlay X-location (from top left of MediaPlayer component) ) in normal mode when 'overlayAlign = external'.
  • overlayExternalY: Overlay Y-location (from top left of MediaPlayer component) in normal mode when 'overlayAlign = external'.
  • overlayFilter: Overlay filter. Options include: null, Glow, DropShadow.
  • overlayFilterAlpha: Overlay filter transparency: 0 = transparent, 1=opaque.
  • overlayFilterAngle: Overlay filter angle. DropShadow filter only.
  • overlayFilterBlurX: Overlay horizontal filter blur. Ranges from 0-255.
  • overlayFilterBlurY: Overlay vertical filter blur . Ranges from 0-255.
  • overlayFilterColor: Overlay filter color.
  • overlayFilterDistance: Overlay filter distance in pixels. DropShadow filter only.
  • overlayFilterHide: Overlay filter hide (whether the object is hidder or not). DropShadow filter only.
  • overlayFilterInner: Overlay filter location. True = inner, False = outer.
  • overlayFilterKnockout: Overlay filter knockout effect (makes the object's fill transparent).
  • overlayFilterQuality: Overlay filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • overlayFilterStrength: Overlay filter strength (strength of imprint or spread). Ranges from 0-255.
  • overlayHeight: Overlay height in pixels.
  • overlayWidth: Overlay width in pixels.
  • overlayYFS: Overlay Y-location (from bottom) in fullscreen. This value is added to the overlayHeight and overlayBgPadding values, and subtracted from the height of the user's monitor, so the overlay will stay at the bottom of the player, but it can be pushed up to avoid the controller component.
  • playlistEnable: Playlist display options; true, false. When true and the playlist component is available, it wil be displayed by default.
  • randomPlay: this option has been deprecated - see "mediaRandom" for latest options
  • style1_align: Text alignment (left, right, center) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_color: Text color setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_decoration: Text decoration (underline, none) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_font: Text font setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_leading: Text leading (pixels) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_marginL: Text left margin (pixels) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_marginR: Text right margin (pixels) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_size: Text size (pixels) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_style: Text style (italic, none) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style1_weight: Text weight (bold, none) setting for the html <span class='mpStyle1'> tags specified in the <overlay> node of the external XML file.
  • style2_align: Text alignment (left, right, center) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_color: Text color setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_decoration: Text decoration (underline, none) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_font: Text font setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_leading: Text leading (pixels) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_marginL: Text left margin (pixels) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_marginR: Text right margin (pixels) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_size: Text size (pixels) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_style: Text style (italic, none) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style2_weight: Text weight (bold, none) setting for the html <span class='mpStyle2'> tags specified in the <overlay> node of the external XML file.
  • style3_align: Text alignment (left, right, center) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_color: Text color setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_decoration: Text decoration (underline, none) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_font: Text font setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_leading: Text leading (pixels) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_marginL: Text left margin (pixels) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_marginR: Text right margin (pixels) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_size: Text size (pixels) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_style: Text style (italic, none) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • style3_weight: Text weight (bold, none) setting for the html <span class='mpStyle3'> tags specified in the <overlay> node of the external XML file.
  • styleA_color: Text color setting for the html <a href='' > tags specified in the <overlay> node of the external XML file.
  • styleA_decoration: Text decoration (underline, none) setting for the html <a href=''> tags specified in the <overlay> node of the external XML file.
  • symbolAlpha: Play symbol transparency: 0 = transparent, 1=opaque.
  • symbolColor: Play symbol color.
  • symbolHeight: Play symbol height in pixels.
  • symbolWidth: Play symbol width in pixels.
  • timeout: Timeout (milliseconds) for loading/playing live rtmp streams. If the player is unable to connect to the live stream for this amount of time an event (streamTimeout) is triggered (can be expanded using our API to switch to a prerecorded file or VOD).
  • timerDelay: Timer delay for all Media Player components in milliseconds. The lower this number the faster the player updates features like the current playtime, scrubber location, messages, overlays, volume, etc., and the more demand that is put on the user's CPU. Ideal values are between 100-250.

 

Description of each configurable parameter available within the Playlist's Component Inspector:

- Brown text indicates key parameter

  • bgAlpha1: Background gradient transparency for point 1: 0 = transparent, 1=opaque.
  • bgAlpha2: Background gradient transparency for point 2: 0 = transparent, 1=opaque.
  • bgColor1: Background gradient color for point 1.
  • bgColor2: Background gradient color for point 2 (set equal to bgColor1 for solid color).
  • bgEllipseHeight: Background vertical rounding effect: 0=square corners, >0=rounded corners.
  • bgEllipseWidth: Background horizontal rounding effect: 0=square corners, >0=rounded corners.
  • bgFilter: Background filter. Options include: null, Glow, DropShadow.
  • bgFilterAlpha: Background filter transparency: 0 = transparent, 1=opaque.
  • bgFilterAngle: Background filter angle. DropShadow filter only.
  • bgFilterBlurX: Background horizontal filter blur. Ranges from 0-255.
  • bgFilterBlurY: Background vertical filter blur. Ranges from 0-255.
  • bgFilterColor: Background filter color.
  • bgFilterDistance: Background filter distance in pixels. DropShadow filter only.
  • bgFilterHide: Background filter hide (whether the object is hidder or not). DropShadow filter only.
  • bgFilterInner: Background filter location. True = inner, False = outer.
  • bgFilterKnockout: Background filter knockout effect (makes the object's fill transparent).
  • bgFilterQuality: Background filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • bgFilterStrength: Background filter strength (strength of imprint or spread). Ranges from 0-255.
  • bgGradientFocalPoint: Background gradient focal point: -1=shift to left, 0=center, 1=shift to right.
  • bgGradientRatio1: Background gradient color distribution ratio for point 1: 0-255.
  • bgGradientRatio2: Background gradient color distribution ratio for point 2: 0-255.
  • bgGradientRotation: Background gradient rotation in degrees: 0-180.
  • bgGradientType: Background gradient type: linear, radial.
  • bgOutlineAlpha: Background outline transparency: 0 = transparent, 1=opaque.
  • bgOutlineColor: Background outline color.
  • bgOutlinePixelHinting: Background outline pixel hinting: true, false.
  • bgOutlineWidth: Background outline width in pixels.
  • categoryAlpha: Category ComboBox and DropDown List transparency: 0 = transparent, 1=opaque
  • categoryBorderColor: Border color for Category ComboBox and DropDown List.
  • categoryButtonColorOver: Category button color on mouseover.
  • categoryButtonColorUp: Category button color
  • categoryButtonWidth: Category button width in pixels
  • categoryCellDownAlpha: Category cell transparency when pressed: 0 = transparent, 1=opaque
  • categoryCellDownColor: Category cell color when pressed.
  • categoryCellOverAlpha: Category cell transparency on mouseover: 0 = transparent, 1=opaque
  • categoryCellOverColor: Category cell color on mouseover.
  • categoryCellSelectedAlpha: Category cell transparency when selected: 0 = transparent, 1=opaque
  • categoryCellSelectedColor: Category cell color when selected.
  • categoryCellUpAlpha: Category cell transparency: 0 = transparent, 1=opaque
  • categoryCellUpColor: Category cell color.
  • categoryEnable: Enable category pulldown menu and keyword search feature: true, false. This feature requires the external XML file.
  • categoryHeight: Height of Category ComboBox and Button in pixels.
  • categoryListTextAlign: Text alignment (left, right, center) setting for the text in the Category pull-down list.
  • categoryListTextBold: Text bold (true, false) setting for the text in the Category pull-down list.
  • categoryListTextColor: Text color setting for the text in the Category pull-down list.
  • categoryListTextFont: Text font setting for the text in the Category pull-down list.
  • categoryListTextSize: Text size setting for the text in the Category pull-down list.
  • categoryListWidth: Width of Category pull-down menu in pixels. The width of the category and search feature is set separately using the 'categoryWidth' parameter.
  • categoryPrompt: Text string that is displayed in the category feature by default.
  • categoryRowMax: Max number of rows to display in the category pull-down menu (if the number of categories exceeds this limit a scroll bar is automatically used)
  • categorySymbolColor: Category button symbol color (down arrow).
  • categoryTextAlign: Text alignment (left, right, center) setting for
  • categoryTextBgColor: Background color for the Category "prompt" text.
  • categoryTextBold: Text bold (true, false) setting for the Category "prompt" text.
  • categoryTextColor: Text color setting for the Category "prompt" text.
  • categoryTextFont: Text font setting for the Category "prompt" text.
  • categoryTextPadding: Text padding determines the distance from the edge of the field in pixels for the Category "prompt" text. Should be an integer value.
  • categoryTextSize: Text size setting for the Category "prompt" text.
  • categoryWidth: Width of Category ComboBox and Button in pixels. The width of the pull-down menu is set separately using the 'categoryListWidth' parameter.
  • categoryX: Category X-location in pixels (from top left of background).
  • categoryY: Category Y-location in pixels (from top left of background).
  • cellDownAlpha: Category pull-down list cell transparency while pressed down with mouse: 0 = transparent, 1=opaque.
  • cellDownColor: Cell color while pressed down with mouse.
  • cellFilter: Category pull-down list cell background filter. Options include: null, Bevel.
  • cellFilterColor1: Category pull-down list cell background filter color 1 (top & left).
  • cellFilterColor2: Category pull-down list cell background filter color 2 (bottom & right).
  • cellOverAlpha: Category pull-down list cell transparency when moused over: 0 = transparent, 1=opaque.
  • cellOverColor: Category pull-down list cell color when moused over.
  • cellSelectedAlpha: Category pull-down list cell transparency when selected: 0 = transparent, 1=opaque.
  • cellSelectedColor: Category pull-down list cell color when selected.
  • cellUpAlpha: Category pull-down list default cell transparency: 0 = transparent, 1=opaque.
  • cellUpColor: Category pull-down list default cell color.
  • columnCount: Number of columns to display.
  • columnWidth: Width of columns in pixels.
  • disabledAlpha: Transparency when disabled during prerolls: 0 = transparent, 1=opaque.
  • imageAlign: Thumbnail image alignment. Options include: left, right, center.
  • imageCache: Thumbnail image caching. Options include: true, false. When "true" thumbnails are cached once they are viewed to prevent further rendering delays upon scrolling. Should be "false" with long playlists to prevent memory overload (>100 items).
  • imageHeight: Height of thumbnail image in pixels.
  • imagePadding: Image padding determines the distance from the edge of the cell in pixels (resizes the image both horizontally and vertically to fit within the cell with the specified padding). Should be an integer value.
  • imageWidth: Width of thumbnail image in pixels.
  • playerInstance: Instance name that you assigned to the MediaPlayer component on the stage. This parameter must be defined.
  • playlistX: Playlist X-location in pixels (from top left of background).
  • playlistY: Playlist Y-location in pixels (from top left of background).
  • rowCount: Number of rows to display.
  • rowHeight: Height of rows in pixels.
  • scrollAlpha: Scrollbar transparency: 0 = transparent, 1=opaque.
  • scrollBarDirection: Orientation of scroll bar: horizontal or vertical.
  • scrollBorderColor: Color of scrollbar border.
  • scrollButtonColorOver: Color scrollbar up/down buttons.
  • scrollButtonColorUp: Color of scrollbar up/down buttons on mouseover.
  • scrollPolicy: Determines if scroll bar is visible.
  • scrollSliderColorOver: Color of scrollbar thumb slider.
  • scrollSliderColorUp: Color of scrollbar thumb slider on mouseover.
  • scrollSymbolColor: Color of scrollbar up/down button arrows.
  • scrollTrackColor: Color of scrollbar track.
  • style1_align: Description text alignment (left, right, center) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_color: Description text color setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_decoration: Description text decoration (underline, none) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_font: Description text font setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_leading: Description text leading (pixels) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_marginL: Description text left margin (pixels) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_marginR: Description text right margin (pixels) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_size: Description text size (pixels) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_style: Description text style (italic, none) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style1_weight: Description text weight (bold, none) setting for the html <span class='plStyle1'> tags specified in the <playlist> node of the external XML file.
  • style2_align: Description text alignment (left, right, center) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_color: Description text color setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_decoration: Description text decoration (underline, none) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_font: Description text font setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_leading: Description text leading (pixels) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_marginL: Description text left margin (pixels) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_marginR: Description text right margin (pixels) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_size: Description text size (pixels) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_style: Description text style (italic, none) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style2_weight: Description text weight (bold, none) setting for the html <span class='plStyle2'> tags specified in the <playlist> node of the external XML file.
  • style3_align: Description text alignment (left, right, center) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_color: Description text color setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_decoration: Description text decoration (underline, none) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_font: Description text font setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_leading: Description text leading (pixels) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_marginL: Description text left margin (pixels) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_marginR: Description text right margin (pixels) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_size: Description text size (pixels) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_style: Description text style (italic, none) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • style3_weight: Description text weight (bold, none) setting for the html <span class='plStyle3'> tags specified in the <playlist> node of the external XML file.
  • textAlpha: Description text transparency: 0 = transparent, 1=opaque.
  • textBG: Description text background: true, false.
  • textBgColor: Description text background color.
  • textBgPadding: Description text background padding determines the distance from the edge of the cell in pixels (resizes the text background both horizontally and vertically to fit within the cell with the specified padding). Should be an integer value.
  • textBorder: Description text border: true, false.
  • textBorderColor: Description text border color.
  • textEnable: Enable description text. Options include: always, rollover.
  • textFilter: Description text filter. Options include: null, Glow, DropShadow.
  • textFilterAlpha: Description text filter transparency: 0 = transparent, 1=opaque.
  • textFilterAngle: Description text filter angle. DropShadow filter only.
  • textFilterBlurX: Description text horizontal filter blur. Ranges from 0-255.
  • textFilterBlurY: Description text vertical filter blur . Ranges from 0-255.
  • textFilterColor: Description text filter color.
  • textFilterDistance: Description text filter distance in pixels. DropShadow filter only.
  • textFilterHide: Description text filter hide (whether the object is hidder or not). DropShadow filter only.
  • textFilterInner: Description text filter location. True = inner, False = outer.
  • textFilterKnockout: Description text filter knockout effect (makes the object's fill transparent).
  • textFilterQuality: Description text filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • textFilterStrength: Description text filter strength (strength of imprint or spread). Ranges from 0-255.
  • textOrder: Description text Z-order (on top or below thumbnail). Options include: top, bottom.

 

Description of each configurable parameter available within the Controller's Component Inspector:

- Brown text indicates key parameter
* Asterisk symbol indicates new or altered v.4.0.1 feature

  • barAlpha: Bar transparency for progress and volume bars.
  • barColor1: Color of bar 1 on progress and volume bars.
  • barColor2: Color of bar 2 on progress and volume bars.
  • barColor3: Color of bar 3 on progress bar.
  • barEllipseHeight: Bar vertical rounding effect: 0=square corners, >0=rounded corners.
  • barEllipseWidth: Bar horizontal rounding effect: 0=square corners, >0=rounded corners.
  • barHeight: Bar height in pixels. For best results use an even-numberer integer.
  • barOutlineAlpha: Outline transparency for progress and volume bars.
  • barOutlineColor: Outline color for progress and volume bars.
  • barOutlineWidth: Outline width in pixels for progress and volume bars.
  • barOutlinePixelHinting: Outline pixel hinting for progress and volume bars: true, false.
  • barYoffset: Offset in Y-direction for progress and volume bars in pixels: positive numbers move bars up.
  • bgAlpha1: Background gradient transparency for point 1: 0 = transparent, 1=opaque.
  • bgAlpha2: Background gradient transparency for point 2: 0 = transparent, 1=opaque.
  • bgColor1: Background gradient color for point 1.
  • bgColor2: Background gradient color for point 2 (set equal to bgColor1 for solid color).
  • bgEllipseHeight: Background vertical rounding effect: 0=square corners, >0=rounded corners.
  • bgEllipseWidth: Background horizontal rounding effect: 0=square corners, >0=rounded corners.
  • bgFilter: Background filter. Options include: null, Glow, DropShadow.
  • bgFilterAlpha: Background filter transparency: 0 = transparent, 1=opaque.
  • bgFilterAngle: Background filter angle. DropShadow filter only.
  • bgFilterBlurX: Background horizontal filter blur. Ranges from 0-255.
  • bgFilterBlurY: Background vertical filter blur. Ranges from 0-255.
  • bgFilterColor: Background filter color.
  • bgFilterDistance: Background filter distance in pixels. DropShadow filter only.
  • bgFilterHide: Background filter hide (whether the object is hidder or not). DropShadow filter only.
  • bgFilterInner: Background filter location. True = inner, False = outer.
  • bgFilterKnockout: Background filter knockout effect (makes the object's fill transparent).
  • bgFilterQuality: Background filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • bgFilterStrength: Background filter strength (strength of imprint or spread). Ranges from 0-255.
  • bgGradientFocalPoint: Background gradient focal point: -1=shift to left, 0=center, 1=shift to right.
  • bgGradientRatio1: Background gradient color distribution ratio for point 1: 0-255.
  • bgGradientRatio2: Background gradient color distribution ratio for point 2: 0-255.
  • bgGradientRotation: Background gradient rotation in degrees: 0-180.
  • bgGradientType: Background gradient type: linear, radial.
  • bgOutlineAlpha: Background outline transparency: 0 = transparent, 1=opaque.
  • bgOutlineColor: Background outline color.
  • bgOutlinePixelHinting: Background outline pixel hinting: true, false.
  • bgOutlineWidth: Background outline width in pixels.
  • btnAlpha1: Button gradient transparency for point 1: 0 = transparent, 1=opaque.
  • btnAlpha2: Button gradient transparency for point 2: 0 = transparent, 1=opaque.
  • btnAlphaOver1: Button gradient transparency on mouse over for point 1: 0 = transparent, 1=opaque.
  • btnAlphaOver2: Button gradient transparency on mouse over for point 2: 0 = transparent, 1=opaque.
  • btnColor1: Button gradient color for point 1.
  • btnColor2: Button gradient color for point 2.
  • btnColorOver1: Button gradient color on mouse over for point 1.
  • btnColorOver2: Button gradient color on mouse over for point 2.
  • btnEllipseHeight: Button vertical rounding effect: 0=square corners, >0=rounded corners.
  • btnEllipseWidth: Button horizontal rounding effect: 0=square corners, >0=rounded corners.
  • btnFilter: Button filter. Options include: null, Glow, DropShadow.
  • btnFilterAlpha: Button filter transparency: 0 = transparent, 1=opaque.
  • btnFilterAngle: Button filter angle. DropShadow filter only.
  • btnFilterBlurX: Button horizontal filter blur. Ranges from 0-255.
  • btnFilterBlurY: Button vertical filter blur . Ranges from 0-255.
  • btnFilterColor: Button filter color.
  • btnFilterDistance: Button filter distance in pixels. DropShadow filter only.
  • btnFilterHide: Button filter hide (whether the object is hidder or not). DropShadow filter only.
  • btnFilterInner: Button filter location. True = inner, False = outer.
  • btnFilterKnockout: Button filter knockout effect (makes the object's fill transparent).
  • btnFilterQuality: Button filter quality (number of times to apply filter). Options include 1, 2, or 3.
  • btnFilterStrength: Button filter strength (strength of imprint or spread). Ranges from 0-255.
  • btnGradientFocalPoint: Button gradient focal point: -1=shift to left, 0=center, 1=shift to right.
  • btnGradientRatio1: Button gradient color distribution ratio for point 1: 0-255.
  • btnGradientRatio2: Button gradient color distribution ratio for point 2: 0-255.
  • btnGradientRotation: Button gradient rotation in degrees: 0-180.
  • btnGradientType: Button gradient type: linear, radial.
  • btnHeight: Button height in pixels. For best results use an even-number integer.
  • btnOutlineAlpha: Button outline transparency: 0 = transparent, 1=opaque.
  • btnOutlineColor: Button outline color.
  • btnOutlinePixelHinting: Button outline pixel hinting: true, false.
  • btnOutlineWidth: Button outline width in pixels.
  • btnWidth: Button width in pixels. For best results use an even-number integer.
  • defColor1: DEF button color for available bit rate options.
  • defColor2: DEF button color for selected bit rate option.
  • defEllipseHeight: DEF button vertical rounding effect: 0=square corners, >0=rounded corners.
  • defEllipseWidth: DEF button horizontal rounding effect: 0=square corners, >0=rounded corners.
  • defHeight: DEF button height in pixels. For best results use an even-number integer.
  • defOutlineAlpha: DEF button outline transparency: 0 = transparent, 1=opaque.
  • defOutlineColor: DEF button outline color.
  • defOutlinePixelHinting: DEF button outline pixel hinting: true, false.
  • defOutlineWidth: DEF button outline width in pixels.
  • defWidth: DEF button width in pixels. For best results use an even-number integer.
  • defYoffset: DEF selector offset in Y-direction in pixels: positive numbers move DEF buttons up.
  • disabledAlpha: Transparency of controls when disabled (e.g. during prerolls): 0 = transparent, 1=opaque.
  • elementSpacing: Spacing between control elements in pixels.
  • enableAutoControls: Automates the playlist, previous, next, caption, DEF selectors, and overlay buttons so they only appear when needed (e.g. playlist, previous, and next buttons only appear when a xml file is loaded; caption button only appears when a captions file is defined; overlay button only appears when overlays are defined; and DEF selectors only appear when multiple bit rates are defined).
  • enableCaption: Enable caption button.
  • enableDEF: Enable bit rate definition selector buttons (LD-MD-HD).
  • enableEmail: Enable email button.
  • enableEmbed: Enable embed button.
  • *enableFacebook: Enable Facebook share button.
  • enableForward: Enable fast forward button.
  • enableFullscreen: Enable fullscreen button.
  • enableHome: Enable home button.
  • enableLink: Enable link button.
  • enableLoop: Enable single file loop button (a.k.a. repeat)
  • enableMute: Enable mute button.
  • enableNext: Enable next button.
  • enableOverlay: Enable overlay button.
  • enablePlaylist: Enable playlist button.
  • enablePlayPause: Enable play/pause buttons.
  • enablePrevious: Enable previous button.
  • enable Progress: Enable progress bar and scrubber button.
  • enableRewind: Enable rewind button.
  • enableShuffle: Enable shuffle button (a.k.a. random)
  • enableStop: Enable stop button.
  • enableText: Enable playtime, duration, bandwidth, and volume text.
  • enableToolTip: Enable tool tips for all controls.
  • *enableTwitter: Enable Twitter share button.
  • enableVolume: Enable volume controls.
  • homeLink: URL where users will be directed when the Home button is pressed. Can not be modified in free version.
  • homeLinkTarget: Target for home link. Options include: _self, _blank, _parent, _top.
  • initialVolume: Default volume. 1=100%.
  • playerInstance: Instance name that you assigned to the MediaPlayer component on the stage. This parameter must be defined.
  • scrubberAlpha: Progress and volume scrubber alpha: 0 = transparent, 1=opaque.
  • scrubberColor: Progress and volume scrubber color.
  • scrubberEllipseHeight: Scrubber vertical rounding effect: 0=square corners, >0=rounded corners.
  • scrubberEllipseWidth: Scrubber vertical rounding effect: 0=square corners, >0=rounded corners.
  • scrubberHeight: Progress and volume scrubber height in pixels.
  • scrubberOutlineAlpha: Progress and volume scrubber outline alpha: 0 = transparent, 1=opaque.
  • scrubberOutlineColor: Progress and volume scrubber outline color.
  • scrubberOutlinePixelHinting: Progress and volume scrubber outline pixel hinting: true, false.
  • scrubberOutlineWidth: Progress and volume outline width in pixels.
  • scrubberWidth: Progress and volume scrubber width in pixels.
  • scrubberYoffset: Scrubber offset in Y-direction in pixels: positive numbers move scrubbers up.
  • symbolColor: Button symbol color.
  • symbolSize: Button symbol height and width in pixels.
  • textColor: Playtime, duration, volume, and bandwidth text color.
  • textFont: Playtime, duration, volume, and bandwidth text font.
  • textSize: Playtime, duration, volume, and bandwidth text size in pixels.
  • textYoffset: Text offset in Y-direction in pixels: positive numbers move text up.
  • tipBgAlpha: Tool Tip background transparency: 0 = transparent, 1=opaque.
  • tipBgColor: Tool Tip background color.
  • tipBorderColor: Tool Tip border color.
  • tipCaption: Tool Tip message for Caption button.
  • tipColor: Tool Tip text color.
  • tipEmail: Tool Tip message for Email button.
  • tipEmbed: Tool Tip message for Embed button.
  • tipFont: Tool Tip text font.
  • tipForward: Tool Tip message for Fast Forward button.
  • tipFullscreenOn: Tool Tip message for Fullscreen button while in Fullscreen mode.
  • tipFulslcreenOff: Tool Tip message for Fullscreen button while in Normal mode.
  • tipHD: Tool Tip message for HD (Hi-Def) bit rate button.
  • tipHome: Tool Tip message for Home bit rate button. This option is disabled with free player.
  • tipLD: Tool Tip message for LD (Low-Def) bit rate button.
  • tipLink: Tool Tip message for Link button.
  • tipLoopOn: Tool Tip message for Single File Loop (repeat) button when repeat is enabled.
  • tipLoopOff: Tool Tip message for Single File Loop (repeat) button when repeat is disabled.
  • tipMD: Tool Tip message for MD (Med-Def) button.
  • tipMuteOn: Tool Tip message for Mute button when sound is enabled.
  • tipMuteOff: Tool Tip message for Mute button when sound is disabled.
  • tipNext: Tool Tip message for Next button.
  • tipOverlayOn: Tool Tip message for Overlay button when Overlay feature is visible.
  • tipOverlayOff: Tool Tip message for Overlay button when Overlay feature is hidden.
  • tipPause: Tool Tip message for Pause button.
  • tipPlay: Tool Tip message for Play button.
  • tipPlaylistOn: Tool Tip message for Playlist button when Playlist component is visible.
  • tipPlaylistOff: Tool Tip message for Playlist button when Playlist component is hidden.
  • tipPrevious: Tool Tip message for Previous button.
  • tipProgress: Tool Tip message for Progress bar and scrubber.
  • tipRewind: Tool Tip message for Rewind button.
  • tipShuffleOn: Tool Tip message for Shuffle button when shuffle/random is turned on
  • tipShuffleOff: Tool Tip message for Shuffle button when shuffle/random is turned off
  • tipSize: Tool Tip text size in pixels.
  • tipStop: Tool Tip message for Stop button.
  • tipVolume: Tool Tip message for Volume bar and slider.

dd

Working with FlashVars:
* Asterisk symbol indicates new or altered v.4.0.1 feature

FlashVars are variables that can be defined in the html embed code and are used by the HD Media Player. These variables can be used to load a new XML playlist (in which case you would not use any other FlashVars) or a single media file (in which case you may also want to load an image, define a url link, set the autoplay parameter, set the title and/or description, or define the instance parameter). Below is a complete list of the FlashVars that can be used with the default player.

  • autoplay - "Yes-always","Yes-on first video","No-always","No-on first video"; applies when video loads
  • image - path to image file to be used as a preloader, pause image, or in support of audio file
  • link - url where user will be directed if they click the screen
  • *title - title of media file that can be displayed as a message on the screen or when sharing on Facebook and Twitter
  • *desc - brief description of media file that can be displayed on Facebook and Twitter
  • *share - "true","false"; enables/disables all share buttons including Facebook, Twitter, Email, Link, and Embed
  • instance - "application", "stream"; determines if the first instance in a rtmp path should be attributed to the application or stream name. For example: if your rtmp path is rtmp://www.server.com/application/instance/stream, and /instance/ is part of the stream name choose "stream"; or if /instance/ is part of the application name choose "application".
  • media - path to a single audio/video file or a XML playlist file that has the ".xml" extension
  • xml - path to a XML playlist file that does not have the ".xml" extension (e.g. xml generated with ASP or PHP)
  • wizard - wizard settings array; this variable should only be used with the Skin Wizard.

dd

Working with the XML Playlist:

XML files are a convenient way to organize information into a flat file database that can be loaded into the HD Media Player, which makes it possible to load a series of media files with associated content at run-time. Below are examples and a breakdown of the XML structure with definitions for all containers, attributes, and nodes.

Links to XML Samples - includes examples for progressive (http), streaming (rtmp), bandwidth profiling, mid-roll overlay, playlist, preroll, video, audio, and images
XML Sample With Parameters (when NOT using the Skin Wizard)
XML Sample Without Parameters (use with Skin Wizard)

Breakdown of XML Structure:

"items" Container (required): all xml information must be between the <items></items> tags . The following attributes are optional and can be set within the leading <items> tag . NOTE: attributes/variables set within the xml file will override settings in the Component Inspector and Skin Wizard. When working with the Skin Wizard you should only define the "categories" attribute ; all of the other variables should be set in the Skin Wizard).

  • autoplay - "Yes-always","Yes-on first video","No-always","No-on first video"; applies when video loads
  • looping - "continuous", "oneTime", "singleFile", "endStop"; applies when end of media file is reached
  • preloading - "Yes-always","Yes-on first video","No-always","No-on first video"; when preloading is enabled media will preload when selected; otherwise media will not load until the Play button is pressed.
  • smoothing - "true","false"; if "true" video will be smoothed when scaled to eliminate pixilation
  • random - "Yes-always","Yes-on first video","No-always","No-on first video"; applies when selecting next video to load (items may repeat before all are played)
  • linkTarget - "_blank","_self","_top","_parent"; applies to link attributes in media and roll nodes
  • displayImage - "always", "first-frame", "last-frame", "first-last-frames", "never"; determines when image will be displayed
  • displayPlayBtn - "always", "first-frame", "last-frame", "first-last-frames", "never"; determines when the Play button will be displayed in the center of MediaPlayer component
  • instance - "application", "stream"; determines if the first instance in a rtmp path should be attributed to the application or stream name. For example: if your rtmp path is rtmp://www.server.com/application/instance/stream, and /instance/ is part of the stream name choose "stream"; or if /instance/ is part of the application name choose "application".
  • dynamicStream - "true","false"; if "true" and the bandwidth detection is enabled and there are multiple bit rate options for the current media item and you are using FMS 3.5 or 4 to stream your media content, the player uses the "play2" method to seamlessly transition from one bit rate option to another (in all switching scenarios); otherwise the player will use the more traditional switching routine and the user will see a brief blank screen (streaming videos will start at the current time, progressive files will restart at time 0)
  • autoSwitch - "true","false"; if "true" and the bandwidth detection is enabled and there are multiple bit rate options for the current media item, the player will automatically switch to a lower bit rate option if the player stops to buffer too many times or if there are too many dropped frames (use the "dynamicBufferStops" and "droppedFrameLimit" parameters in the Component Inspector to set these thresholds)
  • blankMedia - absolute or relative "http" path to a blank FLV file (blank indicates that is has no content, should be encoded with audio portion only; see the section entitled "Converting your media files..." below for links to sample blank files); this file is used to attach a timeline to image files when they are loaded by themselves (e.g. as a slideshow)
  • categories - text array with comma delimiter; used to define categories that will be displayed in the Playlist component's drop down menu; if this attribute is used each of the media items must have the category attribute.
  • bandwidthTest - absolute or relative "http" path to JPEG image that is ~100kb in size; or you can use the native FMS 3/4 bandwidth checker by using the "rtmp" path to the server and application; this feature is used to determine the user's bandwidth when the media player first loads on the page; NOTE: WHEN USING AN IMAGE IT MUST BE ON YOUR OWN WEB SERVER. DO NOT ATTEMPT TO USE THE BANDWIDTH IMAGE ON OUR SERVER AS THIS WILL EVENTUALLY CAUSE YOUR PLAYER TO FAIL!!


"item" Container (required): all information related to each media item must be between the <item></item> tags.
* Asterisk symbol indicates new or altered v.4.0.1 feature

  • <item> (required) - container for individual media items.
    Attributes:
    "id"= number used to index item (optional)
    *"name" = string used to index item by name, and can be displayed as a message on the screen, or when sharing on Facebook and Twitter (optional)
    "category" = comma delimited text array used to categorize item (required if "categories" attribute used in "items" container)
    "keywords" = comma delimited text array used to add searchable keywords (optional)
  • <playlist> (optional) - used to populate the Playlist component with a thumbnail and html formatted text, and is therefore only necessary if you are using the Playlist component. NOTE: the contents of this node should be wrapped with the CDATA tag to enable the use of special characters, and the "span class" styles are defined in the Component Inspector for the MediaPlayer component.
    Attributes:
    "thumb"= absolute or relative "http" path to an image file (required)

  • <media> (required) - absolute or relative "http" path to a progressive audio/video file or the absolute "rtmp" path to a streaming audio/video file. Leave this blank and define the "image" and "blankMedia" (items container) attributes if you want to display an image only.
    Attributes:
    "image"= path to image file to be used as a preloader, pause image, or in support of audio file (optional)
    "dur"=duration of media file in seconds (optional)
    "link"=url where user will be directed if they click the screen (optional)
    "height"=height of video file (optional)
    "width"=width of video file (optional)
    *"desc"=brief description of media file that can be displayed when sharing on Facebook and Twitter
    *"title"=deprecated as of v.4.0.1 - use "name" attribute in the <item> container instead
    NOTE: id and name attributes defined in the associated <item> node also apply to this node.
  • <mediaLD> (optional) - absolute or relative "http" path to a progressive audio/video file or the absolute "rtmp" path to a streaming audio/video file.
    Attributes:
    "kbps"=bandwidth threshold in kbps; if the user's detected bandwidth is less than this number they will watch this version of the video (required)
    NOTE: image, duration, link, height, width, id, name attributes defined in the associated <item> and <media> nodes also apply to this node.
  • <mediaHD> (optional) - absolute or relative "http" path to a progressive audio/video file or the absolute "rtmp" path to a streaming audio/video file.
    Attributes:
    "kbps"=bandwidth threshold in kbps; if the user's detected bandwidth is greater than this number they will watch this version of the video (required).
    NOTE: image, duration, link, height, width, id, name attributes defined in the associated <item> and <media> nodes also apply to this node.
  • <roll> (optional) - absolute or relative "http" path to a progressive audio/video file or the absolute "rtmp" path to a streaming audio/video file that will play before the primary media item. Multiple prerolls will play in the order they are defined.
    Attributes:
    "dur"=duration of media file in seconds (optional)
    "link"=url where user will be directed if they click the screen (optional)
    "height"=height of video file (optional)
    "width"=width of video file (optional)
    "id"= number (optional)
    "name" = string (optional)
    "image"= path to image file to be used as a preloader, pause image, or in support of audio file (optional)
    NOTE: image attributes defined in the associated <media> node also apply to this node (e.g. image can be displayed before first roll).
  • <overlay> (optional) - used to define mid-roll html-formatted text and images that will be displayed at the specified time for the specified duration. The size and location of the overlay is defined in the MediaPlayer's component inspector. NOTE: the contents of this node should be wrapped with the CDATA tag to enable the use of special characters; the "span class" styles are defined in the Component Inspector for the MediaPlayer component; you can use "img src=" to define the path to an image file; you can use "a href=" to define a link for your images/text; other xml-friendly html formatting can also be used.
    Attributes:
    "time"=start time for overlay in seconds (optional)
    "dur"=duration of overlay in seconds; set to 0 for undefined (optional)
    "id"= number (optional)
    "name" = string (optional)

dd

Converting your media files to work with the HD Media Player:

  • Video: The MediaPlayer component supports FLV/F4V, H264 (includes MOV, MP4, M4V, etc), and YouTube video formats. You must convert all other video file types to one of these formats. We recommend using the Adobe Media Encoder CS4/CS5 (included with purchase of Flash CS4/CS5) or QuickTime Pro to encode your video files; or you can simply upload your videos to YouTube and they will take care of the encoding. You must include metadata in your video files for the height, width, and duration if you want to avoid typing this information into the XML playlist (the required metadata is automatically included with Adobe Media Encoder, QuickTime Pro, and YouTube). All supported video formats can be hosted on any Web Server (http/progressive), Flash Media Server 3 or 4 (rtmp/streaming), and YouTube. If you are using one of the rtmp protocols (rtmp, rtmpt, rtmpe, etc.) to stream your video files you must reference the filenames as follows: for FLV leave off the filename extension (e.g. if your file is named "video1.flv" you would specify the name of the file as "video1" when loading it into the player); for F4V/H264 files you must include the "mp4:" prefix and the filename extension (e.g. if your file is named "video1.mov" you would specify the name of the file as "mp4:videofile.mov" when loading it into the player ). If you are loading YouTube videos you will reference the videos as follows: http://www.youtube.com/v/VIDEO_ID, where VIDEO_ID is the ID value provided by YouTube for that particular video.
  • Audio: The MediaPlayer component supports FLV/F4V, H264/AAC (includes MP4, M4A, etc), ShoutCast Radio, and MP3 audio formats (note: you can display an image while an audio track plays; see next bullet). You must convert all other audio file types to one of these formats. You must include metadata in your audio files for the "duration" if you want to avoid typing this information into the XML playlist. All supported audio formats can be hosted on any Web Server (http/progressive) or Flash Media Server 3 or 4 (rtmp/streaming). If you are using one of the rtmp protocols (rtmp, rtmpt, rtmpe, etc.) to stream your audio files you must reference the filenames as follows: for FLV leave off the filename extension (e.g. if your file is named "audio1.flv" you would specify the name of the file as "audio1" when loading it into the player); for F4V/H264/AAC files you must include the "mp4:" prefix and the filename extension (e.g. if your file is named "audio1.mp4" you would specify the name of the file as "mp4:audio1.mp4" when loading it into the player ); for MP3 files you must include the "mp3:" prefix and the filename extension (e.g. if your file is named "audio1.mp3" you would specify the name of the file as "mp3:audio1.mp3" when loading it into the player). If you are loading a ShoutCast Radio stream you must use the server, port, and ";stream.nsv" filename as follows: http://SERVER:PORT/;stream.nsv (e.g. http://216.155.137.149:8030/;stream.nsv).
  • Images: The MediaPlayer component can display JPG, SWF, PNG, or GIF images in the "Overlay", "Image", and "Playlist" features (images must be hosted on a http web server; only the first frame of an animated GIF will be loaded; player controls have no effect on animated SWF files), so you need to convert your image files to one of these formats using Flash authoring software or another type of image conversion software (e.g. PhotoShop). The images you display in the "Overlay" feature will not be automatically resized when loaded into the player, so you should crop/resize your image to fit perfectly within the allocated spaces, or you should use html "width/height" tags in the XML to resize the images on the fly. Images loaded into the "Image" feature and "Playlist" component are automatically resized to fit within the allocated space (i.e. scaled up or down to fit). While it is possible to use the same images in the "Image" feature and "Playlist" component, we recommend that you create large images for the "Image" feature (otherwise it will be pixilated when expanded to fullscreen; these images should have the same aspect ratio as the associated media file for complete coverage), and small images for the "Playlist" component (will reduce loading times and refresh rates when you scroll through the playlist; these images should have the same aspect ratio as the allocated space in the playlist to avoid letterboxing).
    NOTE: it is possible to use the MediaPlayer as a slideshow or banner rotator if you're using the XML playlist and define the "blankMedia" attribute in the XML (or in the Component Inspector). The blank media file provides a timeline for the playhead to follow, and it should be encoded in the FLV format (include blank audio only; do not encode video portion). Use the following links to download sample blank media files:
    10-second blank
    1-minute blank
    10-minute blank
    Below is an example of how your xml should be set up when loading images with the blank media file (notice the "blankMedia" attribute is defined in the <items> container; the "image" attribute is defined in the <media> node; nothing is defined between the <media></media> tags; the "dur" attribute in the <media> node is defined to shorten the duration (i.e. the blank is 10-seconds long, but you can shorten the duration using the "dur" attribute; the blank media file must be as long as the desired duration)
    <?xml version="1.0"?>
    <items blankMedia='http://components.earthscienceagency.com/sw_includes/videos/blank_10sec.flv'>
    <item>
    <media image='image1.jpg' dur='5'></media>
    </item>
    </items>

dd

Actionscript API (the following script examples can be used in the player FLA to extend the capabilities of the default components):
* Asterisk symbol indicates new or altered v.4.0.1 feature

MediaPlayer Public Properties:
playlist // returns the current playlist display state (true, false)
controller // returns the current controller display state (true, false)
endReached // returns the current endReached status (true, false)
majorVersion // returns the Flash Player major version number
minorVersion // returns the Flash Player minor version number
buildNumber // returns the Flash Player build number
fmsVersion // returns the FMS version number
youtube // returns true if the current media item is a YouTube video (true, false)
ytScrubReady // returns true if the scrubber is ready for a loaded YouTube video file (true, false)
dynamicSwitching // returns the current dynamic switching status (true or false)
currentMedia // returns the current item index number (starts at 0; always 0 when no XML is loaded)
currentMediaPosition // returns the current playhead position in seconds
currentImage // returns the path for the current image
pctLoaded // returns the amount of the current media file that has been downloaded in percent
pctPlayed // returns the amount of the current media files that has been played in percent
currentVolume // returns the current volume (1=100%)
mediaCount // returns the number of items in the currently loaded XML file
categoryLoaded // returns the category loaded status (true or false)
categoryCount // returns the number of items in the current category
categoryName // returns the name of the current category
mediaCounter // returns the number of media items that have been played
mediatype // returns the type of media file that is currently loaded (audio or video)
pausedFlag // returns the current pause status (true or false)
videoLoaded // returns the current videoLoaded status (true or false)
fullyLoaded // returns the current fullyLoaded status (true or false)
xmlPath // returns the path of the currently loaded XML file
xmlFileLoaded // returns the current xmlFileLoaded status (true or false)
singleFile // returns the current singleFile status (true or false)
mediaSource // returns the entire path to the current media item
streamName // returns the current media file name
currentID // returns the current media ID (specified as an attribute in the xml)
*currentName // returns the current media Name (specified as "title" flashvars or "name" xml attribute)
*currentDesc // returns the current media Description (specified as "desc" flashvars and xml attribute)
cuePointName // returns the name of the current embedded cue point
cuePointTime // returns the time of the current embedded cue point
timeLeft // returns the amount of time left to play in the current media file
bandwidth // returns the bandwidth of the current user in kbps
roll // returns the roll status (true if roll, false if media)
rollNum // returns the number of the current roll
rollID // returns the ID of the current roll (specified as an attribute in the xml)
rollName // returns the Name of the current roll (specified as an attribute in the xml)
endRoll // returns the endRoll status of the current media item
captionsAvailable // returns the captionsAvailable staus (true or false)
ccType // returns the closed caption type (specified as an attribute in the xml)
ccSource // returns the closed caption source (specified as an attribute in the xml)
ccLanguage // returns the closed caption language (specified as an attribute in the xml)
ccStyle // returns the closed caption style (specified as an attribute in the xml)
overlayNum // returns the number of the current overlay
overlayID // returns the ID of the current overlay (specified as an attribute in the xml)
overlayName // returns the Name of the current overlay (specified as an attribute in the xml)
controlsTimer // returns the current value of the controls timer (used to turn the controls on/off)
resetControlsTimer // reset the controls timer to 0
protocol // returns the protocol of the current media item (http or rtmp)
mp3 // returns true if current file is mp3 (true, false)
definition // returns the definition of the current media file (LD, MD, HD)
 
MediaPlayer Public Methods:
setSize(width:Number, height:Number) // resizes the MediaPlayer component
loadMedia(url:String) // load a single media file or XML file
loadXMLAtID(url:String, id:Number) // load a XML file and jump to a specific item id
loadXMLAtName(url:String, name:String) // load a XML file and jump to a specific item name
loadXMLAtIndex(url:String, index:Number) // load a XML file and jump to a specific item index (starts at 0)
loadCategory(category:String) // sort XML by category
keywordSearch(keyword:String) // sort XML by keyword
jumpToID(id:Number) // jump to a specific item id of an already loaded XML
jumpToName(name:String) // jump to a specific item name of an already loaded XML
jumpToItem(index:Number) // jump to a specific item index of an already loaded XML (starts at 0)
nextItem() // jump to the next item of an already loaded XML
prevItem() // jump to the previous item of an already loaded XML
pause() // pauses the playhead
play() // resumes play
seek(time:Number) // seek to a specific time
setVolume(volume:Number) // sets the volume level (1=100%)
overlayToggle() // turns the overlay on/off
resetControlsTimer // resets the controlsTimer to 0 (used to turn the controls on/off)
switchStream(def:String) // switches the stream to HD, MD, or LD version when available
 
MediaPlayer Listener Events:
pause // dispatched when the playhead is paused
play // dispatched when the playhead resumes play
mediaTime // dispatched several times a second (=timerDelay); used to update all player features
mpPlayButton // dispatched when the play button in the center of the screen is pressed
screenClicked // dispatched when the player screen is clicked
overlayClicked // dispatched when the overlay is clicked
spaceBar // dispatched when the space bar is pressed on a user's keyboard (used to pause/play video)
xmlLoaded // dispatched when a XML file has fully loaded
imageLoaded // dispatched when an image file has fully loaded (used with "image" feature)
bandwidth // dispatched when a user's bandwidth has been detected
start // dispatched when a media file is loaded with http, and every time the playhead resumes with rtmp
stop // dispatched when end of media file is reached with http, called every time playhead stops with rtmp
bufferEmpty // dispatched when the player's buffer is empty
bufferFull // dispatched when the player's buffer is full
evtCuePoint // dispatched when an embedded "event" cue point is received by player
navCuePoint // dispatched when an embedded "navigation" cue point is received by player
videoLoaded // dispatched when a media file has loaded enough to show the first frame
mediaLoading // dispatched several times a second (=timerDelay) while a media file is loading
fullyLoaded // dispatched when a media file has been fully downloaded
endReached // dispatched when the end of a media file has been reached
overlayLoaded // dispatched when an overlay has been loaded
streamTimeout // dispatched when a live streaming file can not be found (uses timeout parameter)
liveStreaming // dispatched when a live streaming file is playing (uses timeout parameter)
category // dispatched when the xml has been successfully sorted by category
addCategory // dispatched when a new category has been successfully defined
switch // dispatched when the player has started to switch to a different bit rate option
dynamicSwitch // dispatched when the player has successfully switched using the dynamic switch method
 
Controller Public Properties:
none
 
Controller Public Methods:
setSize(width:Number, height:Number) // used to resize the Controller component dynamically
 
Controller Listener Events:
playButton // dispatched when the play button is pressed
pauseButton // dispatched when the pause button is pressed
stopButton // dispatched when the stop button is pressed
prevButton // dispatched when the previous button is pressed
nextButton // dispatched when the next button is pressed
forwardButton // dispatched when the previous button is pressed
rewindButton // dispatched when the next button is pressed
playlist // dispatched when the playlist button is pressed
progressBar // dispatched when the progress bar is pressed
scrubber // dispatched when the scrubber is pressed
loop // dispatched when the single file loop/repeat button is pressed
shuffleButton // dispatched when the shuffle/random button is pressed
homeButton // dispatched when the home button is pressed
embed // dispatched when the embed button is pressed
link // dispatched when the link button is pressed
email // dispatched when the email button is pressed
*facebook // dispatched when the Facebook button is pressed
*twitter // dispatched when the Twitter button is pressed
captionButton // dispatched when the caption button is pressed
overlayButton // dispatched when the overlay button is pressed
volumeButton // dispatched when the volume button is pressed
volumeBar // dispatched when the volume bar is pressed
volumeScrubber // dispatched when the volume scrubber is pressed
fullscreen // dispatched when the player jumps in/out of fullscreen mode
HD // dispatched when the HD (Hi-Def) button is pressed
MD // dispatched when the MD (Med-Def) button is pressed
LD // dispatched when the LD (Low-Def) button is pressed
 
Playlist Public Properties:
none
 
Playlist Public Methods:
setSize(width:Number, height:Number) // used to resize the Playlist component dynamically
 
Playlist Listener Events:
playlistItem // dispatched when playlist item is selected
 
 
Property Syntax (example assumes MediaPlayer component has the instance name "myMediaPlayer"):
myMediaPlayer.streamName // append component instance name to the property
 
Method Syntax (example assumes MediaPlayer component has the instance name "myMediaPlayer"):
myMediaPlayer.play(); // append component instance name to the method, include arguments if they exist
 
Event Listener Syntax (example assumes MediaPlayer has the instance name "myMediaPlayer"):
myMediaPlayer.addEventListener("videoLoaded", videoLoadedHandler);
function videoLoadedHandler(event:Event) {
//your script goes here
}
 

dd

Related Links:

dd

Release Notes v.4.0.1 (06/17/11):

  • Added Facebook sharing button to Controller Component - fully integrated with dynamic link, title, description, and image
  • Added Twitter sharing button to Controller Component - fully integrated with dynamic link, title, and description
  • Added "title" and "desc" flashvars to support Facebook and Twitter sharing when loading single media files
  • Added "messagePlaying" parameter to MediaPlayer Component to enable a custom message while playing (e.g. title)
  • Now offering a Webmaster package (branding-free default skin only)
  • Developer package now includes Default, Simple, Phantom, Zoom, Titanium, & Media Grid skins
  • Flash Pro package now includes 2 free hours of customization
  • Deprecated "title" attribute in XML - use "name" attribute instead

Release Notes v.3.0.1 (02/16/11):

  • Added many new options for the Playlist Component
  • Playlist ScrollBar and Category ComboBox are now skinnable (you pick the color scheme)
  • Added Image Cache feature to Playlist so once thumbnails are loaded there are no more rendering delays upon scrolling
  • Thumbnails in Playlist can now be sized independently and aligned to the left, right, or center of the cell
  • Text description in Playlist can now be aligned to the left, right, or center
  • Text description in Playlist can now be visible Always or on Rollover
  • Playlist cells now have a bevel filter option to create a delineation between cells

Release Notes v.2.0.1 (05/04/10):

  • Released online Skin Wizard for easy skinning of our default player
  • Added support for ShoutCast live radio streams
  • Added auto controls option so playlist, next, previous, captions, bit rate, and overlay buttons appear/disappear automatically
  • Integrated Google Analytics Library component directly into MediaPlayer component for easier setup and auto-tracking
  • Added CCForFlash component to default player FLA/SWF
  • Added Email, Embed, and Permalink support to default player FLA/SWF
  • Added support for ShoutCast live radio streams
  • Added Title display option (displayed while playing or when you mouse over the screen)
  • Added new Preloading options (Yes-always, No-always, Yes-on first video, No-on first video)
  • Added new Random playback options (Yes-always, No-always, Yes-on first video, No-on first video)
  • Added dual mode tool tips to toggle buttons so you know if the related features are turned on/off (e.g. captions, overlays, playlist, etc.)
  • Added parameters for the overlays, captions, playlist, and controls so you can turn them on/off by default
  • Added Shuffle and Repeat buttons

Release Notes v.1.7.2 (03/10/10):

  • Addressed problem when using instances as part of the stream name in a rtmp path.

Release Notes v.1.7.1 (02/08/10):

  • Added support for videos hosted on YouTube, including small, medium, large, and HD 720 formats with dynamic switching
  • Addressed problem with text alignment on Playlist component.

Release Notes v.1.6.2 (01/04/10):

  • Addressed problem with undefined attributes in XML
  • Addressed problem with looping attribute when there is only 1 item in the playlist, when using MP3 files, and when using the "oneTime" setting with sorted lists
  • Modified MediaPlayer component so it is easier to embed images (added currentImage property to the Media Player component)
  • Addressed problem with dropdown prompt so it will stay bold when publishing

Release Notes v.1.5.3 (12/01/09):

  • Added rewind and fast forward buttons to the Controller component
  • Added new captions configuration options to the XML structure that work with the CCForFlash component (now supports: cctype, ccsrc, cclang, ccstyle, ccdefault, ccdispmode, ccsize, ccfont, ccweight, cccolor, ccalign)
  • Added a debugger mode to help you troubleshoot problems when you test the player in Flash CS4/CS5. When the debug mode is enabled (in the MediaPlayer's Component Inspector), trace statements are dispatched when key events / errors occur.
  • Modified the default skin so you can use the width and height attributes in the html embed code to resize the player
  • Added new flashvars options (now supports: autoplay, image, link, instance, media, xml)
  • Added new javascript options that allow you to set up links in your page that load specific media items defined in the currently loaded XML. For example, you can now use the "SendIDToFlashMovie" or "SendNameToFlashMovie" functions to jump to a new media item based on its "id" or "name" attributes in the XML, so you can take full advantage of all the features offered through the XML (e.g. prerolls, images, overlays, etc).
  • Addressed playlist problem when loading single files using javascript (can now reload the last XML item)
  • Addressed relative path problem when using the "base" parameter in the embed code
  • Addressed minor looping problem when loading single media files
  • Addressed minor scrubber alignment issue (now goes all the way to the right of progress bar) and a separate problem when scrubbing MP4 audio files
  • Addressed play button / image display timing issues
  • Addressed live streaming problem with undefined streaming servers
  • Addressed link target problem when set to _self
  • Addressed alignment issues when playtime / duration is greater than 99 minutes

Release Notes v.1.4.2 (10/27/09):

  • Added automated dynamic bit rate switching so the player can switch to a lower bit rate if the player is buffering too much (sudden drop in bandwidth) or has too many dropped frames (cpu overloading) - offers seamless transitions with FMS 3/4
  • Added categorical sort and keyword search tools to the Playlist component so you can sort the contents of your xml file (new parameters begin with "category...")
  • Added "external" options for mid-roll overlays, so you can display text and graphics anywhere using x, y coordinates (new parameters in "overlayExternalX" and "overlayExternalY".
  • Changed the "bandwidthImage" attribute in the XML to "bandwidthTest", because you can now use the native FMS 3/4 bandwidth checker (must be enabled on your FMS) instead of an image (you can still use an image if you prefer).
  • Added "playlistX" and "playlistY" parameters to the Playlist's Component Inspector so you can define the x, y coordinates manually (in previous versions the Playlist was centered within the background)

Release Notes v.1.3.1 (9/28/09):

  • Added color and alpha gradient options to all of the components for richer looking graphics
  • Added more skinning options to the progress bar, scrubbers, and volume slider.
  • Added pixel hinting option for crisper looking outlines
  • Renamed "volumePreset" parameter to "initialVolume" in the Controller component (was not working properly)
  • Addressed problem with the MediaPlayer's central play button (no longer shows up when dynamically resizing)

Release Notes v.1.2.2 (9/15/09):

  • Added a new parameter to allow user's to specify if the first "instance" in a rtmp path should be attributed to the application or stream name. This parameter is called "mediaSourceInstance" in the MediaPlayer's component inspector; and it is called "instance" in the XML attributes (at the top of the xml). The options are "application" and "stream". For example: if your rtmp path is rtmp://www.server.com/application/instance/stream, and /instance/ is part of the stream name choose "stream"; or if /instance/ is part of the application name choose "application".

Release Notes v.1.2.1 (9/7/09):

  • Added media definition selector to Controller component so users can manually switch to higher/lower quality media files on the fly (e.g. FMS switching)
  • Added support for the MP3 format (progressive and streaming)
  • Improved the player's ability to operate as a slideshow or banner rotator (added blankMedia parameter)
  • Added a timeout event (streamTimeout) that is triggered when a live stream is unavailable (timeout parameter; can be expanded using our API to switch to a prerecorded file or VOD)
  • Disabled the mouse over text in the Playlist component while scrolling
  • Player can now parse rtmp paths with instances (i.e. extra folders in the path)

Release Notes v.1.0.1 (7/24/09):

  • This is the first version of our HD Media Player written in AS 3.0 using Flash CS4/CS5.

dd

Known Bugs or Issues:

  • An error can occur in Flash CS4/CS5 when testing url links (i.e. when using the Controls-->Test Movie method to test your SWF), so you should publish a SWF file and upload it to your server to test all of your links (e.g. home button, media link, email button, html link in overlay, etc.).
  • An error can occur in Flash CS4/CS5 when you open two or more FLA files with the same name and similar content, so you should only open one HD Media Player file at a time, or use unique file names for each of your FLA files.
footer_graphic

Support - Documentation - Skin Wizard - Sample Skins - Tutorials
Copyright © 2003-2012 Earth Science Agency, LLC - All Rights Reserved