Home

Dash Media Player Skinning API

Submitted by travist on Thu, 10/16/2008 - 16:34.
Methods
initialize() Function to initialize your skin.
getConfigInfo() Allows you to provide all your information within your skin file so that you do not have to expose the configuration XML file to outside parties. If you wish to use this, simply fill in the information below, and then provide the variable "config=internal" to the dash media player. For example, using the Dash Media Player API, I would use the following to read this information instead of reading the configuration XML file... $params['width'] = 652; $params['height'] = 432; $params['config'] = 'internal'; $params['playlist'] = 'videos'; priint dashplayer_get_player($params);
getLayoutInfo() Returns the layout information of this skin. Go to http://www.tmtdigital.com/node/140
getMediaType() Allows you to say which extensions are associated with what type of media. This allows you to create custom media classes to handle your media type specifically.
getMedia() When your media type is "custom", the dash media player will then call this routine to grab a media handling class. This can be anything class to handle any type of media like SWF files, ect. For an example stub class to be used to build your own, refer to the SWFMedia.as file.
onMediaPlaying() Called when the media starts playing...
onMediaComplete() Called when the media finishes playing...
getTeaser() Hook that allows you to return a MovieClip of your teaser.
onTeaserInit() Called when the teaser gets initialized.
onTeaserSelect() Called when the teaser gets selected.
onTeaserOver() Called when the mouse hovers over a teaser
onTeaserOut() Called when the mouse moves out of hovering over a teaser.
onTeaserDown() Called when the user presses the down button on the teaser.
getPlaylistLink() Hook that allows you to return a MovieClip of a playlist link.
getTermLink() Hook that allows you to return a MovieClip of a term link.
onNodeLoad() Hook that gets called when a node loads in the system
onPlaylistLoad() Hook that gets called when a node loads in the system
onFullScreenMove() Hook when the mouse is moved when the player is in full screen mode.
onFullScreenHide() Hook when the inactive timout occurs when in full screen mode. Typically you should hide everything at this point.
onFullScreen() Hook when the player goes in and out of full screen.
getTweenFunction() Ability to change how the resizer tweens its resize transitions.
toggleMenuMode() Called when the toggle menu mode button gets pressed.
onMenuFinish() Called when the menu has finished moving off the screen. Here we will just hide the menu when it is not in use.
showMinMaxButton() Called to hide or show the Min/Max button.
showMenuButton() Called to hide or show the Menu button.
showInfo() Called to hide or show the media player information section.
showControls() Called to hide or show the media player controls.
maximize() Called to maximize/minimize the player (show or hide the playlist).
setPlaylistSize() Called to set the width or height of the playlist.
formatTime() Hook to allow your to format the time indication however you would like it to be formated.
showPlaylistLinks() Called to show the dynamic links for the playlist.
setNavBar() Automatically places the previous and next buttons depending of whether there is a previous or next playlist.
setLogoPos() Allows you to set the logo position. You must have a valid license for this function to get called...

Methods

initialize()

function initialize( _dashBase:*, _dashService:*, _dashResizer:*, _dashUtils:*, _dashLayout:*, _flashVars:*, _dashInterface:* ) : Boolean
Function to initialize your skin.
Parameters:
-The Dash Media Player Base class.
-The Dash Media Player Service class. (for calling services to Drupal and others).
-The Dash Media Player Resizer class (for resizing objects)
-The Dash Media Player Utils class. (common utilities used throughout the player).
-The Dash Media Player Layout Manager. (to store all information from the layout XML file)
-The Flash Variables Object (for handling all flashvars).
-The Dash Media Player Interface class (for loading nodes, playlists, and handling media).
Returns:
- True to indicate to the media player to start loading content. False to let the skin take over from here and do what it needs to do.

getConfigInfo()

function getConfigInfo() : XML
Allows you to provide all your information within your skin file so that you do not have to expose the configuration XML file to outside parties. If you wish to use this, simply fill in the information below, and then provide the variable "config=internal" to the dash media player. For example, using the Dash Media Player API, I would use the following to read this information instead of reading the configuration XML file... $params['width'] = 652; $params['height'] = 432; $params['config'] = 'internal'; $params['playlist'] = 'videos'; priint dashplayer_get_player($params);
Returns:
- Your XML configuration, as it would be in the dashconfig.xml file.

getLayoutInfo()

function getLayoutInfo() : XML
Returns the layout information of this skin. Go to http://www.tmtdigital.com/node/140
Returns:
- Your XML layout information.

getMediaType()

function getMediaType( extension:String ) : String
Allows you to say which extensions are associated with what type of media. This allows you to create custom media classes to handle your media type specifically.
Parameters:
-The exension of the media being played.
Returns:
- The media type associated with this extension.

getMedia()

function getMedia( mediaFile:Object )
When your media type is "custom", the dash media player will then call this routine to grab a media handling class. This can be anything class to handle any type of media like SWF files, ect. For an example stub class to be used to build your own, refer to the SWFMedia.as file.
Parameters:
-The media file object to play. path - The full path of the media file. filename - The filename of the media file. extension - The file extension... mediatype - The media type... mediaclass - This will always be "media" here... weight - The weight of this media.
Returns:
- Your custom media class

onMediaPlaying()

function onMediaPlaying()
Called when the media starts playing...

onMediaComplete()

function onMediaComplete()
Called when the media finishes playing...

getTeaser()

function getTeaser() : MovieClip
Hook that allows you to return a MovieClip of your teaser.
Returns:
- A new movie clip of your teaser.

onTeaserInit()

function onTeaserInit( teaser:* )
Called when the teaser gets initialized.
Parameters:
-The teaser object.

onTeaserSelect()

function onTeaserSelect( teaser:*, select:Boolean )
Called when the teaser gets selected.
Parameters:
-The teaser object.
-If the teaser has been selected or not

onTeaserOver()

function onTeaserOver( teaser:* )
Called when the mouse hovers over a teaser
Parameters:
-The teaser object.

onTeaserOut()

function onTeaserOut( teaser:* )
Called when the mouse moves out of hovering over a teaser.
Parameters:
-The teaser object.

onTeaserDown()

function onTeaserDown( teaser:* )
Called when the user presses the down button on the teaser.
Parameters:
-The teaser object.
function getPlaylistLink() : MovieClip
Hook that allows you to return a MovieClip of a playlist link.
Returns:
- A new movie clip of your playlist link.
function getTermLink() : MovieClip
Hook that allows you to return a MovieClip of a term link.
Returns:
- A new movie clip of your term link.

onNodeLoad()

function onNodeLoad( node:Object )
Hook that gets called when a node loads in the system
Parameters:
-A standard Drupal node object.

onPlaylistLoad()

function onPlaylistLoad( playlist:Object )
Hook that gets called when a node loads in the system
Parameters:
-A standard Drupal view object.

onFullScreenMove()

function onFullScreenMove( mouseX:Number, mouseY:Number )
Hook when the mouse is moved when the player is in full screen mode.
Parameters:
-The x-position of the mouse.
-The y-position of the mouse.

onFullScreenHide()

function onFullScreenHide()
Hook when the inactive timout occurs when in full screen mode. Typically you should hide everything at this point.

onFullScreen()

function onFullScreen( full:Boolean )
Hook when the player goes in and out of full screen.
Parameters:
-True: Fullscreen, False: Normal

getTweenFunction()

function getTweenFunction() : Function
Ability to change how the resizer tweens its resize transitions.

toggleMenuMode()

function toggleMenuMode( on:Boolean, tween:Boolean )
Called when the toggle menu mode button gets pressed.
Parameters:
-True: Menu is on, False: Menu is off.
-If this should be a tween resize event or not.

onMenuFinish()

function onMenuFinish(e:TweenEvent)
Called when the menu has finished moving off the screen. Here we will just hide the menu when it is not in use.
Parameters:
-A standard tween event.

showMinMaxButton()

function showMinMaxButton( show:Boolean )
Called to hide or show the Min/Max button.
Parameters:
-True: Show the min/max button, False: Hide the min/max button.

showMenuButton()

function showMenuButton( show:Boolean )
Called to hide or show the Menu button.
Parameters:
-True: Show the menu button, False: Hide the menu button.

showInfo()

function showInfo( show:Boolean, tween:Boolean, refresh:Boolean )
Called to hide or show the media player information section.
Parameters:
-True: Show the information, False: Hide the information.
-Boolean to indicate if this transition should be tweened or not.
-Boolean to indicate if there should be a full screen refresh after the transition.

showControls()

function showControls( show:Boolean, tween:Boolean )
Called to hide or show the media player controls.
Parameters:
-True: Show the controls, False: Hide the controls.
-Boolean to indicate if this transition should be tweened or not.

maximize()

function maximize( max:Boolean, tween:Boolean = true, internal:Boolean = false )
Called to maximize/minimize the player (show or hide the playlist).
Parameters:
-True: Maximize (hide the playlist), False: Minimize (show the playlist).
-Boolean to indicate if this transition should be tweened or not.

setPlaylistSize()

function setPlaylistSize()
Called to set the width or height of the playlist.
Parameters:
-The size (in pixels) that you would like to set the playlist.

formatTime()

function formatTime(mediaTime:Number) : Object
Hook to allow your to format the time indication however you would like it to be formated.
Parameters:
-The time in seconds.
Returns:
- An object that represents both the units and the time as Strings.
function showPlaylistLinks()
Called to show the dynamic links for the playlist.

setNavBar()

function setNavBar( nextVisible:Boolean, prevVisible:Boolean )
Automatically places the previous and next buttons depending of whether there is a previous or next playlist.
Parameters:
-A boolean to indicate if there should be a next button for the playlist.
-A boolean to indicate if there should be a previous button for the playlist.

setLogoPos()

function setLogoPos( addObject:Boolean )
Allows you to set the logo position. You must have a valid license for this function to get called...
Parameters:
-A boolean that will indicate if the logo needs to be added as a dynamic property to the resizer.

Page generated: 12:51 am on October 25, 2008

  • 652 reads