Getting Started with the MediaPlayer
This tutorial explains how to set up a basic Telerik UI for ASP.NET MVC MediaPlayer and highlights the major steps in the configuration of the component.
You will initialize a MediaPlayer and learn how to play the source initially by default. Then, you will see how to attach an event handler to the component.
Prerequisites
To successfully complete the tutorial, you need a project that is already configured to use the Telerik UI for ASP.NET MVC components:
To create a new pre-configured project for the Telerik UI for ASP.NET MVC components, you can use a project template.
To manually configure an existing project by using NuGet, see the Adding Telerik UI through NuGet.
1. Prepare the CSHTML File
The first step is to add the required directives at the top of the .cshtml document:
-
To use the Telerik UI for ASP.NET MVC HtmlHelpers:
@using Kendo.Mvc.UI
Optionally, you can structure the document by adding the desired HTML elements like headings, divs, paragraphs, and others.
@using Kendo.Mvc.UI
<h4>MediaPlayer with event handler</h4>
<p>
</p>
2. Initialize the MediaPlayer
Use the MediaPlayer HtmlHelper to add the component to a page:
- The
Name()configuration method is mandatory as its value is used for theidand thenameattributes of the MediaPlayer element. - The
Media()is used to provide the component with the required media file or URL to play. - The
AutoPlay()configuration allows whether the video or audio should start playing on initial load.
@using Kendo.Mvc.UI
<h4>MediaPlayer with event handler</h4>
<p>
@(Html.Kendo().MediaPlayer()
.Name("mediaplayer")
.Media(m => m
.Title("ProgressNEXT 2019 Highlights")
.Source("https://youtu.be/2OvvwWShNWo")
)
)
</p>
3. Enable Initial Play
The next step is to configure the MediaPlayer to play its source automatically on initial load. You can do that by using the AutoPlay() configuration.
@using Kendo.Mvc.UI
<h4>MediaPlayer with event handler</h4>
<p>
@(Html.Kendo().MediaPlayer()
.Name("mediaplayer")
.AutoPlay(true)
.Media(m => m
.Title("ProgressNEXT 2019 Highlights")
.Source("https://youtu.be/2OvvwWShNWo")
)
)
</p>
4. Handle a MediaPlayer Event
The MediaPlayer exposes a Pause() event that you can handle and assign specific functions to the component. In this tutorial, you will use the Pause() event to display a message when the user stops the media.
@using Kendo.Mvc.UI
<script>
function onPause(e) {
console.log("Playing paused."); // displays a message in the browser console
}
</script>
<h4>MediaPlayer with event handler</h4>
<p>
@(Html.Kendo().MediaPlayer()
.Name("mediaplayer")
.AutoPlay(true)
.Media(m => m
.Title("ProgressNEXT 2019 Highlights")
.Source("https://youtu.be/2OvvwWShNWo")
)
.Events(e => e.Pause("onPause"))
)
</p>
For more examples, refer to the demo on using the events of the MediaPlayer.
5. (Optional) Reference Existing MediaPlayer Instances
You can reference the MediaPlayer instances that you have created and build on top of their existing configuration:
-
Use the
idattribute of the component instance to establish a reference.<script> var mediaplayerReference = $("#mediaplayer").data("kendoMediaPlayer"); // mediaplayerReference is a reference to the existing mediaplayer instance of the helper. </script> -
Use the MediaPlayer client-side API to control the behavior of the widget. In this example, you will use the
mutemethod to silence the media source.<script> var mediaplayerReference = $("#mediaplayer").data("kendoMediaPlayer"); // mediaplayerReference is a reference to the existing timeMediaPlayer instance of the helper. mediaplayerReference.mute(); // Mutes the currently playing file. </script>
For more information on referencing specific helper instances, see the Methods and Events article.