-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #299 from ant-media/md/update-dash-play
Update Dash play document
- Loading branch information
Showing
1 changed file
with
109 additions
and
37 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,68 +1,140 @@ | ||
| --- | ||
| title: Dash playing (CMAF) | ||
| description: Common Media Application Format (CMAF) is essentially a new format to reduce HTTP delivery latency as it aims to reduce the cost, complexity, and latency of streaming. | ||
| description: Common Media Application Format (CMAF) is essentially a new format to reduce HTTP delivery latency, as it aims to reduce the cost, complexity, and latency of streaming. | ||
| keywords: [Dash playing, Common Media Application Format, Ant Media Server Documentation, Ant Media Server Tutorials] | ||
| sidebar_position: 3 | ||
| --- | ||
|
|
||
| # Dash Playback with CMAF | ||
|
|
||
| ### What Is CMAF (Common Media Application Format)? | ||
| ## What Is CMAF (Common Media Application Format)? | ||
|
|
||
| The Common Media Application Format (CMAF) is essentially a new format to reduce HTTP delivery latency. It is a new standard that aims to reduce the cost, complexity, and latency of streaming (typically 3-5 seconds). CMAF can be used in DASH or HLS. Both LL-DASH (Low Latency Dash) and LL-HLS (Low Latency HLS) are supported by Ant Media Server in the CMAF format. | ||
| - The Common Media Application Format (CMAF) is a standard designed to reduce HTTP delivery latency, typically to around 3-5 seconds. It aims to lower the cost, complexity, and latency of streaming. CMAF can be utilized with both DASH (Dynamic Adaptive Streaming over HTTP) and HLS (HTTP Live Streaming). | ||
|
|
||
| - Ant Media Server fully supports LL-DASH (Low Latency DASH) through CMAF and LL-HLS (Low Latency HLS) is an experimental feature for now. | ||
|
|
||
|  | ||
|
|
||
| How to use CMAF | ||
| --------------- | ||
| ## Dash Play | ||
|
|
||
| In Ant Media Server **v2.4.3** and earlier, you must enable it in your application's configuration file. It is now possible to enable it directly from the Ant Media dashboard starting with version **2.5.0**. | ||
| Dash playback is turned off by default, so you must enable it before playing a stream over the Dash protocol. | ||
|
|
||
|  | ||
| ### Enable Dash & CMAF Streaming | ||
|
|
||
| To play Dash stream, provide ```streamId``` as the name and ```dash``` as the playOrder parameters in the URL shown below. | ||
|
|
||
| ```https://AMS-domain-name:5443/WebRTCAppEE/play.html?name=test&playOrder=dash``` | ||
| Dash playback can be enabled from the application settings. | ||
|
|
||
| - Navigate to your application (LiveApp, WebRTCAppEE, or any other). | ||
|
|
||
| - Go to `Settings` and under `Dash & CMAF Streaming` check `Create DASH Streaming` to enable it. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| #### Enable Dash programmatically | ||
|
|
||
| In Ant Media Server versions 2.4.3 and earlier, you need to enable DASH by editing the application's configuration file. | ||
|
|
||
| 1. Open the following file with your preferred editor. | ||
|
|
||
| ```bash | ||
| sudo nano /usr/local/antmedia/webapps/WebRTCAppEE/WEB-INF/red5-web.properties | ||
| ``` | ||
|
|
||
| 2. Enable DASH by adding the following property:. | ||
|
|
||
| ```bash | ||
| settings.dashMuxingEnabled=true | ||
| ``` | ||
|
|
||
| - To enable LL-Dash, set the following: | ||
|
|
||
| ```bash | ||
| settings.dash.llEnabled=true | ||
| ``` | ||
|
|
||
| - To enable LL-HLS (experimental feature), you can set | ||
|
|
||
| ```bash | ||
| settings.dash.llHlsEnabled=true | ||
| ``` | ||
|
|
||
| 3. Restart the Ant Media Server to apply the settings | ||
|
|
||
| In order to enable the dash programmatically, follow below steps: | ||
| ```bash | ||
| sudo service antmedia restart | ||
| ``` | ||
|
|
||
| **1.** Open the following file with your favorite editor | ||
| For more information about application settings, please check [AMS application Configuration](https://antmedia.io/docs/guides/configuration-and-testing/ams-application-configuration/) | ||
|
|
||
| /usr/local/antmedia/webapps/WebRTCAppEE/WEB-INF/red5-web.properties | ||
| ### Playing Dash with Embedded Player | ||
|
|
||
| **2.** Enable DASH by adding the following property to the file above. | ||
| You can use the embedded player `play.html` to play the streams with dash. | ||
|
|
||
| settings.dashMuxingEnabled=true | ||
| - Make sure that your stream is publishing on the server. | ||
|
|
||
| If you want to enable LL-HLS (an experimental feature), you also need to set the following properties: | ||
| - To play a stream with Dash, provide ```streamId``` as the id and ```dash``` as the playOrder parameter in the URL shown below. | ||
|
|
||
| settings.dash.llHlsEnabled=true | ||
| ``` | ||
| https://AMS-domain-name:5443/WebRTCAppEE/play.html?id=test&playOrder=dash | ||
| ``` | ||
|
|
||
| **3.** Restart the Ant Media Server | ||
| - The dash playback will start automatically when the stream is live. | ||
|
|
||
| sudo service antmedia restart | ||
|  | ||
|
|
||
| ### Playing MPEG-Dash stream directly via MPD | ||
|
|
||
| Assume Dash muxing is enabled and a stream is published to the Ant Media Server. | ||
|
|
||
| The default MPEG-Dash (.mpd) URL will be as follows: | ||
|
|
||
| ``` | ||
| https://AMS-domain-name:5443/WebRTCAppEE/streams/streamId/streamId.mpd | ||
| ``` | ||
| :::info | ||
| If you play the **.mpd** file directly, the stream latency will be native to MPEG-Dash, which is about 15 seconds. | ||
| ::: | ||
| ## More Details About Dash | ||
| There are a few more options for CMAF and their default values. You can assume that the following values are in use if they are not specified in the properties file: | ||
| #Duration of segments in mpd files. | ||
| settings.dashSegDuration=6 | ||
| #Fragments are a property of fragmented MP4 files. Typically a fragment consists of moof + mdat. | ||
| settings.dashFragmentDuration=0.5 | ||
|
|
||
| #Target latency | ||
| settings.dashTargetLatency=3.5 | ||
|
|
||
| #DASH window size. Number of files in manifest | ||
| settings.dashWindowSize=5 | ||
|
|
||
| #DASH extra window size. Number of segments kept outside of the manifest before removing from disk | ||
| settings.dashExtraWindowSize=5 | ||
| - Duration of segments in mpd files. | ||
| ```js | ||
| settings.dashSegDuration=6 | ||
| ``` | ||
|
|
||
| - Fragments are a property of fragmented MP4 files. Typically, a fragment consists of `moof + mdat`. | ||
|
|
||
| ```js | ||
| settings.dashFragmentDuration=0.5 | ||
| ``` | ||
|
|
||
| - Target latency | ||
|
|
||
| ```js | ||
| settings.dashTargetLatency=3.5 | ||
| ``` | ||
|
|
||
| - DASH window size. Number of files in the manifest | ||
|
|
||
| ```js | ||
| settings.dashWindowSize=5 | ||
| ``` | ||
|
|
||
| #Enable low latency dash. This settings is effective if dash is enabled | ||
| settings.dash.llEnabled=true | ||
| - DASH extra window size. Number of segments kept outside of the manifest before being removed from the disk. | ||
|
|
||
| ```js | ||
| settings.dashExtraWindowSize=5 | ||
| ``` | ||
|
|
||
|
|
||
| **Note:** If you're using Dash streaming with ABR enabled, make sure the following property is enabled in your application's ```red5-web.properties``` file. | ||
| If you're using Dash streaming with ABR enabled, make sure the following property is enabled in your application's advanced settings:. | ||
|
|
||
| settings.forceAspectRationInTranscoding=false | ||
| ```js | ||
| "forceAspectRatioInTranscoding": true, | ||
| ``` | ||
|
|
||
| The value is false by default. Check [here](https://antmedia.io/javadoc/io/antmedia/AppSettings.html#forceAspectRatioInTranscoding) for more information on this property. | ||
| The value is false by default. Check [here](https://antmedia.io/javadoc/io/antmedia/AppSettings.html#forceAspectRatioInTranscoding) for more information on this property. |