Getting Started with the MediaPlayer

This tutorial explains how to set up a basic Telerik UI for ASP.NET Core 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. Finally, you can run the sample code in Telerik REPL and continue exploring the component.

Prerequisites

To successfully complete the tutorial, you need a project that is already configured to use the Telerik UI for ASP.NET Core components:

• You can use the Telerik REPL playground and skip installing the components on your system and configuring a project.

• You can prepare a Visual Studio project by following either of these guides:

  • Creating a new pre-configured project for the Telerik UI for ASP.NET Core components from a project template.

  • Manually configuring an existing project as described in the First Steps on Windows or First Steps on Mac articles.

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 Core HtmlHelpers:

  @using Kendo.Mvc.UI
  

• To use the Telerik UI for ASP.NET Core TagHelpers:

  @addTagHelper *, Kendo.Mvc
  

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>

@addTagHelper *, Kendo.Mvc

<h4>MediaPlayer with event handler</h4>

<p>

</p>

2. Initialize the MediaPlayer

Use the MediaPlayer HtmlHelper or TagHelper to add the component to a page:

• The Name() configuration method is mandatory as its value is used for the id and the name attributes 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>

@addTagHelper *, Kendo.Mvc

<h4>MediaPlayer with event handler</h4>

<p>
    <kendo-mediaplayer name="mediaplayer">
    </kendo-mediaplayer>
</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>

@addTagHelper *, Kendo.Mvc

<h4>MediaPlayer with event handler</h4>

<p>
    <kendo-mediaplayer name="mediaplayer"  
           auto-play="true">
    </kendo-mediaplayer>
</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>

@addTagHelper *, Kendo.Mvc

<script>
   function onPause(e) {
       console.log("Playing paused."); // displays a message in the browser console
   }
</script>

<h4>MediaPlayer with event handler</h4>

<p>
    <kendo-mediaplayer name="mediaplayer" 
           auto-play="true" on-pause="onPause">
    </kendo-mediaplayer>
</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:

1. Use the id attribute 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>
   

2. Use the MediaPlayer client-side API to control the behavior of the widget. In this example, you will use the mute method 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.

Explore this Tutorial in REPL

You can continue experimenting with the code sample above by running it in the Telerik REPL server playground:

• Sample code with the MediaPlayer HtmlHelper
• Sample code with the MediaPlayer TagHelper

Next Steps

• Playlists
• Multiple Sources

See Also

• Using the API of the MediaPlayer for ASP.NET Core (Demo)
• Client-Side API of the MediaPlayer
• Server-Side API of the MediaPlayer
• Knowledge Base Section