Introduction
The Internet Information Services 7.0 (IIS 7.0) Media Pack – Bit Rate Throttling module provides the ability to throttle progressive downloads of media files (in which audio/video playback starts as soon as sufficient data has been buffered on the client) based on the content bit rate. For sites that deliver audio and video files that may not be watched in their entirety, this module could significantly reduce your media-related bandwidth costs. A secondary feature of the Bit Rate Throttling Module is that it can also be used to throttle non-media ("Data") file types at specified bit rates.
For media files, automatic bit rate detection and throttling are executed according to settings specified in the IIS 7.0 configuration settings. New settings can be added, and existing settings can be tweaked, to achieve significant bandwidth savings without compromising user experience. The media throttling settings can only be applied to defined media file types, so the Bit Rate Throttling module also provides a way to extend support to other media file types, or override the definitions for existing file types, through an extensible XML schema interface.
The list of supported media file types is determined by the settings in the IIS configuration file. By default, the IIS 7.0 Bit Rate Throttling module comes with pre-configured support for the following media file types:
- .asf
- .avi
- .flv
- .m4v
- .mov
- .mp3
- .mp4
- .rm
- .rmvb
- .wma
- .wmv
This article contains:
Scope
This article will detail the steps needed to configure the IIS 7.0 Media Pack – Bit Rate Throttling module at the server, site, virtual directory, and file levels.
Prerequisites
The following items are required to complete the procedures in this article:
Verifying That Bit Rate Throttling is Working
To ensure that you have already installed the Bit Rate Throttling module, open the Internet Information Services (IIS) Manager window (shown below). Click a server in the Connections pane. On the Home Page (displayed in the central pane), you see an area titled "Media" with a Bitrate Throttling icon below it. This indicates that you are ready to verify that Bit Rate Throttling is working.
If you still have the Default Web Site on your IIS 7.0 server, follow these instructions to test Bit Rate Throttling. First, download a sample video file to your server that is at least one minute in length. If you do not have any content readily available, right-click the following link to a sample Windows Media Video file and click Save As…
http://download.microsoft.com/download/3/9/0/3902e391-734e-470f-806b-4d779f07749f/PS_DEMO_320x180_1MB.wmv
In the Save As dialog box:
- Set the path to your Default Web Site directory, e.g. C:\inetpub\wwwroot.
- To simplify things, change the file name to test.wmv.
-
Click Save.
When the download to your server is complete, click Close.
On your IIS 7.0 server, open Windows Task Manager (e.g. press Ctrl + Shift + Esc). Click the Networking tab. Assuming you have little network activity, you should see something like the following.
On a client machine that has network access to your IIS 7.0 server, open Windows Media Player, and then launch the Open URL dialog box (e.g. press Ctrl + U). Type in the address of the IIS 7.0 server Default Web Site in the Open field, e.g. http://<yourserver>/test.wmv, as shown below, and click OK.
After nearly two minutes of video clip payback on your client machine, the Networking graph on your IIS 7.0 server should look something like the one below.
We see that there was an initial burst of data to fill the pre-roll buffer on Windows Media Player, followed by a throttled delivery of content at just about 1 Mbps, which is the encoded bit rate of the content.
If these results are similar to those you saw, congratulations! You have successfully installed the IIS 7.0 Bit Rate Throttling module. Now, let us move on to an overview of how to change the default settings.
Configuring Throttling at the Server Level
First, we examine the default Bit Rate Throttle settings, how to add new settings, and how to change existing settings.
1. Click your server in the Connections pane click on Bitrate Throttling in the Home Page pane, and then click Open Feature in the Actions Pane.
2. In the Bit Rate Throttling page, note the ten media file types that are defined by default in the module (see below).
3. Note that each File Type has four attributes associated with it:
a. Throttle Type, which can be either Media or Data (here, each is Media)
b. Fast Start, which defines how much content to blast down to the client to minimize startup latency (in either seconds worth of content for Media file types or kB of content for Data file types
c. Throttle Rate, which defines the download speed of the file upon completion of the Fast Start burst (if applicable)
d. Entry Type (Local or Inherited).
4. Click Add Throttling Setting… in the Actions pane. The Add Throttle Setting dialog box appears.
5. Note that the File Type dropdown has no entries. This is by design. There are ten media file types defined, and each of them already has a default Throttle Setting configured. Adding new media file types requires that you first define those media formats using the extensibility schema in the ApplicationHost.config file. To learn more about how to do this, see the Bit Rate Throttling Extensibility Walkthrough.
6. Enter a new file extension in the File Type box. For example, enter .jpg. (Why choose .jpg? Consider a 6MB progressive JPEG file. With Bit Rate Throttling, the first pass of the file could be blasted down with Fast Start, and the subsequent passes in a throttled manner. Should the end user decide they had started downloading the wrong image after the first pass and cancelled the download, you might save considerable bandwidth by not downloading the rest of the file to them at full connection bandwidth.)
Since the .jpg extension is not a recognized audio or video format, it is assumed to be a Data (non-Media) file type, and only fields in the Data Type Settings section are editable.
7. Since we expect to download progressive JPEG images, and want to see the first pass of the image as soon as possible, check the Fast Start checkbox.
8. Set the Fast Start field to 1000, which is measured in kilobytes (KB) and configures the Bit Rate Throttling module to blast down the first 10KB of each image as fast as the network will allow.
9. Set the Throttle Rate to 5, which configures the Bit Rate Throttling module to download the rest of the file at 500 kilobits per second (kbps).
10. Click OK.
Note that .jpg has been added to the list of File Types.
11. Now, we could add the same throttle settings for jpg by using the MIME type for jpg (MIME type throttling only available in RTW version, the previous CTPs don't have this functionality). Click Add Throttling Setting… in the Actions pane. The Add Throttle Setting dialog box appears
Note: we have changed the grouping below to group by Throttle Type
12. Enter the MIME type for .jpg (image/jpeg) and the same throttle settings as above.
13. Click OK.
14. Click on the .wmv File Type. Note that new Edit and Remove options are available in the Actions pane when a File Type is selected from the list.
15. Click Edit in the Actions pane. The Edit Throttle Setting dialog box appears (below).
Note that the File Type dropdown box and Media Type Settings are pre-populated with the existing .wmv settings. Also note that you can change the .wmv extension to be a Data Type.
16. Change the existing .wmv Fast Start value from 20 to 25, and the Throttle Rate from 100 to 110 (above). This configures the module to quickly download the first 25 seconds worth of content in any given .wmv file as fast as the connection will allow, and then to throttle the rest of the delivery at 110% of the encoded bit rate.
For example, if the end user has a cable connection to the Internet, their connection speed might be 2 Mbps. This is the speed at which the first 25 seconds worth of content will be delivered. If the file was encoded at 300 kbps, the remainder of the file would be delivered at 110% of that bit rate, or 330 kbps. This one-two approach allows the media client to quickly acquire content and start playing it back, and then to continue to deliver it at a rate which should ensure little or no user impact should there be any minor network interruptions later.
17. Click OK. Note that the new settings for .wmv are now shown in the list of File Types.
18. Now, enable the Bit Rate Throttling module by clicking on enable
Summary: In this section, you saw the default server-level settings for Bit Rate Throttling, you added new settings for a Data File Type, and edited settings for a Media File Type.
Configuring throttling at the Site level
In this section, we will take a look at how to add new settings and change existing settings at the Site level in the IIS configuration hierarchy. If you previously evaluated the CTP build of the Bit Rate Throttling module, please note that this section has changed.
IIS 7.0 allows machine administrators to delegate the task of setting and changing configuration to site and application owners. This is done by using web.config files in the content directories. These files can specify configuration sections which will take effect on their level in the hierarchy and downwards. The machine administrator has to explicitly unlock sections at the server (also referred to as global) level, to enable such delegation. By default, most IIS sections (now including Bit Rate Throttling) are not locked at the server level, but are locked down for delegation at lower levels (for example, site, virtual directory).
The initial steps below will help you get started with configuration delegation. See the How to Use Configuration Delegation in IIS7 article for more information on using this functionality.
1. Make sure you have administrative privileges on the machine: By default, you do not have them if you're logged on as a user other than the built-in Administrator account, even if this user was added to the local Administrators group on the machine (this is a new security feature in Longhorn, called LUA, which is beyond the scope of IIS). Make sure to either log on as the built-in Administrator account, or explicitly invoke applications as the built-in Administrator, as needed, using the "runas" cmd-line tool. For example, to launch notepad.exe you could run this command: "runas /user:administrator notepad.exe". You will be prompted for the password of the Administrator account. It's useful to have a command-line window (also referred to as a cmd-box shell) that is already elevated, by running "runas /user:administrator cmd.exe". Every application you run from that cmd-box will be elevated as well, and you will not need to use the "runas" syntax from that cmd-box.
2. Make sure the master configuration file is backed up. Simply copy applicationHost.config to a different file, so that you can restore it later. You will find applicationHost.config under the %windir%\System32\inetsrv\config directory. Note that you will need to be an administrator to do this – see previous bullet.
In applicationHost.config, the Bit Rate Throttling configuration section in the media section group is locked:
<sectionGroup name="media">
<section name="Bit RateThrottling" overrideModeDefault="Deny" />
</sectionGroup>
When the configuration section is locked, Bit Rate Throttling entries at all lower levels will show an Entry Type of Local in the user interface, and any throttling changes you make at those levels will have no effect on throttling. By unlocking this section at the server level, you can modify various Bit Rate Throttling properties in web.config files for lower levels that override the global server settings defined in applicationHost.config. When this section is unlocked, delegation of Bit Rate Throttling is enabled, and Throttling entries at all lower levels will show a default Entry Type of Inherited.
To unlock the Bit Rate Throttling configuration section and enable delegation of this feature:
3. In applicationHost.config, change the Bit Rate Throttling configuration section in the media section group from “Deny” to “Allow”
<sectionGroup name="media">
<section name="Bit RateThrottling" overrideModeDefault="Allow" />
</sectionGroup>
Once you have unlocked the Bit Rate Throttling configuration section of applicationHost.config, the following steps will demonstrate how to make basic throttling changes at the site level.
4. As shown below, click on a Web site in the Connections pane tree view.
5. On the Home Page displayed in the central pane, click on the Bit Rate Throttling icon in the Media area.
6. Click on Open Feature in the Actions pane.
7. In the Bit Rate Throttling page (see below), note the eleven file types that have settings defined for the module, reflecting the changes we made in the “Configuring throttling at the Server level” page of this walk-through. If you were successful in Step 3 of this section, all of these have the Entry Type of Inherited from the Server level.
8. Click on Add Throttling Setting… in the Actions pane.
9. The Add Throttle Setting dialog box appears (below).
10. Note that the File Type dropdown box has no entries. Again, this is by design. There are ten media file types defined, and each of them already has a default Throttle Setting configured. To add new media file types requires that you first define those media formats using the extensibility schema in the ApplicationHost.config file. To learn more about how to do this, see the Bit Rate Throttling Extensibility Walk-through.
11. Enter a new file extension in the File Type box (see below). As an example, enter .dat. (Why throttle .dat files? Perhaps these are large files that do not have a requirement to be downloaded quickly, but you do have a requirement to support a maximum number of concurrent connections. Throttlling very large low-priority files will allow you to scale your servers to server more uses.)
12. Since the .dat extension is not a recognized audio or video format, it is assumed to be a Data (non-Media) file type, and only fields in the Data group box are editable.
13. Since we have no need to blast down the first part of the file, leave the Fast start field at the default value of 0.
14. Set the Throttle rate to 250, which configures the Bit Rate Throttling module to download the rest of the file at 250 kilobits per second (kbps).
15. Click OK.
16. Note that .dat has been added to the list of File Types (see below), with the Entry Type listed as Local. Therefore, this Throttle setting will only apply to this site and levels below it, but not to peer sites or the overall server.
17. Also note that we now have a new Revert to Inherited option in the Actions pane. This allows us to quickly revert all changes we have made at this level in favor of the inherited rules from higher configuration levels. Use the Revert to Inherited option carefully! If you have made changes to several File Types, and just need to revert changes for one of those File Type, make the corrections manually. (For example, if you decided you did not want the .dat File Type defined at the site level, you could simply select it on the Bit Rate Throttling page and then click on Remove in the Actions pane.)
18. Click on the .wmv File Type.
19. Note that new Edit and Remove options are available in the Actions pane when a File Type is selected from the list.
20. Click on Edit in the Actions pane.
21. The Edit Throttle Setting dialog box appears (below).
22. Note that the File Type dropdown box and Media Type Settings are pre-populated with the existing .wmv settings. Also note that you could change the .wmv extension to be a Data Type if you wanted to throttle .wmv files at a flat rate on this site, rather than using automatic detection of the encoded bit rate for each .wmv file.
23. Change the inherited .wmv Fast Start value from 20 to 25, and the Throttle Rate from 100 to 110. This configures the module to blast down the first 25 seconds worth of content in any given .wmv file at the site level as fast as the connection will allow, and then to throttle the rest of the delivery at 110% of the encoded bit rate.
24. Click OK.
25. Note that the new site level settings for .wmv are now shown in the list of File Types (below), and that just like the .dat File Type we added above, this is now labeled with an Entry Type of Local.
Summary: In this section, you saw the default site-level settings for Bit Rate Throttling, you added new settings for a Data File Type, and you edited settings for a Media File Type.
Configuring throttling at the Virtual Directory level
In this section, we highlight that a Virtual Directory can be configured using the same basic settings that were shown for Sites on a previous page. For example, if we add a virtual directory called “videos” to the Default Web Site (see below), we could easily add or edit Throttle Settings for the content contained in this directory.
Configuring throttling at the File level
If you need to change throttle settings at the File level, you can do this also, although it is not as intuitive as the Server, Site, and Virtual Directory levels. In this case, we will assume that there is a file called sample.wmv in your videos virtual directory that you wish to set unique throttle settings for. Click on the videos virtual directory, and then click on Content View at the bottom of the Home Page pane (see below).
Right-click on sample.wmv in the Home Page pane, and then click on Switch to Features View from the context menu (see below).
Now sample.wmv appears in the Connections pane (see below).
Double-click on the Bit Rate Throttling icon, and then adjust the throttle settings for the .wmv File Type.
Tip: One way to ensure that you are applying settings to the correct configuration level is to check the path shown at the top of the Internet Information Services (IIS) Manager window; another is to check the status bar at the bottom of the window (see below).
Configuring advanced throttling settings at the Site level
In the Go Live beta release of Bit Rate Throttling, we added a few new limits to help site administrators manage server resources. The new limits apply to bandwidth per connection and the number of connections allowed. Limits set at the Site level apply to all of the content on that site.
Let us continue on with the Site example used in the “Configuring throttling at the Site level” topic. We will start first by looking at the new limits that apply to bandwidth used per connection.
1. As shown below, go to the Bit Rate Throttling feature on the Default Web site.
2. Click on Advanced Settings… in the Actions pane.
3. Note the two settings available in the Advanced Settings dialog box (see below):
a. Default throttle rate: A setting that applies to media files for which the encoded bit rate cannot be determined (for example, when metadata in a media file is missing or corrupted), or when no throttle rate is specified for any given media or data file type. Using this as a limit prevents any file or file type from using a disproportionate amount of bandwidth.
b. Maximum throttle rate: A setting that limits the throttle rate for all known media or data files to a specific value. You can set this maximum value for files to limit the throttle rate, even if the throttle rate setting for a specific file type is higher.
4. Here is a usage example (see below):
a. Enable the Default throttle rate and set it to 300 kbps.
b. Enable the Maximum throttle rate and set it to 1000 kbps.
5. With the settings shown above, the results will be:
a. Any file delivered by this IIS site that is not currently listed in the Site level Bit Rate Throttle settings will be delivered at a constant 300 kbps. This does not take precedence over file types that are already configured to use throttling.
b. Any file type that is already listed in the Site level Bit Rate Throttle settings will be constrained during throttling to a maximum of 1000 kbps, even if the throttle setting for that file type were set higher (e.g. 1200 kbps). Note that the Maximum throttle rate only applies to throttled responses, so Fast Start data will still be sent without throttling to the client as fast as the network connection will allow.
The other type of limit added to the Bit Rate Throttling feature allows an administrator to enforce connection limits per site for a set of file types. Unlike the new bandwidth limits, the connection limits are configured by editing the main IIS 7.0 configuration file, applicationHost.config.
There are two primary steps to setting up connection limits: create connection groups and associate file types to those groups. By default, the ten media file types that are pre-defined in the Bit Rate Throttling feature are assigned to one of two connection limit groups, called AudioFiles and VideoFiles. For example, if you ran a Web site that delivers a lot of video in different formats, you might want to limit the number of concurrent connections to that content to protect server resources and thereby ensure connected users have a good experience.
6. First, as noted in steps 1 and 2 of the “Configuring throttling at the Site level” topic, make sure you are a local administrator on the IIS server, and make a back-up of %windir%\System32\inetsrv\config\applicationHost.config file before making edits.
7. In applicationHost.config, search for the string “<media>”, which you will find in the system.webserver section. Just below this, you should see the bitrateThrottling section. Relevant portions of this section are shown below.
<system.webServer>
<media>
<bitrateThrottling enabled="true" minSendSize="5840">
<throttleSettings>
<add fileExtension=".asf" settingType="media" initialBufferTimeSeconds="20" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".wmv" settingType="media" initialBufferTimeSeconds="20" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".wma" settingType="media" initialBufferTimeSeconds="20" throttleRatePercentage="100" connectionLimitGroup="AudioFiles" />
<add fileExtension=".avi" settingType="media" initialBufferTimeSeconds="20" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".mp3" settingType="media" initialBufferTimeSeconds="10" throttleRatePercentage="100" connectionLimitGroup="AudioFiles" />
<add fileExtension=".mp4" settingType="media" initialBufferTimeSeconds="10" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".mov" settingType="media" initialBufferTimeSeconds="10" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".flv" settingType="media" initialBufferTimeSeconds="10" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".rm" settingType="media" initialBufferTimeSeconds="10" throttleRatePercentage="100" connectionLimitGroup="AudioFiles" />
<add fileExtension=".rmvb" settingType="media" initialBufferTimeSeconds="10" throttleRatePercentage="100" connectionLimitGroup="VideoFiles" />
<add fileExtension=".jpg" settingType="data" initialSendSizeKBytes="10" throttleRateKbps="5" />
</throttleSettings>
<connectionLimitGroups>
<add name="VideoFiles" connectionLimit="0" />
<add name="AudioFiles" connectionLimit="0" />
</connectionLimitGroups>
...
</bitrateThrottling>
</media>
</system.webServer>
8. Notice in the configuration XML above that you can associate a given file type with a connection group by setting an optional connectionLimitGroup attribute on the <add> node within <throttleSettings>.
9. In the separate node called "connectionLimitGroups" (also a child of <throttleSettings>), notice that you can define a connection group that allows you to enforce a connection limit for a group of file types. By default, the connection limits are set to “0”, which allows unlimited connections.
10. Let’s go back to the video site example. If you wanted to enforce limits on the number of concurrent video connections to your site, you could change this node of the configuration file as follows:
<connectionLimitGroups>
<add name="VideoFiles" connectionLimit="5000" />
<add name="AudioFiles" connectionLimit="0" />
</connectionLimitGroups>
The example above allows up to 5000 simultaneous client connections to video files on the Web server. Assuming the average encoded bit rate of your video content is 300 kbps, this limit would allow an aggregate of 1.5Gbps of content to be delivered to those clients.
When a connection limit is reached for a given connection group, clients that request the file type receive an HTTP 503 (Service Unavailable) error. Clients cannot connect and receive throttled content until a connection becomes available.
You can specify unlimited connections to a given file type by setting connectionLimit="0" or by omitting the connectionLimitGroup for a given file type.
Note: A site with many applications that each run in different Application Pools will have independent co