Below you will find a categorized topic based documentation on setup and configuration of the Dash Player. If you do not find the information you are looking for, then please feel free to submit a new topic in our Forums. We will eventually migrate popular and relevant topics into this documentation area.
Also keep in mind that TMT Digital provides a Complete Integration Service. We would love to take care of whatever needs you have to get your project off the ground.
With all the numerous features that the Dash Player has to offer, it is easy to get overwhelmed with how to even get started using this amazing player. Hopefully, these tutorials will help out. For starters, this player was written as the first media player built specifically to tie in with an Open Source Content Management System (CMS). Due to its incredible power and flexibility, we decided to first add support with Drupal CMS ( we will be adding support for other CMS's in the near future ). But please don't be fooled... you can use this player without any Content Management System. In fact, this player is able to tap into the most standard mechanisms for media delivery including XML Playlist, Single File Support, and of course RSS (which is the technology of Podcasting).
So, let's get started....
Before you begin, you must first decide what type of system you would like to have host this player. What I mean by "host" is simply the type of website you would like to have that uses the Dash Player to show your websites media. Although you are more than welcome to use this player with any website implementation out there, it is highly recommended that you at least explore the Drupal CMS solution. It has so much to offer in terms of security and flexibility with regard to construction of playlists and management of the content that will easily set your website apart from any of your competitors. So with that said, below are the two types of implementations that the Dash Player supports. Please click on the links to learn more about how to implement this player in those systems.
Also keep in mind that TMT Digital provides a Complete Integration Service. We would love to take care of whatever needs you have to get your project off the ground.
| Feature | Dash Player | JW Player |
|---|---|---|
| RSS | ![]() | ![]() |
| XML Playlist | ![]() | ![]() |
| ASX Playlist | ![]() | ![]() |
| High Definition (H264) Support | ![]() | ![]() |
| Commercial Support | ![]() | ![]() |
| Full Screen Mode | ![]() | ![]() |
| Audio (MP3) Support | ![]() | ![]() |
| Resizable | ![]() | ![]() |
| Dynamic Skinning | ![]() | ![]() |
| Written in ActionScript 3 | ![]() | ![]() |
| Skinning API | ![]() | |
| Private Playlist Support | ![]() | |
| CMS Support | ![]() | |
| Remote Playlists | ![]() | |
| Dynamic Skin Themeing | ![]() | |
| Built in Voting | ![]() | |
| Built in View Counter | ![]() | |
| Dynamic Playlist Hide/Show | ![]() | |
| Dynamic Menu Hide/Show | ![]() |
You have chosen wisely, my friend... Using Drupal CMS with the Dash Player is by far the most flexible and powerful combination that you will not find elsewhere. The only drawback to this approach is that the setup is a little bit more tedious than using the other approach, but trust me, the payoff is much worth it. Also keep in mind that TMT Digital offers an integration service. If you would like to use Drupal CMS for your Dash Player, and don't feel like reading all these tutorials, then by all means contact us at http://www.tmtdigital.com/contact and we will be more than happy to assist you.
If you are more than willing to learn first hand, then by all means... lets get started.
To begin this tutorial, it is assumed that you already have the Drupal CMS installed on your web server. If you need help with this crucial step, then I suggest reading the following tutorial. So, lets begin with the installation of the necessary modules needed for the Dash Player.
Also keep in mind that TMT Digital provides a Complete Integration Service. We would love to take care of whatever needs you have to get your project off the ground.
Please click on the topics below...
To use the Dash Player in the Drupal System, it is required that you install 3 different modules, the Services Module, AMFPHP, and the Dash Player Module. The Services module is a fantastic module that interfaces a remoting gateway for your Drupal CMS. Basically what this means is that it allows outside components to remotely call functions in your Drupal system to retrieve information. This is how the Dash Player communicates to your Drupal CMS. Using this method provides a number of benefits not available in other commercial players, which makes this player very unique. So, lets begin by following the following steps...
Old Services for Drupal 6: http://ftp.drupal.org/files/projects/services-6.x-0.11.tar.gz
Old Services for Drupal 5: http://ftp.drupal.org/files/projects/services-5.x-0.91.tar.gz
After you do this, you will then need to provide the api key with the parameters that you pass to the DMP like the following... Keep in mind that the following code is only used if you are using the older version of Services.
<?php
$params['width'] = 652;
$params['height'] = 432;
$params['playlist'] = 'videos';
$params['api'] = 1;
print dashplayer_get_player($params);
?>This next step is really depending on what your requirements are... For our example, I wish to show videos in my player, have voting capabilities within the player, as well as keep track of the view counter. For this example, we will use the following Drupal Modules to achieve this. Download and install the following modules...
Once you have these installed, you are ready to move onto the next steps...
To install the Dash Player for use in the Drupal System, you must first download the latest version at http://www.tmtdigital.com/project/dash_player. You can click on the download link at the bottom of the page.
Once you have the package downloaded, you should extract the file on your local hard drive. In this file you will see the following...
Basically the next step after you download and extract the file is to place the contents on your server within the root of your Drupal install (the root of the Drupal files is where the index.php file is...). To keep everything as simple as possible and for clarity sake, I will go ahead and say to create a "player" folder in your root directory of your Drupal install and place the contents of this package in there... So basically, your directory structure should look like the following.
Now that you have the files in the right place, the next step is to go into your Drupal Administrator under "Dash Player" and set the correct path for the Dash Player SWF file. For our example, we would provide http://{yoursite}/player/dashPlayer.swf, and of course, replace {yoursite} with the URL of your domain. This will then set up the Dash Player API to point correctly to your player.
Now that you have completed these steps, it is time to move onto the next part... Configuring the Services Module and Dash Player to show your content!
This next step is VERY important... In order to get the Dash Player to work with the Services Module, you must first configure the Services for an outside component to communicate... Please follow these steps to configure your services module correctly.
| Drupal root | Allowed Domain |
|---|---|
| http://www.mysite.com | www.mysite.com |
| http://mysite.com | mysite.com |
| http://www.mysite.com/subdir | www.mysite.com/subdir |
| http://mysite.com/subdir | mysite.com/subdir |
| http://localhost | localhost |
| http://localhost/subdir | localhost/subdir |
<flashvars>
<drupalversion>6</drupalversion>
</flashvars><params>
<license><!-- Enter your License here --></license>
<gateway>http://www.mysite.com/services/amfphp</gateway>
<apiKey>123456789012345678901234567890</apiKey>
<baseURL>http://www.mysite.com</baseURL>
<flashvars>
<drupalversion>6</drupalversion>
</flashvars>
</params>
After you have done this, your player is now configured for your site. This next step is only if you wish to have the view counter work on your site... You can skip it if you like...
Ok, you are ready to move onto the next step...
Our next step is to create a new node type that you would like to use to show in the Dash Player. Depending on what media module you are using to create your media nodes, you might not have to do this step, but it is here if you need it. For our example, we are going to create a "video" node type which will let us upload videos and show them in the player.
The first step is to go to Administer >> Content Types
After you are there, we will want to create a new content type, so click on the link that says Add content type.
This will take you to a new page where you can then tell Drupal about the new content type that you would like to create. Since we are wanting videos, you will simply type "Video" for the name and "video" for the Type. You can leave the Description blank if you really want to.
Also, make sure that you have the Attachments checkbox checked to allow attachements to the node type.
From there, just go down to the bottom and press Save Content Type.
Now that you have set up the node type that you would like to use, the next step is to associate the FlashVideo module with this node type. You do this by following these steps...
So you are now set up to upload videos. You can test this out by going to Create Content >> Video. You should see it ask for a "Video Upload". Go ahead and test it out by creating several different video nodes. After you have done this, you will then need to Run cron manually by going to the Administer >> Status Report and then clickin on Run cron manually.
After you are done with this, you are now ready to move onto the next step which is to set up the Views module.
Now that you have a new "video" content type and have uploaded your videos, the next step is to set up a View of your video content to act as the playlist. Lets begin by going to Administer >> Views.
This next step differs whether you are using Views 2 (for Drupal 6) or Views version 1 (for Drupal 5). I will separate how to do both of these in the sections below... please pick the implementation that fits your version.
Once you are in the Views administrator section, you will then want to create a new view by clicking on the link that says Add. After the new view page comes up, please follow the following links to add a new view for your videos...
Once you are in the Views administrator section, you will then want to create a new view by clicking on the link that says Add. After the new view page comes up, please follow the following links to add a new view for your videos...
You can now use the parameter "playlist=videos" whenever you are embedding the video in your page... For example, this should now work...
<?php
$params['width'] = 652;
$params['height'] = 432;
$params['playlist'] = 'videos';
print dashplayer_get_player($params);
?>Ok, now this is the fun part... seeing the result.
Click on Create Content >> Page.
Down in the body, you will then place the following code to show the Dash Player...
<?php
$params['width'] = 652;
$params['height'] = 432;
$params['playlist'] = 'videos';
print dashplayer_get_player($params);
?>This section is dedicated to all the advanced functionality of the Dash Player.
The Dash Player was written to be completely customized. One great feature that I added to this player is the ability to add your very own custom fields to the player using CCK. This allows you to add your own data to the player and show that information anytime that someone clicks on a teaser in the playlist. Below you will find the steps you need to add your very own fields to the Dash Media Player.
This step is fairly trivial. Let us suppose that we wish to not only show the title in the Dash Player, but would also like to have a description as well. To do this, let us first create a description field using CCK. Follow these steps to do this...
Our next task is to let the player load this data... we do this by simply creating a new text field in our skin file. To do this we will need to have Flash CS3 Professional
so that we can edit the skin provided in the download. Once you have Flash CS3, you are ready to start editing the Dash Media Player skin...
The first thing that you will need to do here is follow the tutorial at http://www.tmtdigital.com/node/140. Here it describes the steps to create your own skin. Once you have done that, you can do the following to add your custom CCK field to the player...
Because the Dash Player uses the Views Module to construct its playlist, so many options can be made to control how your playlist is views and filtered to your viewers. Lets suppose that you wish to have a sorting mechanism for your playlist by specifying a weight for each one of your nodes and wish the playlist to show them in that order... Fortunate for you, the Dash Player in conjunction with the Views and CCK modules, this can be done rather easily. So, below are the steps that you need to follow to allow your playlist to be sorted by your command.
This tutorial assumes that you already have a view set up to show your nodes... If you have not done this already then I highly suggest going to Setting up a playlist using the Views Module tutorial first. It is also assumed that you already have the Views Module, but there is one more module that you will need for this tutorial, and that is the amazing CCK (Content Construction Kit) Module. This module will allow us to create a special field in your media node type that we will use to sort your content. Once you have this module downloaded and installed, you are ready to move onto the next step.
The first step that we will want to do is create a weight field for your node type. You do this by going to Administer >> Content Types and then clicking on your media type that you would like to add the weight too. Once you are there, you will then follow the following steps.
$values = array();
for($i=-10; $i<11; $i++) {
$values[$i] = $i;
}
return $values;The next and final step is to add this weight field in the Sort Criteria for your view. You do this by going to the view that you set up as your playlist and clicking on the Edit tab. Once you are ar in the edit section of your view, you will want to go down to the bottom where it says Sort Criteria. In the drop-down box, you will then want to select Integer: Weight (field_weight) and then press Add Criteria. And now you are done! You can then go and test this out by editing some of your media nodes and setting the weight value. You should then see them sort in your playlist based on the weight you provided!
This tutorial will go over the steps to reproduce what I did in my Audio Showcase. Please note that this only applies for Drupal uses with the Dash Media Player.
The next step is to install all the modules used in this tutorial. Make sure you install the following...
Now that you have the content type set up, the next important step is to create a view that the player will use to show all the audio nodes. You do this by first going to Administer >> Views
The next step is to download the Audio Pro skin by going to http://www.tmtdigital.com/node/694. The skin is free to download and use. Once you have the skin downloaded, you will then need to extract the contents within the skins folder in your Dash Player folder. When you are done, you should then have the skin.swf file located at skins/audiopro/skin.swf
Now that you have your site configured to add audio nodes to your Drupal system, the next step is to install the player to show the audio playlist. You will do this by first going to Create Content >> Page and then in the body, you will paste the following PHP code....
<?php
$params['width'] = 520;
$params['height'] = 111;
$params['skin'] = 'audiopro';
$params['playlist'] = 'audio';
$params['autostart'] = 'true';
print dashplayer_get_player($params);
?>Now it is time for the fun part... to start adding the music!
This tutorial will walk you through how to set up the Remote Playlist Feature. The remote playlist feature uses JavaScript to serve as a communication gateway between two different SWF objects on the page at any given time. If you are using Drupal, you will need to upgrade to the latest version of the Dash Player module by going to http://www.drupal.org/project/dashplayer. Once you have upgraded, you will then notice that there is a new JavaScript file that is included with this module called dashPlayer.js. This is the file that is used as the communication gateway between any two SWF objects on the page. The good news is that is ALL you need to know. The second you use the Dash Player API to insert an object onto the page, the dashplayer module will add the dashPlayer.js file for you. All you have to do now is understand HOW to make the connections.
Surprisingly, implementing this remote playlist feature is very simple. You basically just need to give your Playlist an id, your Player an id, and then use the connect parameter to connect both of them together. This is done with two new parameters called id and connect. You also need to indicate to the Dash Media Player that you are using a Playlist or a Player. This is done with two more parameters, playlistonly if you just want it to show the playlist, and disableplaylist on the player to say you do not want to show the playlist (since the playlist is actally somewhere else on the page. Let me give an example to illustrate...
Let us suppose that you wish to have your player in the main section of the page, and then have your playlist in a Block to the side of this main player (exactly like how I did in my showcase at http://www.tmtdigital.com/remoteplaylist). So, let me walk you though step by step how to achieve this setup. Before I begin, though, I am assuming that you have an understanding on how to set up a view and link the Dash Media Player to that view in Drupal using the playlist argument. Let's get started.
<div style="text-align:center">
<?php
$params['id'] = 'dashvideo';
$params['connect'] = 'dashplaylist';
$params['width'] = 550;
$params['height'] = 420;
$params['disableplaylist'] = 'true';
print dashplayer_get_player($params);
?>
</div><div style="text-align:center;">
<?php
$params['id'] = 'dashplaylist';
$params['connect'] = 'dashvideo';
$params['width'] = 200;
$params['height'] = 520;
$params['playlist'] = 'videos';
$params['playlistonly'] = 'true';
print dashplayer_get_player($params);
?>
</div>Another great feature of the Dash Player is that it was built to read some specific CCK fields that basically act as a replacement for an actual media file being attached to that node. You can use this if you have the paths to your files, but don't necessarily want to attach that media to your node. You can do this by using the CCK (Content Construction Kit). There are two special fields that you need to create that will represent both a playable media and image... These fields are as follows...
| CCK Field ID | Type | Description |
|---|---|---|
| dashplayer_media | Text | Use this to pass a playable media file path to the Dash Player |
| dashplayer_image | Text | Use this to pass a preview image file path to the Dash Player. |
One HUGE benefit in using the Drupal CMS with the Dash Player is that you can completely control the playlist using the Views module. Basically the Views module allows you to filter your content. One way that the views module filters content is through the powerful use of Views Arguments. Basically what this means is that it allows you to pass in certain arguments to the views which it in turns uses as a filtering mechanism for your content.
Let me give you an example... Suppose you wish to have 1000 different videos on your site that can fall into several categories (comedy, action, thriller, etc). Using any other Media Player available, you would need to literally code your own personal filtering mechanism if you wished to show a playlist for only the comedy videos. Not to mention, you would need to show them ALL!! What if there are 1000 different comedy videos alone?! Any other media player would require you to then filter it some more, unless of course, you want to show 1000 different videos in your playlist possibly bringing your users computer to its knees.
Well, good thing you have the Dash Player... Not only can you provide this filtering mechanism using the Views module, but also the Dash Player uses a playlist paging mechanism that will only query for a pages worth of content at a time! Pretty slick, huh? So, lets get started setting up that view. I am assuming that you have already been through the process of Setting up a View for your player. We will also, for the sake of this example, assume you wish to categorize your videos as "Comedy", "Thriller", and "Action". This will at least give you the idea how to do this...
Ok, now that our view is set up, the last and final step is to provide the argument in your player to show the right playlist depending on the argument. You do this by using the arg flashvar followed by the argument number (1,2,3,etc). So, for example, if we wish to show a playlist that only shows the Comedy videos, since this is the first argument, we would just use the following PHP in our Page (make sure you change the Input Format to accept PHP)...
<?php
$params['width'] = 652;
$params['height'] = 432;
$params['playlist'] = 'videos';
$params['arg1'] = 'comedy';
print dashplayer_get_player($params);
?>When you press submit on the page, you will get a wonderful surprise!!! It is only showing the comedy vidoes!! Now if you want to really take it to the next level, I highly suggest checking out the tutorial on Creating Dynamic Playlists.
This is probably the most powerful feature of the Dash Player (besides the Remote Playlist Support, of course...). Having Dynamic Playlists basically means that your users can select how they wish to filter the playlist content by simply clicking on links in your player. And guess what... all this is built into the player! Before beginning this tutorial, it is imperative that you follow the steps on Using Views Arguments for your Playlists. This tutorial will pick up where that one left off... So lets begin.
Allowing for dynamic playlists is completely a player feature using the use of three different flashvars, linkarg, linktext, and linkindex. For an exact description of what these flashvars do, I highly recommend that you visiting the FlashVars Table. So, lets go ahead and add all of our Views arguments so that the user can dynamically select them... Using the example from Views Arguments tutorial, lets suppose that you wish to have three links on the playlist that allows the USER to select which videos they would like to see... you would use the following code.
<?php
$params['width'] = 652;
$params['height'] = 432;
$params['playlist'] = 'videos';
$params['linkarg1'] = 'comedy';
$params['linktext1'] = 'comedy';
$params['linkindex1'] = '0';
$params['linkarg2'] = 'action';
$params['linktext2'] = 'action';
$params['linkindex2'] = '0';
$params['linkarg3'] = 'thriller';
$params['linktext3'] = 'thriller';
$params['linkindex3'] = '0';
dashplayer_get_player($params);
?>Now that's cool!!!
This page will go through the complete checklist that you need to get the Dash Player to work. Of course, I will not go into detail what each of these topics means, but you can get that information by walking through the step-by-step tutorial on how to install this player in your system.
$params['api'] = 1;<!-- and --> from the opening and closing tags before putting the parameter in. If you put the parameter inside these special tags, it will not work.$params['playlist'] = {yourview}; where you would replace the {yourview} with the view that you set up to show your media.<?php
$params['width'] = 652;
$params['height'] = 432;
$params['playlist'] = 'videos';
print dashplayer_get_player($params);
?>The Dash Player supports many avenues for deployment, including HTML embedding. If you are a web publisher and have a site that is not governed by a CMS, I will first try my best to motivate you to explore the benefits of using a CMS. However, it is not necessary... You absolutely can use the Dash Player without any CMS support. Below, you will find the steps necessary to get started using this player in the good ol' fashion HTML environment.
You can embed the Dash Player much like you can any other player... using the <object> tag. Below you will find an example of how you can embed the Dash Player in your website.
<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="640" height="420" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab">
<param name="movie" value="dashPlayer.swf" />
<param name="wmode" value="transparent" />
<param name="allowfullscreen" value="true" />
<param name="FlashVars" value="file=http://images.apple.com/movies/us/hd_gallery/gl1800/nasa_shuttle-r_m720p.mov" />
<param name="quality" value="high" />
<embed allowScriptAccess="always" src="dashPlayer.swf" width="640" height="420" border="0" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" wmode="transparent" allowfullscreen="true" quality="high" flashvars="file=http://images.apple.com/movies/us/hd_gallery/gl1800/nasa_shuttle-r_m720p.mov" />
</object><param name="FlashVars" value="file=...." />. The FlashVars are a VERY powerful way to command the video player to do all kinds of cool stuff with your videos. So, lets move onto the next step... Understanding the FlashVars.Since version 1.2.1, the Dash Media Player is packaged with a stand alone PHP interface for using the Dash Media Player in your website using the same API available for Drupal CMS. When you download the new Dash Media Player package, you will notice the following files...
<?php
include ('/player/dash.php');
?>
The first thing that you will want to do is first copy all the contents from the downloaded Dash Media Player package to your server. I recommend creating a player directory in your root directory to contain all the contents of the downloaded player files. After you have these files in your web root, you can then start adding files to the default playlist directory. Each different track should be in its own folder that begins with track and followed by the track number. For example, if you wish to show a playlist with three different songs, then your directory structure would look like the following...
Now that you have your tracks in the directories they need to be, the next and final step is to show the player on your page. You do this using the following PHP code in your php file.
<?php
include ('player/dash.php');
print dashplayer_get_player();
?>Adding new songs to your playist is VERY easy... Simply create a new track folder in the playlists/default folder followed by the number which is the play order of the track in the playlist. For example... If I wish to add a new song that is position 4 in my playlist, then I would simply create a new folder in my default playlists folder called track4, and then place my image and media file in that directory. YES, IT IS THAT EASY!!!
It is very important to note that when you add a new track by creating a new track directory in your playlist, you need to delete the cache XML file out of the cache folder in order for that change to take effect. Then this XML file will get regenerated the next time you show the Media Player in your page.
Adding new playlists is just a simple as adding a new directory in the playlists folder, and then after that add the track folders that you normally would with the default playlist folder. Then, once you have done that, you will then add the playlist parameter to the dashplayer_get_player API, like this...
<?php
include ('player/dash.php');
$params['playlist'] = 'myplaylist';
print dashplayer_get_player($params);
?>The Dash Players functionality and behavior is governed through the use of Flash Variables (or commonly referred to as FlashVars). In order to use these variables to change the behavior of the player, you must provide each of these arguements in the "flashvar" parameter when you embed the player in your page (see code below). If you are using Drupal, then you can use the API provided in the Dash Player Module to add parameters to the player. Below, you will see the two scenarios how you can change the behavior for the Dash Player.
The following code is just a sample on how parameters can be passed to the DashPlayer Module API to show a player using the any of the parameters listed below... Also, please note that the Drupal API allows you to also specify the width and height of the player in with the parameters. The API is smart enough to not add those to the FlashVars, but change the width and height in the embed code to show the player at that given size.
<?php
$params['config'] = 'videos';
$params['width'] = 640;
$params['height'] = 480;
$params['playlist'] = 'my_videos';
$params['arg'] = 'comedy';
$params['autostart'] = 'false';
print dashplayer_get_player($params);
?>You can still provide flashvars to your player without using the DashPlayer API. To do this, you need to add these parameters in the HTML object code that you use to embed the player. The following HTML is a reference on how you can achieve the same result from above using just HTML.
<object classid="clsid:D27CDB6E-AE6D-11cf-96B8-444553540000" width="640" height="480" codebase="http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab">
<param name="movie" value="dashPlayer.swf" />
<param name="wmode" value="window" />
<param name="allowfullscreen" value="true" />
<param name="FlashVars" value="config=videos&playlist=my_videos&arg=comedy&autostart=false" />
<param name="quality" value="high" />
<embed allowScriptAccess="always" src="dashPlayer.swf" width="640" height="480" border="0" type="application/x-shockwave-flash" pluginspage="http://www.macromedia.com/go/getflashplayer" wmode="window" allowfullscreen="true" quality="high" flashvars="config=videos&playlist=my_videos&arg=comedy&autostart=false" />
</object>Below you will find a listing of all available flash variables that the player accepts
| FlashVar | Type | Default | Requirement | Description | Example |
|---|---|---|---|---|---|
| api | Number | 3 | Drupal | Used to specify which Services API you are using. For Drupal 6 versions 0.9 or less, or Drupal 5 versions 0.91 or less, you should use api=1 |
|
| arg | String | Drupal | Used as an argument for the view being used as the playlist (see above). You can use this to create a filter system so that the player will only play certain content based on the argument provided to that view. If you wish to provide more than one argument, you must follow the word "arg" with the argument number you wish to provide, where 1 is the first argument. See example for a sample of this functionality. |
| |
| autohide | Boolean (true|false) | true | A way to disable the auto hide feature where the playlist hides when the player is sized below a certain threshold. | autohide=false | |
| autoload | Boolean (true|false) | true | Allows you to tell the player to automatically load the video or audio track when the teaser or page is refreshed. If you wish to save bandwidth, or if you wish to only load the video or audio when your user actually clicks play, then you should set this variable to false. | To only load the video or audio when the user clicks play, you should specify autoload=false | |
| autonext | Boolean (true|false) | true | Tells the player to automatically play the next media after the one currently playing finishes. | autonext=false | |
| autostart | Boolean (true|false) | false | Used to indicate to the player to automatically play the media on load or not. | autostart=true | |
| bufferlength | Number | 5 | Used to change the amount of time to buffer the media track before playing. | To have a 10 second buffer, you would provide bufferlength=10 | |
| cache | Boolean (true|false) | true | Tell the player if it should play (or show) a cached version of the media or not. | ||
| color | Number (RGB) | Used in conjunction with the "theme" parameter to specify the colors to use in the theme. This allows for dynamic themeing of the Dash Player. | color1=1234567&color2=246813 | ||
| config | String | dashconfig | Allows you to switch player configuration XML files located in the "config" directory. | To use the videos.xml configuration file located in the "config" directory - config=videos | |
| connect | String | Allows you to link an id for any other player on the page to allow for Remote Playlist Support | If you wish to link up the the playlist that has an id of dashplaylist, you would just provide connect=dashplaylist | ||
| controlbaronly | Boolean (true|false) | false | Allows you to only show the Control Bar. This is useful when using the Remote Control feature shown at http://www.tmtdigital.com/remotecontrol | ||
| controlbarskin | String | controlbar | Allows you to change the skin your control bar is using when you use the controlbaronly=true parameter. | ||
| delay | Number | 0 | Used to add a delay before the media plays. You can use this variable if you wish to show the intro image a couple of seconds before auto-playing a video track. | ||
| disableembed | Boolean (true|false) | false | Allows you to disable the embed feature on the player. | disableembed=true | |
| disablemenu | Boolean (true|false) | false | Will disable the menu of the player. It will hide the menu section along with the menu button in the control bar. | disablemenu=true | |
| disableplaylist | Boolean (true|false) | false | Will disable the playlist of the player. It will hide the playlist along with the playlist maximize button in the control bar. | disableplaylist=true | |
| drupalversion | Number | 5 | Allows you to provide the version of Drupal you are using. It is recommended that you provide a value here, as it will save approx 1 second of your load time. If you do not provide this value, then the player will query your server to retrieve its value (hence the time spent) | drupalversion=6 | |
| embedheight | Number | 267 | The height of the player when the player is embedded (using the embed code). | embedheight=350 | |
| embedwidth | Number | 320 | The width of the player when the player is embedded (using the embed code). | embedwidth=450 | |
| file | String | Used to specify any file for the Dash Player to play. This can either be a media file (image, video, or music) or an XML file that is used as the playlist for the player. This player supports playlists in the RSS, XML, or ASX formats. |
| ||
| flashonly | Boolean (true|false) | false | If true, then the player will only play videos that are the FLV format. | ||
| id | String | The id of this player. This can be used in conjunction with the connect variable to set up a Remote Playlist system. | To give your player an id of dashplayer, you would just provide id=dashplayer. | ||
| image | String | Variable to show an image in the media section during or before a media is playing. | image=http://www.mysite.com/files/image.jpg | ||
| intro | String | Allows you to pass the path of a video or an audio track to be used as the intro for the entire media playlist or single media playing. | intro=http://www.mysite.com/files/intro.flv | ||
| link | String | License | Variable to show a custom logo on the Player. You must purchase a valid license in order for this feature to work | logo=http://www.mysite.com/files/logo.jpg | |
| linkarg | Variable | Drupal | Using the "link" variables will show the dynamic playlist link section that shows the tabs at the top of the playlist. You can use this along with the 2 following arguments to create a dynamic playlist. This variable is the argument that is passed to the view when the tab is pressed. |
| |
| linkalltext | String | all | Drupal | The text to show in place of the "all" tab when the playlist links are showing. | linkalltext=everyone |
| linkindex | Number | Drupal | This "link" variable is used to indicate the Drupal View argument index of this link. |
| |
| linktext | String | Drupal | This "link" variable will set the text inside of the tab |
| |
| linksvertical | Boolean | false | This argument will let the player know if your playlist links are vertical or not. | If your skin has a vertical playlist, you would simply say linksvertical=true | |
| logo | String | License | Variable to show a custom logo on the Player. You must purchase a valid license in order for this feature to work | logo=http://www.mysite.com/files/logo.jpg | |
| logopos | String | BL | Allows you to change the location of the logo. The following strings are valid locations..
| To set the logo in the Upper Right hand corner - logopos=UR | |
| logowidth | Number | License | Used to scale the logo based on the width. The height is then set to retain the same ratio. | To resize the logo - logowidth=150 | |
| logox | Number | 2 | The X Offset for the logo position. | To move the logo 10 pixels in the X direction - logox=10 | |
| logoy | Number | 2 | The Y Offset for the logo position. | To move the logo 10 pixels in the Y direction - logoy=10 | |
| loop | Boolean (true|false) | false | Tell the player to loop back to the beginning when it is through playing either a single file or a playlist. | ||
| magnify | Boolean (true|false) | false | Will magnify the playlist using a magnification hover effect. | ||
| menu | String | default | Allows you to replace the current player menu with a separate menu flash application. This will look within the plugins/menus folder and find a directory with the same name as the menu provided with this parameter and then load that SWF contained within that directory to be used as the new menu. See the default menu provide for an example. | ||
| node | Number | Drupal | Used to tell the player to show the content from only one given Drupal Node. | To only show the node with an ID of 24 - node=24 | |
| pagelimit | Number | 10 | How many teasers are shown in each page of the playlist. | pagelimit=20 | |
| pagelink | Boolean (true|false) | false | Allows you to tell a playlist to link to a URL page when the user clicks on the teasers. The argument to that URL is specified by pagelinkarg followed by the Node ID of the teaser being loaded. This will only work if you use the playlistonly variable. | pagelink=true | |
| pagelinkarg | String | q=node/ | Allows you to change the argument passed to the URL when the user clicks on the teaser and you are using the pagelink variable. If you are using Drupal, then you should just keep this as it is. | To change the URL when the user clicks on Node 10 to open up the page http://www.mysite.com?id=10, you would use pagelinkarg="id=" | |
| playlist | String | Drupal | Variable that is used to indicate the View in the Drupal system which represents the playlist of this player. Along with providing this parameter, you can also pass arguments to your view by using the "arg" flashvar to allow for playlist filtering. | For a View named "my_videos" - playlist=my_videos | |
| playlistlogo | String | License | Variable to show a custom logo on the Playlist bar. You must purchase a valid license in order for this feature to work | logo=http://www.mysite.com/files/logo.jpg | |
| playlistsize | Number | 205 | The width or height of the playlist depending if you have the vertical flashvar set to false or not. Using this FlashVar allows you to tile the playlist if you set the playlistsize larger than the width or height of the teaser. | If you wish to have the playlist have 2 columns of teasers, and the teasers are 100 pixels wide, you would set this parameter to 200. | |
| playlistskin | String | playlist | The skin that you would like to use for your separated playlist. This is used for the Remote Playlist support where you can have a vertical or horizontal playlist. | If you wish to use the hplaylist.swf skin for your playlist you would just use playlistskin=hplaylist for the flashvar. | |
| postreel | String | Allows you to provide a video to be played after each video is played. | |||
| preloader | String | default | Allows you to replace the current player preloader with a separate preloader flash application. This will look within the plugins/preloader folder and find a directory with the same name as the voter provided with this parameter and then load that SWF contained within that directory to be used as the new pre-loader. See the default preloader provide for an example. | ||
| prereel | String | Allows you to provide a video to be played before each video is played. | |||
| scalevideo | Boolean (true|false) | false | Allows you to turn off video scaling. This improves video quality at the expense that the player must be sized according to the video being played instead of the video being sized to the player. | scalevideo=false | |
| seekvertical | Boolean (true|false) | false | To specify if you skin has a vertical seek bar or not... can't imagine it, but it is there if you need it. | ||
| service | String | Allows you to provide external 3rd party services (such as Drupal) to provide the content within the player. This will look within the plugins/services folder and find a directory with the same name as the service provided with this parameter and then load that SWF contained within that directory to be used as the service. See the Drupal service provide for an example. | |||
| showcontrols | Boolean (true|false) | true | Show or Hide the player control bar. | showcontrols=false | |
| showinfo | Boolean (true|false) | true | Show or Hide the information section (which includes the Title, voter, etc). | showinfo=false | |
| showplaylist | Boolean (true|false) | true | Will initialize the player to hide or show the playlist. | showplaylist=false | |
| shuffle | Boolean (true|false) | false | Used to tell the player that you would like to select the elements to play at random instead of in synchronously. | If you would like to shuffle the playlist as they play, then you would say shuffle=true. | |
| skin | String | Used to specify which skin you would like for the Dash Player to use. A skin can be any external SWF file that you have in your "skins" directory. You should not use the ".swf" extension when specifying the skin. When you specify this flashvar, the player will then look for a directory of the same name within the "skins" folder. There must be a "skin.swf" file within that directory for this to work correctly. | If you wish to use the "myskin" SWF file in the "skins/myskin" folder, you would simply use skin=myskin. | ||
| spectrum | String | revolt | Will add the spectrum analyzer provided within the plugins directory when an audio track is playing. | ||
| spinner | String | default | Allows you to replace the current player spinner with a separate spinner flash application. This will look within the plugins/spinners folder and find a directory with the same name as the menu provided with this parameter and then load that SWF contained within that directory to be used as the new spinner. See the default spinner provide for an example. | ||
| streamer | String | Used to indicate the RTMP stream source. | |||
| taggingenabled | Boolean | false | Drupal | Allows you to enable or disable the media free tagging support. This feature is only available for Drupal installations. | To enable free tagging support, just provide taggingenabled=true. |
| taglinkcolor | uint | 0x0000FF | Drupal | Allows you to provide the hover color for the free tagging links. | To change the hover color to red you would say, taglinkcolor=0xFF0000. |
| tagplaylist | String | Drupal | Allows you to provide a separate playlist for the free tagging links. | tagplaylist=tagging_videos. | |
| theme | String | Used to specify which theme you would like for the Dash Player to use. It uses this flashvar to then look for a directory of the same name within the "themes" folder within the skin you are using. There must be a "theme.xml" file within that directory for this to work correctly. | If you wish to show the "green" theme which would simply be a "green" directory within the "skins/{yourtheme}/themes" folder, then you would simply say theme=green. | ||
| tween | String | strong_easein | Allows you to change the Tween method used for the hiding and showing of the playlist. The tween methods are determined by the Tween Class ("Strong", "Elastic", etc), and the Tween type ("easein", "easeout", etc). You then put these together (all lowercase) and separated by an underscore. | To change the playlist tween to be "Elastic.easeIn" - tween=elastic_easein | |
| tweentime | Number | 10 | The length (in time) of the tween operation being performed. | To make it slower - tweentime=15 | |
| vertical | Boolean (true|false) | true | Used to specify if your skin has a vertical playlist or not. | If you wish to have your playlist be horizontal in your skin, you would simply use vertical=true. | |
| viewsenabled | Boolean (true|false) | true | Drupal | Disable or Enable the view counter for the player. | viewsenabled=false |
| volume | Number | 80 | What volume to initialize the player to. | volume=50 | |
| volumevertical | Boolean (true|false) | false | To specify if your skin has a vertical volume bar | ||
| voter | String | default | Allows you to replace the current voter with a separate voter flash application. This will look within the plugins/voters folder and find a directory with the same name as the voter provided with this parameter and then load that SWF contained within that directory to be used as the new voter. See the default voter provide for an example. | ||
| votingenabled | Boolean (true|false) | true | Drupal | Disable or Enable the player voting mechanism. | votingenabled=false |
The Dash Player also supports the creation of playlists using XML or RSS. This allows web publishers who are not using a CMS (content management system) to create playlists that show up in the player. You can specify any XML playlist by simply passing the path or URL to the player using the file flashvars (go to http://www.tmtdigital.com/flashvars for more information on what flashvars can be used).
These playlists can be in 3 different formats... XML, RSS, or ASX format. Each of these formats look different but basically do the same thing. Below you will find samples of how you can construct a playlist using each of these three different formats.
The cool thing about using RSS is that it is the standard used for Podcasting as well as online syndication. The Dash Player will gladly show content from any RSS feed or syndication. The RSS format looks like the following...
<rss version="2.0" xmlns:media="http://search.yahoo.com/mrss">
<channel>
<item>
<title>10cc - Dreadlock Holiday.mp3</title>
<media:content url="http://tmtdigital.com/files/Dreadlock Holiday.mp3" type="audio/mpeg"/>
<media:thumbnail url="http://tmtdigital.com/files/Folder.jpg"/>
</item>
<item>
<title>Dobie Gray - Drift Away.mp3</title>
<media:content url="http://tmtdigital.com/files/Dobie Gray - Drift Away.mp3" type="audio/mpeg"/>
<media:thumbnail url="http://tmtdigital.com/files/straits.jpg"/>
</item>
</channel>
</rss>An XML Playlist uses basically the same principle, but just a little different format. Below you will find how I can have the exact same playlist, but using XML Playlist format.
<?xml version="1.0" encoding="UTF-8"?>
<playlist version="1" xmlns="http://xspf.org/ns/0/">
<trackList>
<track>
<title>10cc - Dreadlock Holiday.mp3</title>
<location>http://tmtdigital.com/files/10cc - Dreadlock Holiday.mp3</location>
<image>http://tmtdigital.com/files/Folder.jpg</image>
</track>
<track>
<title>Dobie Gray - Drift Away.mp3</title>
<location>http://tmtdigital.com/files/Dobie Gray - Drift Away.mp3</location>
<image>http://tmtdigital.com/files/straits.jpg</image>
</track>
</trackList>
</playlist>Same concepts as above... but again, different format.
<asx version="3.0">
<entry>
<title>10cc - Dreadlock Holiday.mp3</title>
<ref href="http://tmtdigital.com/files/10cc - Dreadlock Holiday.mp3"/>
<param name="image" value="http://tmtdigital.com/files/Folder.jpg"/>
</entry>
<entry>
<title>Dobie Gray - Drift Away.mp3</title>
<ref href="http://tmtdigital.com/files/Dobie Gray - Drift Away.mp3"/>
<param name="image" value="http://tmtdigital.com/files/straits.jpg"/>
</entry>
</asx>The Dash Player does have support for Commercials. Basically what this means is it allows you to provide a playlist entry which is tagged as a commercial, and the player will then disable the controls for that video as well as automatically move onto the next video. It will also not include the commercial in its standard playlist, which is how you would expect it to work.
For the time being, much development is being made to support the server side of things regarding commercials, but this means that you will need to provide your commercials manually in the playlist. You do this using the Playlist XML format shown in the page before this one. You will then provide an album tag which will indicate that this is a commercial video. The following code shows how this can be done...
<playlist version="1" xmlns="http://xspf.org/ns/0/">
<trackList>
<track>
<title>This is a Commercial</title>
<location>http://www.tmtdigital.com/files/commercial.flv</location>
<album>commercial</album>
</track>
<track>
<title>10cc - Dreadlock Holiday.mp3</title>
<location>http://tmtdigital.com/files/10cc - Dreadlock Holiday.mp3</location>
<image>http://tmtdigital.com/files/Folder.jpg</image>
</track>
</trackList>
</playlist>