MediaElement class (Windows)

3 out of 11 rated this helpful - Rate this topic

Represents an object that contains audio, video, or both.

For more information on audio and video playback in a Windows Store app built for Windows using C++, C#, or Visual Basic, see Quickstart: create a media player application and Quickstart: video and audio.

For a sample that uses the MediaElement for video playback, see XAML media playback sample.

Inheritance

Object
DependencyObject
UIElement
FrameworkElement
MediaElement

Syntax

C++


public sealed class MediaElement : FrameworkElement

XAML Object Element Usage


<MediaElement .../>

Attributes

ActivatableAttribute(NTDDI_WIN8)
MarshalingBehaviorAttribute(Agile)
StaticAttribute(Windows.UI.Xaml.Controls.IMediaElementStatics, NTDDI_WIN8)
ThreadingAttribute(Both)
VersionAttribute(NTDDI_WIN8)
WebHostHiddenAttribute()

Members

The MediaElement class has these types of members:

Constructors
Events
Methods
Properties

Constructors

The MediaElement class has these constructors.

Constructor	Description
MediaElement	Instantiates a new instance of the MediaElement class.

Events

The MediaElement class has these events.

Event	Description
BufferingProgressChanged	Occurs when the BufferingProgress property changes.
CurrentStateChanged	Occurs when the value of the CurrentState property changes.
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)
Drop	Occurs when the input system reports an underlying drop event with this element as the drop target. (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. (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)
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.
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 changes value.
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.

Method	Description
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)
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)
GetAudioStreamLanguage	Returns the RFC 1766 language for the specified audio stream.
GetValue	Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
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)
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)
SetSource	Sets the Source property using the supplied stream.
SetValue	Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
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)
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.

Property	Access type	Description
ActualHeight	Read-only	Gets the rendered height of a FrameworkElement. (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. (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)
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)
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)
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. (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.
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)
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)
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)
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. (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.
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)
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.
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)
Transitions	Read/write	Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)
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 information on performance related to MediaElement, see Optimize media resources.

Live media streams report a NaturalDuration of Int64.MaxValue.

To enable full-screen 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 screen 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.

To prevent the display from being deactivated when user action is no longer detected, such as when an app is playing full-screen video, you can call DisplayRequest.RequestActive. To conserve power and battery life, you should call DisplayRequest.RequestRelease to release the display request when it is no longer required. See the Display power state sample for more info.

The Opacity property is not supported on MediaElement.

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. See Quickstart: create a media player application for more info on using the MediaElement.

XAML


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

Requirements

Minimum supported client	Windows 8 [Windows Store apps only]
Minimum supported server	Windows Server 2012 [Windows Store apps only]
Namespace	Windows.UI.Xaml.Controls Windows::UI::Xaml::Controls [C++]
Metadata	Windows.winmd

MediaElement class