Share via


MediaPlayer.OnClientMediaFailed Property

Gets or sets the name of the client JavaScript function (event handler) that is called when the Sys.UI.Silverlight.MediaPlayer.mediaFailed 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 OnClientMediaFailed As String
    Get
    Set
'Usage
Dim instance As MediaPlayer
Dim value As String

value = instance.OnClientMediaFailed

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

Property Value

Type: System.String
The name of the JavaScript function that is called when a failure occurs in the media source.

Remarks

The mediaFailed client event occurs at runtime if the media file does not load correctly.

This can occur if the media file indicated by the MediaSource property is not found or is not a format that the Sys.UI.Silverlight.MediaPlayer client control can play.

Examples

The following example demonstrates how to set the name of a JavaScript function to run if the media file fails to load at runtime and the Sys.UI.Silverlight.MediaPlayer.mediaFailed client event occurs. This code example is part of a larger example provided for the Sys.UI.Silverlight.MediaPlayer class.

The markup shows the OnClientMediaFailed property on MediaPlayer server control indicating that mediaFailed is the name of the JavaScript function to run when a Sys.UI.Silverlight.MediaPlayer.mediaFailed 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 mediaFailed JavaScript function.

function mediaFailed(sender, args) {
    var currentPosition = sender.get_position();
    var textMessage = String.format("mediaFailed event: position {0} seconds", currentPosition);
    ta.innerText +=  '\r\n' + textMessage;
}        
function mediaFailed(sender, args) {
    var currentPosition = sender.get_position();
    var textMessage = String.format("mediaFailed event: position {0} seconds", currentPosition);
    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

MediaSource