MediaElement MediaElement MediaElement MediaElement Class

Instantiates a new instance of the MediaElement class.

public : MediaElement()public MediaElement()Public Sub New()// This API is not available in Javascript.

Gets an enumeration value that determines the current value of stereo 3-D video frame-packing mode, accounting for other factors such as whether the media engine is ready for use.

public : Stereo3DVideoPackingMode ActualStereo3DVideoPackingMode { get; }public Stereo3DVideoPackingMode ActualStereo3DVideoPackingMode { get; }Public ReadOnly Property ActualStereo3DVideoPackingMode As Stereo3DVideoPackingMode// This API is not available in Javascript.

Remarks

ActualStereo3DVideoPackingMode is used to determine the current Stereo3DVideoPackingMode being used by the subsystem. This could be different than what is set by the app author or if the app author sets None which is the default of Stereo3DVideoPackingMode.

See Also

Stereo3DVideoPackingModeStereo3DVideoPackingModeStereo3DVideoPackingModeStereo3DVideoPackingMode

Identifies the ActualStereo3DVideoPackingMode dependency property.

public : static DependencyProperty ActualStereo3DVideoPackingModeProperty { get; }public static DependencyProperty ActualStereo3DVideoPackingModeProperty { get; }Public Static ReadOnly Property ActualStereo3DVideoPackingModeProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that determines whether the standard transport controls are enabled.

public : PlatForm::Boolean AreTransportControlsEnabled { get; set; }public bool AreTransportControlsEnabled { get; set; }Public ReadWrite Property AreTransportControlsEnabled As bool// This API is not available in Javascript.

<MediaElement AreTransportControlsEnabled="bool" />

Examples

Here is some code that creates a MediaElement with the built-in transport controls enabled and the AutoPlay property set to false.

<MediaElement x:Name="mediaPlayer" 
              Source="Videos/video1.mp4" 
              Width="400" 
              AutoPlay="False"
              AreTransportControlsEnabled="True" />

Remarks

The transport controls are exposed as a MediaTransportControls object that you can access through the MediaElement.TransportControls property. See MediaTransportControls for more info.

If AreTransportControlsEnabled is true, the standard transport controls are enabled and displayed on the MediaElement. If AreTransportControlsEnabled is false, the standard transport controls are not enabled and are not displayed.

The transport controls hide themselves after a short period of no user interaction with the MediaElement. They reappear when the user interacts with the MediaElement.

If the Width of MediaElement is not sufficient to display all of the transport controls, a subset of the controls are displayed.

Notes for previous versions

Windows 8.1 You can't access and modify the built-in transport controls. If you create custom transport controls for your app, set this property to false to disable the built-in controls.

Identifies the AreTransportControlsEnabled dependency property.

public : static DependencyProperty AreTransportControlsEnabledProperty { get; }public static DependencyProperty AreTransportControlsEnabledProperty { get; }Public Static ReadOnly Property AreTransportControlsEnabledProperty As DependencyProperty// This API is not available in Javascript.

Gets the height portion of the native aspect ratio of the media.

public : int AspectRatioHeight { get; }public int AspectRatioHeight { get; }Public ReadOnly Property AspectRatioHeight As int// This API is not available in Javascript.

Identifies the AspectRatioHeight dependency property.

public : static DependencyProperty AspectRatioHeightProperty { get; }public static DependencyProperty AspectRatioHeightProperty { get; }Public Static ReadOnly Property AspectRatioHeightProperty As DependencyProperty// This API is not available in Javascript.

Gets the width portion of the native aspect ratio of the media.

public : int AspectRatioWidth { get; }public int AspectRatioWidth { get; }Public ReadOnly Property AspectRatioWidth As int// This API is not available in Javascript.

Identifies the AspectRatioWidth dependency property.

public : static DependencyProperty AspectRatioWidthProperty { get; }public static DependencyProperty AspectRatioWidthProperty { get; }Public Static ReadOnly Property AspectRatioWidthProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that describes the purpose of the audio information in an audio stream.

public : AudioCategory AudioCategory { get; set; }public AudioCategory AudioCategory { get; set; }Public ReadWrite Property AudioCategory As AudioCategory// This API is not available in Javascript.

<MediaElement AudioCategory="audioCategoryMemberName" /.

Remarks

For hardware audio offload to be automatically applied, the audio category must be set to ForegroundOnlyMedia or BackgroundCapableMedia. Hardware audio offload optimizes audio rendering which can improve functionality and battery life.

Identifies the AudioCategory dependency property.

public : static DependencyProperty AudioCategoryProperty { get; }public static DependencyProperty AudioCategoryProperty { get; }Public Static ReadOnly Property AudioCategoryProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that describes the primary usage of the device that is being used to play back audio.

public : AudioDeviceType AudioDeviceType { get; set; }public AudioDeviceType AudioDeviceType { get; set; }Public ReadWrite Property AudioDeviceType As AudioDeviceType// This API is not available in Javascript.

<MediaElement AudioDeviceType="audioDeviceTypeMemberName" /.

Identifies the AudioDeviceType dependency property.

public : static DependencyProperty AudioDeviceTypeProperty { get; }public static DependencyProperty AudioDeviceTypeProperty { get; }Public Static ReadOnly Property AudioDeviceTypeProperty As DependencyProperty// This API is not available in Javascript.

Gets the number of audio streams that exist in the current media file.

public : int AudioStreamCount { get; }public int AudioStreamCount { get; }Public ReadOnly Property AudioStreamCount As int// This API is not available in Javascript.

Identifies the AudioStreamCount dependency property.

public : static DependencyProperty AudioStreamCountProperty { get; }public static DependencyProperty AudioStreamCountProperty { get; }Public Static ReadOnly Property AudioStreamCountProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the index of the audio stream that plays along with the video component. The collection of audio streams is composed at run time and represents all audio streams that are available in the media file.

public : IReference<int> AudioStreamIndex { get; set; }public Nullable<int> AudioStreamIndex { get; set; }Public ReadWrite Property AudioStreamIndex As Nullable<int>// This API is not available in Javascript.

<MediaElement AudioStreamIndex="int"/>

Remarks

Setting AudioStreamIndex to null selects the default audio track, which is defined by the content.

Identifies the AudioStreamIndex dependency property.

public : static DependencyProperty AudioStreamIndexProperty { get; }public static DependencyProperty AudioStreamIndexProperty { get; }Public Static ReadOnly Property AudioStreamIndexProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that indicates whether media will begin playback automatically when the Source property is set.

public : PlatForm::Boolean AutoPlay { get; set; }public bool AutoPlay { get; set; }Public ReadWrite Property AutoPlay As bool// This API is not available in Javascript.

<MediaElement AutoPlay="bool" .../>

Identifies the AutoPlay dependency property.

public : static DependencyProperty AutoPlayProperty { get; }public static DependencyProperty AutoPlayProperty { get; }Public Static ReadOnly Property AutoPlayProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a ratio of volume across stereo speakers.

public : double Balance { get; set; }public double Balance { get; set; }Public ReadWrite Property Balance As double// This API is not available in Javascript.

<MediaElement Balance="double"  .../>

Identifies the Balance dependency property.

public : static DependencyProperty BalanceProperty { get; }public static DependencyProperty BalanceProperty { get; }Public Static ReadOnly Property BalanceProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that indicates the current buffering progress.

public : double BufferingProgress { get; }public double BufferingProgress { get; }Public ReadOnly Property BufferingProgress As double// This API is not available in Javascript.

Identifies the BufferingProgress dependency property.

public : static DependencyProperty BufferingProgressProperty { get; }public static DependencyProperty BufferingProgressProperty { get; }Public Static ReadOnly Property BufferingProgressProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that indicates whether media can be paused if the Pause method is called.

public : PlatForm::Boolean CanPause { get; }public bool CanPause { get; }Public ReadOnly Property CanPause As bool// This API is not available in Javascript.

Identifies the CanPause dependency property.

public : static DependencyProperty CanPauseProperty { get; }public static DependencyProperty CanPauseProperty { get; }Public Static ReadOnly Property CanPauseProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that indicates whether media can be repositioned by setting the value of the Position property.

public : PlatForm::Boolean CanSeek { get; }public bool CanSeek { get; }Public ReadOnly Property CanSeek As bool// This API is not available in Javascript.

Identifies the CanSeek dependency property.

public : static DependencyProperty CanSeekProperty { get; }public static DependencyProperty CanSeekProperty { get; }Public Static ReadOnly Property CanSeekProperty As DependencyProperty// This API is not available in Javascript.

Gets the status of this MediaElement.

public : MediaElementState CurrentState { get; }public MediaElementState CurrentState { get; }Public ReadOnly Property CurrentState As MediaElementState// This API is not available in Javascript.

Examples

The following example demonstrates one way to display the CurrentState of a MediaElement. It creates a MediaElement and several buttons for controlling media playback. To display the current state of the MediaElement, the example registers for the CurrentStateChanged event and uses an event handler to update a TextBlock.

<Grid>
    <Grid.ColumnDefinitions>
        <ColumnDefinition Width="*" />
        <ColumnDefinition Width="*" />
        <ColumnDefinition Width="*"/>
    </Grid.ColumnDefinitions>
    <Grid.RowDefinitions>
        <RowDefinition Height="*" />
        <RowDefinition Height="Auto" />
        <RowDefinition Height="Auto" />
    </Grid.RowDefinitions>

    <MediaElement CurrentStateChanged="Media_State_Changed"
        x:Name="media" Source="xbox.wmv" Width="300" Height="300" 
                  Grid.Column="0" Grid.Row="0" Grid.ColumnSpan="3" />

    <!-- Stops media playback.-->
    <Button Click="StopMedia" 
     Grid.Column="0" Grid.Row="1" Content="Stop" />

    <!-- Pauses media playback. -->
    <Button Click="PauseMedia" 
     Grid.Column="1" Grid.Row="1" Content="Pause" />

    <!-- Begins media playback. -->
    <Button Click="PlayMedia" 
     Grid.Column="2" Grid.Row="1" Content="Play" />

    <TextBlock
Grid.Column="0" Grid.Row="2" Margin="10" 
FontSize="12">CurrentState:</TextBlock>

    <TextBlock 
x:Name="mediaStateTextBlock"
Grid.Column="1" Grid.Row="2" Margin="0,10,0,0"
FontSize="12"></TextBlock>

</Grid>

private void StopMedia(object sender, RoutedEventArgs e)
{
    media.Stop();
}
private void PauseMedia(object sender, RoutedEventArgs e)
{
    media.Pause();
}
private void PlayMedia(object sender, RoutedEventArgs e)
{
    media.Play();
}
private void Media_State_Changed(object sender, RoutedEventArgs e)
{
    mediaStateTextBlock.Text = media.CurrentState.ToString();
}

Private Sub StopMedia(ByVal sender As Object, ByVal e As RoutedEventArgs)
    media.Stop()
End Sub

Private Sub PauseMedia(ByVal sender As Object, ByVal e As RoutedEventArgs)
    media.Pause()
End Sub

Private Sub PlayMedia(ByVal sender As Object, ByVal e As RoutedEventArgs)
    media.Play()
End Sub
Private Sub Media_State_Changed(ByVal sender As Object, ByVal e As EventArgs)
    mediaStateTextBlock.Text = media.CurrentState.ToString
End Sub

Identifies the CurrentState dependency property.

public : static DependencyProperty CurrentStateProperty { get; }public static DependencyProperty CurrentStateProperty { get; }Public Static ReadOnly Property CurrentStateProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the default playback rate for the media engine. The playback rate applies when the user isn't using fast forward or reverse.

public : double DefaultPlaybackRate { get; set; }public double DefaultPlaybackRate { get; set; }Public ReadWrite Property DefaultPlaybackRate As double// This API is not available in Javascript.

<MediaElement DefaultPlaybackRate="double"/>

Remarks

The current PlaybackRate is set to the value of DefaultPlaybackRate whenever Play is called. So setting DefaultPlaybackRate to a different value has no effect until Play is called.

To set a rate that will persist throughout the lifetime of the MediaElement, use DefaultPlaybackRate. Once playback ends, due to the MediaEnded event being raised or if Pause or Stop are called, the PlaybackRate will be effectively lost.

Identifies the DefaultPlaybackRate dependency property.

public : static DependencyProperty DefaultPlaybackRateProperty { get; }public static DependencyProperty DefaultPlaybackRateProperty { get; }Public Static ReadOnly Property DefaultPlaybackRateProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that indicates the amount of download completed for content located on a remote server.

public : double DownloadProgress { get; }public double DownloadProgress { get; }Public ReadOnly Property DownloadProgress As double// This API is not available in Javascript.

Gets the offset of download progress, which is relevant in seek-ahead scenarios.

public : double DownloadProgressOffset { get; }public double DownloadProgressOffset { get; }Public ReadOnly Property DownloadProgressOffset As double// This API is not available in Javascript.

Identifies the DownloadProgressOffset dependency property.

public : static DependencyProperty DownloadProgressOffsetProperty { get; }public static DependencyProperty DownloadProgressOffsetProperty { get; }Public Static ReadOnly Property DownloadProgressOffsetProperty As DependencyProperty// This API is not available in Javascript.

Identifies the DownloadProgress dependency property.

public : static DependencyProperty DownloadProgressProperty { get; }public static DependencyProperty DownloadProgressProperty { get; }Public Static ReadOnly Property DownloadProgressProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that reports whether the current source media is an audio-only media file.

public : PlatForm::Boolean IsAudioOnly { get; }public bool IsAudioOnly { get; }Public ReadOnly Property IsAudioOnly As bool// This API is not available in Javascript.

Identifies the IsAudioOnly dependency property.

public : static DependencyProperty IsAudioOnlyProperty { get; }public static DependencyProperty IsAudioOnlyProperty { get; }Public Static ReadOnly Property IsAudioOnlyProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that specifies if the MediaElement is rendering in full window mode. Setting this property enables or disables full window rendering.

public : PlatForm::Boolean IsFullWindow { get; set; }public bool IsFullWindow { get; set; }Public ReadWrite Property IsFullWindow As bool// This API is not available in Javascript.

<MediaElement IsFullWindow="bool" />

Remarks

Setting and un-setting this property enables and disables full window rendering.

Always use the IsFullWindow property to enable and disable full window rendering. This ensures system level optimizations are used during media playback.

When in full-window mode, input events received on the MediaElement will still route through to the visual tree in the background. For example, if the MediaElement is in a ListBox, turning the scroll wheel could cause the ListBox to scroll in the background. This can cause unexpected behavior. If input events should not be routed when in full-window mode, the MediaElement should handle the events.

Identifies the IsFullWindow dependency property.

public : static DependencyProperty IsFullWindowProperty { get; }public static DependencyProperty IsFullWindowProperty { get; }Public Static ReadOnly Property IsFullWindowProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that describes whether the media source currently loaded in the media engine should automatically set the position to the media start after reaching its end.

public : PlatForm::Boolean IsLooping { get; set; }public bool IsLooping { get; set; }Public ReadWrite Property IsLooping As bool// This API is not available in Javascript.

<MediaElement IsLooping="bool"/>

Identifies the IsLooping dependency property.

public : static DependencyProperty IsLoopingProperty { get; }public static DependencyProperty IsLoopingProperty { get; }Public Static ReadOnly Property IsLoopingProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value indicating whether the audio is muted.

public : PlatForm::Boolean IsMuted { get; set; }public bool IsMuted { get; set; }Public ReadWrite Property IsMuted As bool// This API is not available in Javascript.

<MediaElement IsMuted="bool" .../>

Identifies the IsMuted dependency property.

public : static DependencyProperty IsMutedProperty { get; }public static DependencyProperty IsMutedProperty { get; }Public Static ReadOnly Property IsMutedProperty As DependencyProperty// This API is not available in Javascript.

Gets a value that reports whether the current source media is a stereo 3-D video media file.

public : PlatForm::Boolean IsStereo3DVideo { get; }public bool IsStereo3DVideo { get; }Public ReadOnly Property IsStereo3DVideo As bool// This API is not available in Javascript.

Remarks

If this property value is true, check Stereo3DVideoRenderMode for information on the render mode.

Identifies the IsStereo3DVideo dependency property.

public : static DependencyProperty IsStereo3DVideoProperty { get; }public static DependencyProperty IsStereo3DVideoProperty { get; }Public Static ReadOnly Property IsStereo3DVideoProperty As DependencyProperty// This API is not available in Javascript.

Gets the collection of timeline markers associated with the currently loaded media file.

public : TimelineMarkerCollection Markers { get; }public TimelineMarkerCollection Markers { get; }Public ReadOnly Property Markers As TimelineMarkerCollection// This API is not available in Javascript.

Examples

The following example creates a MediaElement object and responds to its MarkerReached event. Each time a timeline marker is reached, the example displays the timeline marker's Time, Type, and Text values.

<MediaElement Name="Media" Source="video.mp4" MarkerReached="Media_MarkerReached" />
<TextBlock Name="txOutput" />

private void Media_MarkerReached(object sender, TimelineMarkerRoutedEventArgs e)
{
    txOutput.Text =
        string.Format("{0},{1},{2}", e.Marker.Time, e.Marker.Text, e.Marker.Type);
}

Remarks

A timeline marker is metadata associated with a particular point in a media file. These markers are usually created ahead of time and stored in the media file itself. They are typically used to name different scenes in a video or provide scripting cues. By handling the MediaElement object's MarkerReached event or by accessing the MediaElement object's Markers property, you can use timeline markers to trigger actions or enable users to seek to selected positions in the media file.

Gets the duration of the media file currently opened.

public : Duration NaturalDuration { get; }public Duration NaturalDuration { get; }Public ReadOnly Property NaturalDuration As Duration// This API is not available in Javascript.

Remarks

A Duration value has a TimeSpan component.

C# or Microsoft Visual Basic You can use utility methods of System.TimeSpan to get the duration components in whatever format you want. For example you can get TimeSpan.Hours, TimeSpan.Minutes and TimeSpan.Seconds separately.

Visual C++ component extensions (C++/CX) The data value of a Duration is a property named TimeSpan. This has a TimeSpan structure value, and that structure has a field named Duration that reports the duration as an int64 that counts in 100-nanosecond units. TimeSpan doesn't have any methods for getting components of the time in hours:minutes:seconds format.

For more info, see Remarks in the Duration reference topic.

Identifies the NaturalDuration dependency property.

public : static DependencyProperty NaturalDurationProperty { get; }public static DependencyProperty NaturalDurationProperty { get; }Public Static ReadOnly Property NaturalDurationProperty As DependencyProperty// This API is not available in Javascript.

Gets the height of the video associated with the media.

public : int NaturalVideoHeight { get; }public int NaturalVideoHeight { get; }Public ReadOnly Property NaturalVideoHeight As int// This API is not available in Javascript.

Identifies the NaturalVideoHeight dependency property.

public : static DependencyProperty NaturalVideoHeightProperty { get; }public static DependencyProperty NaturalVideoHeightProperty { get; }Public Static ReadOnly Property NaturalVideoHeightProperty As DependencyProperty// This API is not available in Javascript.

Gets the width of the video associated with the media.

public : int NaturalVideoWidth { get; }public int NaturalVideoWidth { get; }Public ReadOnly Property NaturalVideoWidth As int// This API is not available in Javascript.

Identifies the NaturalVideoWidth dependency property.

public : static DependencyProperty NaturalVideoWidthProperty { get; }public static DependencyProperty NaturalVideoWidthProperty { get; }Public Static ReadOnly Property NaturalVideoWidthProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the playback rate ratio for the media engine.

public : double PlaybackRate { get; set; }public double PlaybackRate { get; set; }Public ReadWrite Property PlaybackRate As double// This API is not available in Javascript.

<MediaElement PlaybackRate="double"/>

Remarks

The current PlaybackRate is set to the value of DefaultPlaybackRate whenever Play is called. So setting DefaultPlaybackRate to a different value has no effect until Play is called.

To set a rate that will persist throughout the lifetime of the MediaElement, use DefaultPlaybackRate. Once playback ends, due to the MediaEnded event being raised or if Pause or Stop are called, the PlaybackRate will be effectively lost.

Identifies the PlaybackRate dependency property.

public : static DependencyProperty PlaybackRateProperty { get; }public static DependencyProperty PlaybackRateProperty { get; }Public Static ReadOnly Property PlaybackRateProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the path to the preferred media source which enables the Play To target device to stream the media content, which can be DRM protected, from a different location, such as a cloud media server.

public : Uri PlayToPreferredSourceUri { get; set; }public Uri PlayToPreferredSourceUri { get; set; }Public ReadWrite Property PlayToPreferredSourceUri As Uri// This API is not available in Javascript.

<MediaElement PlayToPreferredSourceUri="uri" />

Examples

Here is some code that shows how to set up Play To by reference.

<MediaElement Source="http://www.contoso.com/videos/video.mp4" 
   PlayToPreferredSourceUri="http://www.contoso.com/catalogid=1234">
</MediaElement>

MediaElement video = new MediaElement();

video.Source = 
    new Uri("http://www.contoso.com/videos/video.mp4");

video.PlayToPreferredSourceUri = 
    new Uri("http://www.contoso.com/catalogid=1234"); 

auto video = ref new Windows::UI::Xaml::Controls::MediaElement();

video->Source = 
   ref new Windows::Foundation::Uri("http://www.contoso.com/videos/video.mp4");

video->PlayToPreferredSourceUri = 
   ref new Windows::Foundation::Uri("http://www.contoso.com/catalogid=1234");

Remarks

PlayToSource.PreferredSourceUri enables Play To by reference. This allows streaming content on the Play To target device from a different location, such as a cloud media server. This enables web pages and Windows Store app to play Digital Rights Management (DRM) protected content. The app specifies a preferred Uniform Resource Identifier (URI) that will be sent to the Play To target device. This Uniform Resource Identifier (URI) can point to a cloud based media server. If the PlayToSource.PreferredSourceUri value is present, the Play To target device can stream content directly from the cloud, which can be Digital Rights Management (DRM) protected, instead of streaming content from the Windows machine which must be unprotected content.

A forward slash ("/") is appended to the Uniform Resource Identifier (URI) string when it is sent over the network to a Play To device. This is done to conform to Uniform Resource Identifier (URI) standards.

Identifies the PlayToPreferredSourceUri dependency property.

public : static DependencyProperty PlayToPreferredSourceUriProperty { get; }public static DependencyProperty PlayToPreferredSourceUriProperty { get; }Public Static ReadOnly Property PlayToPreferredSourceUriProperty As DependencyProperty// This API is not available in Javascript.

Gets the information that is transmitted if the MediaElement is used for a "PlayTo" scenario.

public : PlayToSource PlayToSource { get; }public PlayToSource PlayToSource { get; }Public ReadOnly Property PlayToSource As PlayToSource// This API is not available in Javascript.

Identifies the PlayToSource dependency property.

public : static DependencyProperty PlayToSourceProperty { get; }public static DependencyProperty PlayToSourceProperty { get; }Public Static ReadOnly Property PlayToSourceProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the current position of progress through the media's playback time.

public : TimeSpan Position { get; set; }public TimeSpan Position { get; set; }Public ReadWrite Property Position As TimeSpan// This API is not available in Javascript.

Remarks

Set this property to set a specific start-play position within the media.

A TimeSpan is represented as different types depending on the programming language you are using.

C# or Microsoft Visual Basic Use a System.TimeSpan structure. System.TimeSpan has utility members such as Parse(String) that make it easy to create, change or compare time values.

Visual C++ component extensions (C++/CX) Use a Windows::Foundation::TimeSpan structure. This structure has only one field member (Duration), which measures by 100-nanosecond units. If you intend to display a Position value in an hours:minutes:seconds format, you'll have to write your own logic for converting to that format from the Duration units.

If you are not sure of the current media source loaded as MediaElement.Source, always check CanSeek first. A streaming media source results in the MediaElement reporting CanSeek as false, and in this case you cannot use Position to set the playback point.

If Position is settable, then these value constraints apply:

• If Position is set to a negative value, the value will revert to a TimeSpan with value "0:0:0".
• If Position is set to a value larger than the media's NaturalDuration, then Position becomes the value of NaturalDuration.

Notes on XAML syntax

Setting a Position value in XAML is technically possible but not common. If you do set a Position in XAML, simulate the "FromString" type conversion behavior for a TimeSpan, in other words specify the value in the form "HH:MM:SS".

See Also

NaturalDurationNaturalDurationNaturalDurationNaturalDuration

Identifies the Position dependency property.

public : static DependencyProperty PositionProperty { get; }public static DependencyProperty PositionProperty { get; }Public Static ReadOnly Property PositionProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the image source that is used for a placeholder image during MediaElement loading transition states.

public : ImageSource PosterSource { get; set; }public ImageSource PosterSource { get; set; }Public ReadWrite Property PosterSource As ImageSource// This API is not available in Javascript.

<MediaElement PosterSource="imageUri" />

Remarks

A PosterSource is an image, such as a album cover or movie poster, that is displayed in place of video. It provides your MediaElement with a visual representation before the media is loaded, or when the media is audio only.

The PosterSource is displayed in the following situations:

• When a valid source is not set. For example, Source is not set, Source is set to Null, or the source is invalid (as is the case when a MediaFailed event fires).
• While media is loading. For example, a valid source is set, but the MediaOpened event has not fired yet.
• While media is streaming to another device.
• When the media is audio only.

Identifies the PosterSource dependency property.

public : static DependencyProperty PosterSourceProperty { get; }public static DependencyProperty PosterSourceProperty { get; }Public Static ReadOnly Property PosterSourceProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the dedicated object for media content protection that is associated with this MediaElement.

public : MediaProtectionManager ProtectionManager { get; set; }public MediaProtectionManager ProtectionManager { get; set; }Public ReadWrite Property ProtectionManager As MediaProtectionManager// This API is not available in Javascript.

Remarks

See the PlayReady sample for for an example of using ProtectionManager.

Identifies the ProtectionManager dependency property.

public : static DependencyProperty ProtectionManagerProperty { get; }public static DependencyProperty ProtectionManagerProperty { get; }Public Static ReadOnly Property ProtectionManagerProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that configures the MediaElement for real-time communications scenarios.

public : PlatForm::Boolean RealTimePlayback { get; set; }public bool RealTimePlayback { get; set; }Public ReadWrite Property RealTimePlayback As bool// This API is not available in Javascript.

<MediaElement RealTimePlayback="bool" />

Remarks

Configuring for real-time playback changes the internal update logic to place higher emphasis on video refresh from available samples, and also restricts playback to natural 1x speed. Setting the property requires an internal reconstruction of the backing media engine.

See Also

Real-time communication sample (Windows 10)

Identifies the RealTimePlayback dependency property.

public : static DependencyProperty RealTimePlaybackProperty { get; }public static DependencyProperty RealTimePlaybackProperty { get; }Public Static ReadOnly Property RealTimePlaybackProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a media source on the MediaElement.

public : Uri Source { get; set; }public Uri Source { get; set; }Public ReadWrite Property Source As Uri// This API is not available in Javascript.

<MediaElement Source="uri" .../>

Identifies the Source dependency property.

public : static DependencyProperty SourceProperty { get; }public static DependencyProperty SourceProperty { get; }Public Static ReadOnly Property SourceProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets an enumeration value that determines the stereo 3-D video frame-packing mode for the current media source.

public : Stereo3DVideoPackingMode Stereo3DVideoPackingMode { get; set; }public Stereo3DVideoPackingMode Stereo3DVideoPackingMode { get; set; }Public ReadWrite Property Stereo3DVideoPackingMode As Stereo3DVideoPackingMode// This API is not available in Javascript.

<MediaElement Stereo3DVideoPackingMode="stereo3DVideoPackingModeMemberName" .../>

Examples

<MediaElement x:Name="me1" Stereo3DVideoPackingMode="TopBottom" Stereo3DVideoRenderMode="Stereo"/>

Remarks

The Stereo3DVideoPackingMode default is to allow the system to determine the packing mode from the metadata of the video content. In order to reset a Stereo3DVideoPackingMode value once it has been set, use ClearValue. Stereo3DVideoPackingMode is used in conjunction with Stereo3DVideoRenderMode to display 3-D content.

Identifies the Stereo3DVideoPackingMode dependency property.

public : static DependencyProperty Stereo3DVideoPackingModeProperty { get; }public static DependencyProperty Stereo3DVideoPackingModeProperty { get; }Public Static ReadOnly Property Stereo3DVideoPackingModeProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets an enumeration value that determines the stereo 3-D video render mode for the current media source.

public : Stereo3DVideoRenderMode Stereo3DVideoRenderMode { get; set; }public Stereo3DVideoRenderMode Stereo3DVideoRenderMode { get; set; }Public ReadWrite Property Stereo3DVideoRenderMode As Stereo3DVideoRenderMode// This API is not available in Javascript.

<MediaElement Stereo3DVideoRenderMode="stereo3DVideoRenderModeMemberName" .../>

Examples

<MediaElement x:Name="me1" Stereo3DVideoPackingMode="TopBottom" Stereo3DVideoRenderMode="Stereo"/>

Remarks

IsStereo3DVideo is an evaluated read-only property that is based on Stereo3DVideoRenderMode.

Set Stereo3DVideoRenderMode to Stereo when you want to enable the MediaElement to play 3D video. The API works in conjunction with Stereo3DVideoPackingMode, which lets you set the packing mode or allows the sub systems to infer it from the video file

Identifies the Stereo3DVideoRenderMode dependency property.

public : static DependencyProperty Stereo3DVideoRenderModeProperty { get; }public static DependencyProperty Stereo3DVideoRenderModeProperty { get; }Public Static ReadOnly Property Stereo3DVideoRenderModeProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets a value that describes how an MediaElement should be stretched to fill the destination rectangle.

public : Stretch Stretch { get; set; }public Stretch Stretch { get; set; }Public ReadWrite Property Stretch As Stretch// This API is not available in Javascript.

<MediaElement Stretch="stretchMemberName" />

Examples

Here is some code that shows how to create a zoom effect, similar to msZoom in Windows app using JavaScript. The MediaElement content will fill up the entire layout space while preserving the aspect ratio of the content. This could result in cropping if the aspect ratio of the content is not the same as the layout space.

private void ToggleZoom(MediaElement media)
{
    if (media.Stretch != Stretch.UniformToFill)
    {
        // zoom
        media.Stretch = Stretch.UniformToFill;
    }
    else
    {
        // unzoom
        media.Stretch = Stretch.Uniform;
    }
}

Remarks

Here's what the Stretch values represent for MediaElement content:

• None: The original size of the content is preserved.
• Fill: The content is resized to fill the destination dimensions. The aspect ratio of the video is not preserved.
• UniformToFill: Uniformly stretches the MediaElement to fill the available layout space while preserving the aspect ratio of the content. If the aspect ratio of the destination rectangle differs from the source, the source content is clipped to fit the destination dimensions.
• Uniform: Uniformly stretches the MediaElement to fill the layout space while preserve the aspect ratio of the image. This will ensure that the entire image is displayed, undistorted and not cropped. This may result in letterboxing or pillarboxing on the top or sides of the image, depending on the aspect ratio of the content.

See Also

StretchStretchStretchStretch

NaturalVideoHeightNaturalVideoHeightNaturalVideoHeightNaturalVideoHeight

NaturalVideoWidthNaturalVideoWidthNaturalVideoWidthNaturalVideoWidth

Identifies the Stretch dependency property.

public : static DependencyProperty StretchProperty { get; }public static DependencyProperty StretchProperty { get; }Public Static ReadOnly Property StretchProperty As DependencyProperty// This API is not available in Javascript.

Gets or sets the transport controls for the media.

public : MediaTransportControls TransportControls { get; set; }public MediaTransportControls TransportControls { get; set; }Public ReadWrite Property TransportControls As MediaTransportControls// This API is not available in Javascript.

Gets or sets the media's volume.

public : double Volume { get; set; }public double Volume { get; set; }Public ReadWrite Property Volume As double// This API is not available in Javascript.

<MediaElement Volume="double"/>

Identifies the Volume dependency property.

public : static DependencyProperty VolumeProperty { get; }public static DependencyProperty VolumeProperty { get; }Public Static ReadOnly Property VolumeProperty As DependencyProperty// This API is not available in Javascript.

Applies an audio effect to playback. Takes effect for the next source that is set on this MediaElement.

public : void AddAudioEffect(PlatForm::String effectID, bool effectOptional, IPropertySet effectConfiguration)public void AddAudioEffect(String effectID, Boolean effectOptional, IPropertySet effectConfiguration)Public Function AddAudioEffect(effectID As String, effectOptional As Boolean, effectConfiguration As IPropertySet) As void// This API is not available in Javascript.

Remarks

The audio effects needs to be added before loading the source. Otherwise, it will be applied for the next source that is set on this MediaElement.

Applies a video effect to playback. Takes effect for the next source that is set on this MediaElement.

public : void AddVideoEffect(PlatForm::String effectID, bool effectOptional, IPropertySet effectConfiguration)public void AddVideoEffect(String effectID, Boolean effectOptional, IPropertySet effectConfiguration)Public Function AddVideoEffect(effectID As String, effectOptional As Boolean, effectConfiguration As IPropertySet) As void// This API is not available in Javascript.

Returns an enumeration value that describes the likelihood that the current MediaElement and its client configuration can play that media source.

public : MediaCanPlayResponse CanPlayType(PlatForm::String type)public MediaCanPlayResponse CanPlayType(String type)Public Function CanPlayType(type As String) As MediaCanPlayResponse// This API is not available in Javascript.

Returns the media element as a CastingSource.

public : CastingSource GetAsCastingSource()public CastingSource GetAsCastingSource()Public Function GetAsCastingSource() As CastingSource// This API is not available in Javascript.

Remarks

For more info about using MediaElement as a casting source, see Media casting.

See Also

Media casting

Returns the RFC 1766 language for the specified audio stream.

public : PlatForm::String GetAudioStreamLanguage(IReference<int> index)public string GetAudioStreamLanguage(Nullable<Int32> index)Public Function GetAudioStreamLanguage(index As Nullable<Int32>) As string// This API is not available in Javascript.

Pauses media at the current position.

public : void Pause()public void Pause()Public Function Pause() As void// This API is not available in Javascript.

Plays media from the current position.

public : void Play()public void Play()Public Function Play() As void// This API is not available in Javascript.

Removes all effects for the next source set for this MediaElement.

public : void RemoveAllEffects()public void RemoveAllEffects()Public Function RemoveAllEffects() As void// This API is not available in Javascript.

Sets the Source of the MediaElement to the specified MediaStreamSource.

public : void SetMediaStreamSource(IMediaSource source)public void SetMediaStreamSource(IMediaSource source)Public Function SetMediaStreamSource(source As IMediaSource) As void// This API is not available in Javascript.

Sets the source of the MediaElement to the specified media playback source.

public : void SetPlaybackSource(IMediaPlaybackSource source)public void SetPlaybackSource(IMediaPlaybackSource source)Public Function SetPlaybackSource(source As IMediaPlaybackSource) As void// This API is not available in Javascript.

Sets the Source property using the specified stream and MIME type.

public : void SetSource(IRandomAccessStream stream, PlatForm::String mimeType)public void SetSource(IRandomAccessStream stream, String mimeType)Public Function SetSource(stream As IRandomAccessStream, mimeType As String) As void// This API is not available in Javascript.

Examples

Here is some code that creates MediaElement object and sets the media source using a FileOpenPicker control.

<MediaElement x:Name="mediaControl" Height="400" />

async private void SetLocalMedia()
{
    var openPicker = new Windows.Storage.Pickers.FileOpenPicker();

    openPicker.FileTypeFilter.Add(".wmv");
    openPicker.FileTypeFilter.Add(".mp4");
    openPicker.FileTypeFilter.Add(".wma");
    openPicker.FileTypeFilter.Add(".mp3");

    var file = await openPicker.PickSingleFileAsync();

    // mediaControl is a MediaElement defined in XAML
    if (null != file)
    {
        var stream = await file.OpenAsync(Windows.Storage.FileAccessMode.Read);
        mediaControl.SetSource(stream, file.ContentType);
        mediaControl.Play();
    }
}

Remarks

You can use the FileOpenPicker control to get the file stream for a media file on the local system.

See Also

Audio, video, and camera

Create custom transport controls

Supported audio and video formats

Stops and resets media to be played from the beginning.

public : void Stop()public void Stop()Public Function Stop() As void// This API is not available in Javascript.

Occurs when the BufferingProgress property changes.

public : event RoutedEventHandler BufferingProgressChangedpublic event RoutedEventHandler BufferingProgressChangedPublic Event BufferingProgressChanged// This API is not available in Javascript.

<MediaElement BufferingProgressChanged="eventhandler"/>

Occurs when the value of the CurrentState property changes.

public : event RoutedEventHandler CurrentStateChangedpublic event RoutedEventHandler CurrentStateChangedPublic Event CurrentStateChanged// This API is not available in Javascript.

<MediaElement CurrentStateChanged="eventhandler"/>

Occurs when the DownloadProgress property has changed.

public : event RoutedEventHandler DownloadProgressChangedpublic event RoutedEventHandler DownloadProgressChangedPublic Event DownloadProgressChanged// This API is not available in Javascript.

<MediaElement DownloadProgressChanged="eventhandler"/>

Occurs when a timeline marker is encountered during media playback.

public : event TimelineMarkerRoutedEventHandler MarkerReachedpublic event TimelineMarkerRoutedEventHandler MarkerReachedPublic Event MarkerReached// This API is not available in Javascript.

<MediaElement MarkerReached="eventhandler"/>

Examples

The following example creates a MediaElement object and responds to its MarkerReached event. Each time a timeline marker is reached, the example displays the timeline marker's Time, Type, and Text values.

<MediaElement Name="Media" Source="video.mp4" MarkerReached="Media_MarkerReached" />
<TextBlock Name="txOutput" />

private void Media_MarkerReached(object sender, TimelineMarkerRoutedEventArgs e)
{
    txOutput.Text =
        string.Format("{0},{1},{2}", e.Marker.Time, e.Marker.Text, e.Marker.Type);
}

Occurs when the MediaElement finishes playing audio or video.

public : event RoutedEventHandler MediaEndedpublic event RoutedEventHandler MediaEndedPublic Event MediaEnded// This API is not available in Javascript.

<MediaElement MediaEnded="eventhandler" ../>

Occurs when there is an error associated with the media Source.

public : event ExceptionRoutedEventHandler MediaFailedpublic event ExceptionRoutedEventHandler MediaFailedPublic Event MediaFailed// This API is not available in Javascript.

<MediaElement MediaFailed="eventhandler" .../>

Examples

The following code creates a MediaFailed event handler that calls a helper function to retrieve the HRESULT from the event arguments.

private void videoMediaElement_MediaFailed(object sender, ExceptionRoutedEventArgs e)
{
    // get HRESULT from event args 
    string hr = GetHresultFromErrorMessage(e);

    // Handle media failed event appropriately 
}

private string GetHresultFromErrorMessage(ExceptionRoutedEventArgs e)
{
    String hr = String.Empty;
    String token = "HRESULT - ";
    const int hrLength = 10;     // eg "0xFFFFFFFF"

    int tokenPos = e.ErrorMessage.IndexOf(token, StringComparison.Ordinal);
    if (tokenPos != -1)
    {
        hr = e.ErrorMessage.Substring(tokenPos + token.Length, hrLength);
    }

    return hr;
}

Remarks

It is a best practice to always handle the MediaFailed event and take appropriate action.

Occurs when the media stream has been validated and opened, and the file headers have been read.

public : event RoutedEventHandler MediaOpenedpublic event RoutedEventHandler MediaOpenedPublic Event MediaOpened// This API is not available in Javascript.

<MediaElement MediaOpened="eventhandler" .../>

Examples

The following code shows how to determine if a media stream is a live stream.

private void media_MediaOpened(object sender, RoutedEventArgs e)
{
    bool isLive = IsLiveStream(sender as MediaElement);
}

private bool IsLiveStream(MediaElement media)
{
    bool isLive = false;

    if (media.NaturalDuration.TimeSpan.Ticks == Int64.MaxValue)
    {
       isLive = true;
    }

    return isLive;
}

Remarks

Live media streams report a NaturalDuration of Int64.MaxValue.

Any calls to Play, Pause, and Stop methods that occur before the MediaOpened event is raised are ignored.

Occurs when one or more streams fails to decode in content containing multiple streams.

public : event TypedEventHandler PartialMediaFailureDetected<MediaElement,  PartialMediaFailureDetectedEventArgs>public event TypedEventHandler PartialMediaFailureDetected<MediaElement,  PartialMediaFailureDetectedEventArgs>Public Event PartialMediaFailureDetected<MediaElement,  PartialMediaFailureDetectedEventArgs>// This API is not available in Javascript.

Remarks

If at least one stream in the content is successfully decoded, the decoded media is played and this event is raised. If the stream that fails to decode is the only stream contained in the content, playback fails and the MediaFailed event is raised.

Occurs when PlaybackRate or DefaultPlaybackRate value changes.

public : event RateChangedRoutedEventHandler RateChangedpublic event RateChangedRoutedEventHandler RateChangedPublic Event RateChanged// This API is not available in Javascript.

<MediaElement RateChanged="eventhandler"/>

Occurs when the seek point of a requested seek operation is ready for playback.

public : event RoutedEventHandler SeekCompletedpublic event RoutedEventHandler SeekCompletedPublic Event SeekCompleted// This API is not available in Javascript.

<MediaElement SeekCompleted="eventhandler"/>

Occurs when the value of the Volume property changes.

public : event RoutedEventHandler VolumeChangedpublic event RoutedEventHandler VolumeChangedPublic Event VolumeChanged// This API is not available in Javascript.

<MediaElement VolumeChanged="eventhandler" />