MediaElement class
TOC
Collapse the table of content
Expand the table of content

MediaElement class

Represents an object that renders audio and video to the display.

Use a MediaElement control to play audio and video files in your app. Built–in media transport controls let users interact with their media by providing a default playback experience comprised of various buttons including play, pause, closed captions, and others. See MediaTransportControls for more info.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        MediaElement

Syntax


public sealed class MediaElement : FrameworkElement


<MediaElement .../>

Members

The MediaElement class has these types of members:

Constructors

The MediaElement class has these constructors.

ConstructorDescription
MediaElement Instantiates a new instance of the MediaElement class.

 

Events

The MediaElement class has these events.

EventDescription
AccessKeyDisplayDismissed Occurs when the access key sequence is complete to notify controls that they should hide access key visuals. (Inherited from UIElement)
AccessKeyDisplayRequested Occurs when the access key sequence is started to notify controls that they should show access key visuals. (Inherited from UIElement)
AccessKeyInvoked Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked. (Inherited from UIElement)
BufferingProgressChanged Occurs when the BufferingProgress property changes.
ContextCanceled Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened. (Inherited from UIElement)
ContextRequested Occurs when the user has completed a context input gesture, such as a right-click. (Inherited from UIElement)
CurrentStateChanged Occurs when the value of the CurrentState property changes.
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
DoubleTapped Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
DownloadProgressChanged Occurs when the DownloadProgress property has changed.
DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement)
DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement)
DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement)
DragStarting Occurs when a drag operation is initiated. (Inherited from UIElement)
Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement)
DropCompleted Occurs when a drag-and-drop operation is ended. (Inherited from UIElement)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement)
Holding Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement)
LayoutUpdated Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout. (Inherited from FrameworkElement)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
Loading Occurs when a FrameworkElement begins to load. (Inherited from FrameworkElement)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement)
ManipulationCompleted Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting Occurs when the manipulation processor is first created. (Inherited from UIElement)
MarkerReached Occurs when a timeline marker is encountered during media playback.
MediaEnded Occurs when the MediaElement finishes playing audio or video.
MediaFailed Occurs when there is an error associated with the media Source.
MediaOpened Occurs when the media stream has been validated and opened, and the file headers have been read.
PartialMediaFailureDetected Occurs when one or more streams fails to decode in content containing multiple streams.
PointerCanceled Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement)
PointerReleased Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement)
PointerWheelChanged Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
RateChanged Occurs when PlaybackRate or DefaultPlaybackRate value changes.
RightTapped Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
SeekCompleted Occurs when the seek point of a requested seek operation is ready for playback.
SizeChanged Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
Tapped Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)
VolumeChanged Occurs when the value of the Volume property changes.

 

Methods

The MediaElement class has these methods. It also inherits methods from the Object class.

MethodDescription
AddAudioEffect Applies an audio effect to playback. Takes effect for the next source that is set on this MediaElement.
AddHandler Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere. (Inherited from UIElement)
AddVideoEffect Applies a video effect to playback. Takes effect for the next source that is set on this MediaElement.
Arrange Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement)
ArrangeOverride Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CanPlayType Returns an enumeration value that describes the likelihood that the current MediaElement and its client configuration can play that media source.
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetAsCastingSource Returns the media element as a CastingSource.
GetAudioStreamLanguage Returns the RFC 1766 language for the specified audio stream.
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GoToElementStateCore When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup. (Inherited from FrameworkElement)
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
Measure Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement)
MeasureOverride Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
OnApplyTemplate Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement)
OnDisconnectVisualChildren Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement)
Pause Pauses media at the current position.
Play Plays media from the current position.
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
RegisterPropertyChangedCallback Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject)
ReleasePointerCapture Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveAllEffects Removes all effects for the next source set for this MediaElement.
RemoveHandler Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetMediaStreamSource Sets the Source of the MediaElement to the specified MediaStreamSource.
SetPlaybackSource Sets the source of the MediaElement to the specified media playback source.
SetSource Sets the Source property using the specified stream and MIME type.
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
StartDragAsync Initiates a drag-and-drop operation. (Inherited from UIElement)
Stop Stops and resets media to be played from the beginning.
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement)
UnregisterPropertyChangedCallback Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

 

Properties

The MediaElement class has these properties.

PropertyAccess typeDescription

AccessKey

Read/write

Gets or sets the access key (mnemonic) for this element. (Inherited from UIElement)

AccessKeyScopeOwner

Read/write

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element. (Inherited from UIElement)

ActualHeight

Read-only

Gets the rendered height of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)

ActualStereo3DVideoPackingMode

Read-only

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.

ActualStereo3DVideoPackingModeProperty

Read-only

Identifies the ActualStereo3DVideoPackingMode dependency property.

ActualWidth

Read-only

Gets the rendered width of a FrameworkElement. See Remarks. (Inherited from FrameworkElement)

AllowDrop

Read/write

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)

AllowFocusOnInteraction

Read/write

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from FrameworkElement)

AllowFocusWhenDisabled

Read/write

Gets or sets whether a disabled control can receive focus. (Inherited from FrameworkElement)

AreTransportControlsEnabled

Read/write

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

AreTransportControlsEnabledProperty

Read-only

Identifies the AreTransportControlsEnabled dependency property.

AspectRatioHeight

Read-only

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

AspectRatioHeightProperty

Read-only

Identifies the AspectRatioHeight dependency property.

AspectRatioWidth

Read-only

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

AspectRatioWidthProperty

Read-only

Identifies the AspectRatioWidth dependency property.

AudioCategory

Read/write

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

AudioCategoryProperty

Read-only

Identifies the AudioCategory dependency property.

AudioDeviceType

Read/write

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

AudioDeviceTypeProperty

Read-only

Identifies the AudioDeviceType dependency property.

AudioStreamCount

Read-only

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

AudioStreamCountProperty

Read-only

Identifies the AudioStreamCount dependency property.

AudioStreamIndex

Read/write

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.

AudioStreamIndexProperty

Read-only

Identifies the AudioStreamIndex dependency property.

AutoPlay

Read/write

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

AutoPlayProperty

Read-only

Identifies the AutoPlay dependency property.

Balance

Read/write

Gets or sets a ratio of volume across stereo speakers.

BalanceProperty

Read-only

Identifies the Balance dependency property.

BaseUri

Read-only

Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement)

BufferingProgress

Read-only

Gets a value that indicates the current buffering progress.

BufferingProgressProperty

Read-only

Identifies the BufferingProgress dependency property.

CacheMode

Read/write

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CanDrag

Read-only

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation. (Inherited from UIElement)

CanPause

Read-only

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

CanPauseProperty

Read-only

Identifies the CanPause dependency property.

CanSeek

Read-only

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

CanSeekProperty

Read-only

Identifies the CanSeek dependency property.

Clip

Read/write

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

CompositeMode

Read/write

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI. (Inherited from UIElement)

ContextFlyout

Read/write

Gets or sets the flyout associated with this element. (Inherited from UIElement)

CurrentState

Read-only

Gets the status of this MediaElement.

CurrentStateProperty

Read-only

Identifies the CurrentState dependency property.

DataContext

Read/write

Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)

DefaultPlaybackRate

Read/write

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.

DefaultPlaybackRateProperty

Read-only

Identifies the DefaultPlaybackRate dependency property.

DesiredSize

Read-only

Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

Dispatcher

Read-only

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject)

DownloadProgress

Read-only

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

DownloadProgressOffset

Read-only

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

DownloadProgressOffsetProperty

Read-only

Identifies the DownloadProgressOffset dependency property.

DownloadProgressProperty

Read-only

Identifies the DownloadProgress dependency property.

ExitDisplayModeOnAccessKeyInvoked

Read/write

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked. (Inherited from UIElement)

FlowDirection

Read/write

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left. (Inherited from FrameworkElement)

FocusVisualMargin

Read/write

Gets or sets the outer margin of the focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualPrimaryBrush

Read/write

Gets or sets the brush used to draw the outer border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualPrimaryThickness

Read/write

Gets or sets the thickness of the outer border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualSecondaryBrush

Read/write

Gets or sets the brush used to draw the inner border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

FocusVisualSecondaryThickness

Read/write

Gets or sets the thickness of the inner border of a HighVisibility focus visual for a FrameworkElement. (Inherited from FrameworkElement)

Height

Read/write

Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/write

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement)

IsAccessKeyScope

Read/write

Gets or sets a value that indicates whether an element defines its own access key scope. (Inherited from UIElement)

IsAudioOnly

Read-only

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

IsAudioOnlyProperty

Read-only

Identifies the IsAudioOnly dependency property.

IsDoubleTapEnabled

Read/write

Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsFullWindow

Read/write

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

IsFullWindowProperty

Read-only

Identifies the IsFullWindow dependency property.

IsHitTestVisible

Read/write

Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/write

Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsLooping

Read/write

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.

IsLoopingProperty

Read-only

Identifies the IsLooping dependency property.

IsMuted

Read/write

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

IsMutedProperty

Read-only

Identifies the IsMuted dependency property.

IsRightTapEnabled

Read/write

Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsStereo3DVideo

Read-only

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

IsStereo3DVideoProperty

Read-only

Identifies the IsStereo3DVideo dependency property.

IsTapEnabled

Read/write

Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

Language

Read/write

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI. (Inherited from FrameworkElement)

ManipulationMode

Read/write

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code. (Inherited from UIElement)

Margin

Read/write

Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

Markers

Read-only

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

MaxHeight

Read/write

Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxWidth

Read/write

Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinHeight

Read/write

Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/write

Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

Name

Read/write

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement)

NaturalDuration

Read-only

Gets the duration of the media file currently opened.

NaturalDurationProperty

Read-only

Identifies the NaturalDuration dependency property.

NaturalVideoHeight

Read-only

Gets the height of the video associated with the media.

NaturalVideoHeightProperty

Read-only

Identifies the NaturalVideoHeight dependency property.

NaturalVideoWidth

Read-only

Gets the width of the video associated with the media.

NaturalVideoWidthProperty

Read-only

Identifies the NaturalVideoWidth dependency property.

Opacity

Read/write

Gets or sets the degree of the object's opacity. (Inherited from UIElement)

Parent

Read-only

Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PlaybackRate

Read/write

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

PlaybackRateProperty

Read-only

Identifies the PlaybackRate dependency property.

PlayToPreferredSourceUri

Read/write

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.

PlayToPreferredSourceUriProperty

Read-only

Identifies the PlayToPreferredSourceUri dependency property.

PlayToSource

Read-only

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

PlayToSourceProperty

Read-only

Identifies the PlayToSource dependency property.

PointerCaptures

Read-only

Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

Position

Read/write

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

PositionProperty

Read-only

Identifies the Position dependency property.

PosterSource

Read/write

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

PosterSourceProperty

Read-only

Identifies the PosterSource dependency property.

Projection

Read/write

Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

ProtectionManager

Read/write

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

ProtectionManagerProperty

Read-only

Identifies the ProtectionManager dependency property.

RealTimePlayback

Read/write

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

RealTimePlaybackProperty

Read-only

Identifies the RealTimePlayback dependency property.

RenderSize

Read-only

Gets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/write

Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/write

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/write

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme. (Inherited from FrameworkElement)

Resources

Read/write

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement)

Source

Read/write

Gets or sets a media source on the MediaElement.

SourceProperty

Read-only

Identifies the Source dependency property.

Stereo3DVideoPackingMode

Read/write

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

Stereo3DVideoPackingModeProperty

Read-only

Identifies the Stereo3DVideoPackingMode dependency property.

Stereo3DVideoRenderMode

Read/write

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

Stereo3DVideoRenderModeProperty

Read-only

Identifies the Stereo3DVideoRenderMode dependency property.

Stretch

Read/write

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

StretchProperty

Read-only

Identifies the Stretch dependency property.

Style

Read/write

Gets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)

Tag

Read/write

Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)

Transform3D

Read-only

Gets or sets the 3-D transform effect to apply when rendering this element. (Inherited from UIElement)

Transitions

Read/write

Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

TransportControls

Read/write

Gets or sets the transport controls for the media.

Triggers

Read-only

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)

UseLayoutRounding

Read/write

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement)

VerticalAlignment

Read/write

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement)

Visibility

Read/write

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement)

Volume

Read/write

Gets or sets the media's volume.

VolumeProperty

Read-only

Identifies the Volume dependency property.

Width

Read/write

Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

 

Remarks

For info about the media formats that MediaElement supports, see Supported codecs.

For info about performance related to MediaElement, see Optimize animations and media.

Set the media source

Set the Source property of the MediaElement object to point to an audio or video file. The property can be set to the Uniform Resource Identifier (URI) of a file that is included with the app or the URI of a file on the network. You can use the SetSource method to set the source to a file retrieved from the local system by using a FileOpenPicker object.

By default, the media that is defined by the Source property plays immediately after the MediaElement object has loaded. To suppress the media from starting automatically, set the AutoPlay property to false.

Live media streams report a NaturalDuration of Int64.MaxValue.

Here's how to create a MediaElement in XAML with the Source set to the path of a video file that is included in the app and the AutoPlay property explicitly set to false.


<MediaElement Source="Media/video1.mp4" AutoPlay="false"/>

Here's how to create the MediaElement in code.


MediaElement mediaElement1 = new MediaElement();
mediaElement1.Source = new Uri("ms-appx:///Media/video1.mp4");
mediaElement1.AutoPlay = false;

// Add the MediaElement to the page.
rootGrid.Children.Add(mediaElement1);

Handle media events

You can respond to common media events such as the MediaOpened, MediaEnded, MediaFailed, and CurrentStateChanged events. It is good practice to always handle the MediaFailed event.

Transport controls

Set the AreTransportControlsEnabled property to programmatically enable and disable the built in transport controls for the MediaElement. The built in transport controls provide UI for playing, stopping, pausing, and seeking the media, as well as UI for volume, mute, full window, track selection, and remaining time.

You can create your own media transport controls by setting AreTransportControlsEnabled to false, and using the Play, Pause, and Stop methods. MediaElement also exposes a rich set of properties you can control like Position, Volume, IsMuted, IsLooping, PlaybackRate, and Balance.

Tip  For better performance, avoid data binding to the Position property to reflect frequent position updates (for example with a progress bar). Instead, use the DispatcherTimer to query the Position property.
 

For more info and examples, see Create custom transport controls.

Open local media files

To open files on the local system or from Microsoft OneDrive, you can use the FileOpenPicker to get the file and SetSource to set the media source, or you can programmatically access the user media folders.

If your app needs access without user interaction to the Music or Video folders, for example if you are enumerating all the music or video files in the user's collection and displaying them in your app, then you need to declare the Music Library and Video Library capabilities. For more info, see Files and folders in the Music, Pictures, and Videos libraries.

The FileOpenPicker does not require special Capabilities to access files on the local file system, such as the user's Music or Video folders, since the user has complete control over which file is being accessed. From a security and privacy standpoint, it is best to minimize the number of capabilities your app uses.

BR242926.wedge(en-us,WIN.10).gifTo open local media using FileOpenPicker

  1. 1. Call FileOpenPicker to let the user pick a media file.

    Use the FileOpenPicker class to select a media file. Set the FileTypeFilter to specify which file types the FileOpenPicker will display. Call PickSingleFileAsync to launch the file picker and get the file.

  2. Call SetSource to set the chosen media file as the MediaElement.Source.

    To set the Source of the MediaElement to the StorageFile returned from the FileOpenPicker, you need to open a stream. Call the OpenAsync method on the StorageFile returns a stream that you can pass into the MediaElement.SetSource method. Then call Play on the MediaElement to start the media.

This example shows how to use the FileOpenPicker to choose a file and set the file as the Source of a MediaElement.


<MediaElement x:Name="mediaPlayer"/>
...
<Button Content="Choose file" Click="Button_Click"/>



private async void Button_Click(object sender, RoutedEventArgs e)
{
    await SetLocalMedia();
}

async private System.Threading.Tasks.Task 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();

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

        mediaPlayer.Play();
    }
}


Select audio tracks in different languages

Use the AudioStreamIndex property and the GetAudioStreamLanguage method to change the audio to a different language track on a video. Videos can also contain multiple audio tracks in the same language, such as director commentaries on films. This example specifically shows how to switch between different languages, but you can modify this code to switch between any audio tracks.

BR242926.wedge(en-us,WIN.10).gifTo select audio tracks in different languages

  1. Get the audio tracks.

    To search for a track in a specific language, start by iterating through each audio track on the video. Use AudioStreamCount as the max value for a for loop.

  2. Get the language of the audio track.

    Use the GetAudioStreamLanguage method to get the language of the track. The language of the track is identified by a language code, such as "en" for English or "ja" for Japanese.

  3. Set the active audio track.

    When you find the track with the desired language, set the AudioStreamIndex to the index of the track. Setting AudioStreamIndex to null selects the default audio track which is defined by the content.

Here's some code that attempts to set the audio track to the specified language. It iterates through the audio tracks on a MediaElement object and uses GetAudioStreamLanguage to get the language of each track. If the desired language track exists, the AudioStreamIndex is set to the index of that track.


/// <summary>
/// Attemps to set the audio track of a video to a specific language
/// </summary>
/// <param name="lcid">The id of the language. For example, "en" or "ja"</param>
/// <returns>true if the track was set; otherwise, false.</returns>
private bool SetAudioLanguage(string lcid, MediaElement media)
{
    bool wasLanguageSet = false;

    for (int index = 0; index < media.AudioStreamCount; index++)
    {
        if (media.GetAudioStreamLanguage(index) == lcid)
        {
            media.AudioStreamIndex = index;
            wasLanguageSet = true;
        }
    }

    return wasLanguageSet;
}


Full window playback

Use the IsFullWindow property to enable and disable full window rendering. 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.

Caution  

We recommend that you not use MediaElement in a Popup control. If a MediaElement hosted in a Popup is switched to full-window mode, the Popup is rendered on top of the MediaElement. If you must use a MediaElement in a Popup, you should collapse the Popup when the MediaElement enters full-window mode, and restore the Popup when the MediaElement exits full-window mode. Use DependencyProperty.RegisterPropertyChangedCallback to be notified when the MediaElement.IsFullWindow property changes. For an example, see the Examples section.

 

Keep media playing

To prevent the display from being deactivated when user action is no longer detected, such as when an app is playing video, you can call DisplayRequest.RequestActive. To conserve power and battery life, you should call DisplayRequest.RequestRelease to release the display request as soon as it is no longer required.

Here are some situations when you should release the display request:

  • Video playback is paused, for example by user action, buffering, or adjustment due to limited bandwidth.
  • Playback stops. For example, the video is done playing or the presentation is over.
  • A playback error has occurred. For example, network connectivity issues or a corrupted file.

Here, you use the CurrentStateChanged event to detect these situations. Then, use the IsAudioOnly property to determine whether an audio or video file is playing, and keep the screen active only if video is playing.


<MediaElement Source="Media/video1.mp4"
              CurrentStateChanged="MediaElement_CurrentStateChanged"/>



// Create this variable at a global scope. Set it to null.
private DisplayRequest appDisplayRequest = null;

private void MediaElement_CurrentStateChanged(object sender, RoutedEventArgs e)
{
    MediaElement mediaElement = sender as MediaElement;
    if (mediaElement != null && mediaElement.IsAudioOnly == false)
    {
        if (mediaElement.CurrentState == Windows.UI.Xaml.Media.MediaElementState.Playing)
        {                
            if (appDisplayRequest == null)
            {
                // This call creates an instance of the DisplayRequest object. 
                appDisplayRequest = new DisplayRequest();
                appDisplayRequest.RequestActive();
            }
        }
        else // CurrentState is Buffering, Closed, Opening, Paused, or Stopped. 
        {
            if (appDisplayRequest != null)
            {
                // Deactivate the display request and set the var to null.
                appDisplayRequest.RequestRelease();
                appDisplayRequest = null;
            }
        }            
    }
}

Poster source

You can use the PosterSource property to provide your MediaElement with a visual representation before the media is loaded. A PosterSource is an image, such as a screen shot or movie poster, that is displayed in place of the media. The PosterSource is displayed in the following situations:

  • When a valid source is not set. For example, Source is not set, Source was 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.
  • When media is streaming to another device.
  • When the media is audio only.

Notes for previous versions

Windows 8.1

On Windows Phone, you can only have one MediaElement at a time.

To let audio continue to play when your app is in the background, set the AudioCategory property to BackgroundCapableMedia. This also requires declaring the "Audio" background task capability in the app manifest. These values are deprecated in Windows 10.

Windows 8

Prior to Windows 8.1, the IsFullWindow property in not available. To enable full window video playback you must set the Width and Height of the MediaElement to the Window.Bounds of the current window. Specifically, use Window.Current.Bounds.Width and Window.Current.Bounds.Height. Full window playback will not take advantage of system optimizations if you set the dimensions of a parent element, such as a grid, or a containing element instead of the MediaElement.

Prior to Windows 8.1, the Opacity property is not supported on MediaElement.

Prior to Windows 8.1, the AreTransportControlsEnabled property and built-in transport controls are not available. You must provide your own transport controls. For more info and examples, see Create custom transport controls and scenario 4 of the XAML media playback sample.

Windows Phone 8

Windows Phone Store apps must use PickSingleFileAndContinue to open local media files.

Examples

This code creates a MediaElement with the AutoPlay property explicitly set to true and the Source set to the path of a video file that is included in the app.


<MediaElement Source="Media/video1.mp4" AutoPlay="True" />


Here is some code that creates a MediaElement using the built in transport controls introduced in Windows 8.1 and sets the AutoPlay property to false.


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


This example shows how to collapse and restore a Popup when MediaElement.IsFullWindow is toggled.


<Grid>
    <Button Content="Show Popup" Click="ShowPopupClicked"/>
    <Popup x:Name="mediaPlayerPopup">
        <StackPanel Height="1400" Width="1400" Background="Blue">
            <MediaElement x:Name="mediaPlayer" 
                  AreTransportControlsEnabled="True" 
                  Source="Media/Intro.wmv"/>
            <TextBlock Text="Simple Popup"/>
            <Button Content="Close" Click="ClosePopupClicked"/>
        </StackPanel>
    </Popup>
</Grid>



long token;

protected override void OnNavigatedTo(NavigationEventArgs e)
{
    token = mediaPlayer.RegisterPropertyChangedCallback(MediaElement.IsFullWindowProperty, OnMEFullWindowChanged);
    base.OnNavigatedTo(e);
}

protected override void OnNavigatedFrom(NavigationEventArgs e)
{
    mediaPlayer.UnregisterPropertyChangedCallback(MediaElement.IsFullWindowProperty, token);
}

private void OnMEFullWindowChanged(DependencyObject sender, DependencyProperty dp)
{
    MediaElement me = (MediaElement)sender;

    if (me != null && dp == MediaElement.IsFullWindowProperty)
    {
        if (me.IsFullWindow == true)
        {
            mediaPlayerPopup.Visibility = Visibility.Collapsed;
        }
        else
        {
            mediaPlayerPopup.Visibility = Visibility.Visible;
        }
    }  
}

private void ClosePopupClicked(object sender, RoutedEventArgs e)
{
    // If the Popup is open, then close it.
    if (mediaPlayerPopup.IsOpen) { mediaPlayerPopup.IsOpen = false; }
}

// Handles the Click event on the Button on the page and opens the Popup. 
private void ShowPopupClicked(object sender, RoutedEventArgs e)
{
    // Open the Popup if it isn't open already. 
    if (!mediaPlayerPopup.IsOpen) { mediaPlayerPopup.IsOpen = true; }
}

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

See also

Object
Control
MediaElement control guide
Create custom transport controls
Media transport controls sample
Video playback sample
Real-time communication sample (Windows 10)

 

 

Show:
© 2016 Microsoft