Share via


MediaPlayer.OnClientChapterStarted Property

Gets or sets the name of the client JavaScript function (event handler) that is called when the Sys.UI.Silverlight.MediaPlayer.chapterStarted client event is raised.

Namespace:  System.Web.UI.SilverlightControls
Assembly:  System.Web.Silverlight (in System.Web.Silverlight.dll)

Syntax

'Declaration
<BindableAttribute(True)> _
Public Overridable Property OnClientChapterStarted As String
    Get
    Set
'Usage
Dim instance As MediaPlayer
Dim value As String

value = instance.OnClientChapterStarted

instance.OnClientChapterStarted = value
[BindableAttribute(true)]
public virtual string OnClientChapterStarted { get; set; }

Property Value

Type: System.String
The name of the JavaScript function that is called when a chapter starts.

Remarks

The chapterStarted client event occurs at runtime a new chapter point is reached during playback of the media file.

You can indicate the client JavaScript function to run when the chapterStarted client event occurs using the OnClientChapterStarted property.

Examples

The following example demonstrates how to set the name of a JavaScript function to run when a chapter position is reached during playback and the Sys.UI.Silverlight.MediaPlayer.chapterStarted client event occurs. This code example is part of a larger example provided for the Sys.UI.Silverlight.MediaPlayer class.

The markup shows the OnClientChapterStarted property on the MediaPlayer server control indicating that chapterStarted is the name of the JavaScript function to run when a chapterStarted client event occurs at runtime.

<asp:MediaPlayer ID="MediaPlayer1" runat="server" Height="300px" Width="400px" 
    OnClientChapterSelected="chapterSelected" 
    OnClientChapterStarted="chapterStarted" 
    OnClientCurrentStateChanged="currentStateChanged" 
    OnClientMarkerReached="markerReached" 
    OnClientMediaEnded="mediaEnded" 
    OnClientMediaFailed="mediaFailed" 
    OnClientMediaOpened="mediaOpened" 
    OnClientVolumeChanged="volumeChanged"
    onPluginFullScreenChanged="fullScreenChanged"
    MediaSource="../media/expressionstudio.wmv" AutoPlay="True" 
    MediaSkinSource="../skins/Professional.xaml">
    <Chapters>
        <asp:MediaChapter Position="5" Title="A New Start" ThumbnailSource="../images/Water lilies.jpg" />
        <asp:MediaChapter Position="22" Title="More Things" ThumbnailSource="../images/Sunset.jpg"/>
        <asp:MediaChapter Position="54" Title="Final Thoughts" ThumbnailSource="../images/Blue hills.jpg" />
    </Chapters>
</asp:MediaPlayer>
<asp:MediaPlayer ID="MediaPlayer1" runat="server" Height="300px" Width="400px" 
    OnClientChapterSelected="chapterSelected" 
    OnClientChapterStarted="chapterStarted" 
    OnClientCurrentStateChanged="currentStateChanged" 
    OnClientMarkerReached="markerReached" 
    OnClientMediaEnded="mediaEnded" 
    OnClientMediaFailed="mediaFailed" 
    OnClientMediaOpened="mediaOpened" 
    OnClientVolumeChanged="volumeChanged"
    onPluginFullScreenChanged="fullScreenChanged"
    MediaSource="../media/expressionstudio.wmv" AutoPlay="True" 
    MediaSkinSource="../skins/Professional.xaml">
    <Chapters>
        <asp:MediaChapter Position="5" Title="A New Start" ThumbnailSource="../images/Water lilies.jpg" />
        <asp:MediaChapter Position="22" Title="More Things" ThumbnailSource="../images/Sunset.jpg"/>
        <asp:MediaChapter Position="54" Title="Final Thoughts" ThumbnailSource="../images/Blue hills.jpg" />
    </Chapters>
</asp:MediaPlayer>

The client script shows the chapterStarted JavaScript function.

function chapterStarted(sender, args) {
    var chapter = args.get_chapter();
    if (chapter)
    {
        var title = chapter.get_title();
        var textMessage = String.format("chapterStarted event: title '{0}'", title);
        ta.innerText +=  '\r\n' + textMessage;
    }
} 
function chapterStarted(sender, args) {
    var chapter = args.get_chapter();
    if (chapter)
    {
        var title = chapter.get_title();
        var textMessage = String.format("chapterStarted event: title '{0}'", title);
        ta.innerText +=  '\r\n' + textMessage;
    }
} 

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

See Also

Reference

MediaPlayer Class

MediaPlayer Members

System.Web.UI.SilverlightControls Namespace

Other Resources

Walkthrough: Creating Chapter Markers for the MediaPlayer Control