MediaTimeline MediaTimeline MediaTimeline MediaTimeline Class

Definition

Provides a Timeline for media content.

public ref class MediaTimeline : System::Windows::Media::Animation::Timeline, System::Windows::Markup::IUriContext
public class MediaTimeline : System.Windows.Media.Animation.Timeline, System.Windows.Markup.IUriContext
type MediaTimeline = class
    inherit Timeline
    interface IUriContext
Public Class MediaTimeline
Inherits Timeline
Implements IUriContext
Inheritance
Implements

Remarks

MediaTimeline is a Timeline object which provides control over media timing in the same way that animation timeline objects control animations. For example, a MediaTimeline has associated Duration and BeginTime properties can be used to specify when media begins and how long it plays. See Animation Overview for more information on animation timelines.

There are two ways to associate a Timeline to a MediaElement using a MediaTimeline.

  1. Inside of a Storyboard, when a MediaTimeline is targets a MediaElement, a MediaClock will be created and assigned to the MediaElement’s associated player. See How to: Control a MediaElement by Using a Storyboard for an example;

  2. By explicitly creating a MediaClock from a MediaTimeline and assigning it to a MediaElement.

If the Duration of the MediaTimeline is set to Automatic (default), the duration of MediaTimeline is the natural duration of the media source. To find the natural duration of the media source programmatically, query the NaturalDuration property of the MediaElement.

Constructors

MediaTimeline() MediaTimeline() MediaTimeline() MediaTimeline()

Initializes a new instance of the MediaTimeline class.

MediaTimeline(Nullable<TimeSpan>) MediaTimeline(Nullable<TimeSpan>) MediaTimeline(Nullable<TimeSpan>) MediaTimeline(Nullable<TimeSpan>)

Initializes a new instance of the MediaTimeline that begins at the specified time.

MediaTimeline(Nullable<TimeSpan>, Duration) MediaTimeline(Nullable<TimeSpan>, Duration) MediaTimeline(Nullable<TimeSpan>, Duration) MediaTimeline(Nullable<TimeSpan>, Duration)

Initializes a new instance of the MediaTimeline that begins at the specified time and lasts for the specified duration.

MediaTimeline(Nullable<TimeSpan>, Duration, RepeatBehavior) MediaTimeline(Nullable<TimeSpan>, Duration, RepeatBehavior) MediaTimeline(Nullable<TimeSpan>, Duration, RepeatBehavior) MediaTimeline(Nullable<TimeSpan>, Duration, RepeatBehavior)

Initializes a new instance of the MediaTimeline class that begins at the specified time over the specified time and has the specified repeat behavior.

MediaTimeline(Uri) MediaTimeline(Uri) MediaTimeline(Uri) MediaTimeline(Uri)

Initializes a new instance of a MediaTimeline class using the supplied Uri as the media source.

Fields

SourceProperty SourceProperty SourceProperty SourceProperty

Identifies the Source dependency property.

Properties

AccelerationRatio AccelerationRatio AccelerationRatio AccelerationRatio

Gets or sets a value specifying the percentage of the timeline's Duration spent accelerating the passage of time from zero to its maximum rate.

(Inherited from Timeline)
AutoReverse AutoReverse AutoReverse AutoReverse

Gets or sets a value that indicates whether the timeline plays in reverse after it completes a forward iteration.

(Inherited from Timeline)
BeginTime BeginTime BeginTime BeginTime

Gets or sets the time at which this Timeline should begin.

(Inherited from Timeline)
CanFreeze CanFreeze CanFreeze CanFreeze

Gets a value that indicates whether the object can be made unmodifiable.

(Inherited from Freezable)
DecelerationRatio DecelerationRatio DecelerationRatio DecelerationRatio

Gets or sets a value specifying the percentage of the timeline's Duration spent decelerating the passage of time from its maximum rate to zero.

(Inherited from Timeline)
DependencyObjectType DependencyObjectType DependencyObjectType DependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance.

(Inherited from DependencyObject)
Dispatcher Dispatcher Dispatcher Dispatcher

Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
Duration Duration Duration Duration

Gets or sets the length of time for which this timeline plays, not counting repetitions.

(Inherited from Timeline)
FillBehavior FillBehavior FillBehavior FillBehavior

Gets or sets a value that specifies how the Timeline behaves after it reaches the end of its active period.

(Inherited from Timeline)
HasAnimatedProperties HasAnimatedProperties HasAnimatedProperties HasAnimatedProperties

Gets a value that indicates whether one or more AnimationClock objects is associated with any of this object's dependency properties.

(Inherited from Animatable)
IsFrozen IsFrozen IsFrozen IsFrozen

Gets a value that indicates whether the object is currently modifiable.

(Inherited from Freezable)
IsSealed IsSealed IsSealed IsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).

(Inherited from DependencyObject)
Name Name Name Name

Gets or sets the name of this Timeline.

(Inherited from Timeline)
RepeatBehavior RepeatBehavior RepeatBehavior RepeatBehavior

Gets or sets the repeating behavior of this timeline.

(Inherited from Timeline)
Source Source Source Source

Gets or sets the media source associated with the timeline.

SpeedRatio SpeedRatio SpeedRatio SpeedRatio

Gets or sets the rate, relative to its parent, at which time progresses for this Timeline.

(Inherited from Timeline)

Methods

AllocateClock() AllocateClock() AllocateClock() AllocateClock()

Creates a MediaClock for this timeline.

ApplyAnimationClock(DependencyProperty, AnimationClock) ApplyAnimationClock(DependencyProperty, AnimationClock) ApplyAnimationClock(DependencyProperty, AnimationClock) ApplyAnimationClock(DependencyProperty, AnimationClock)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the SnapshotAndReplace handoff behavior is used.

(Inherited from Animatable)
ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior) ApplyAnimationClock(DependencyProperty, AnimationClock, HandoffBehavior)

Applies an AnimationClock to the specified DependencyProperty. If the property is already animated, the specified HandoffBehavior is used.

(Inherited from Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline) BeginAnimation(DependencyProperty, AnimationTimeline) BeginAnimation(DependencyProperty, AnimationTimeline) BeginAnimation(DependencyProperty, AnimationTimeline)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the SnapshotAndReplace handoff behavior is used.

(Inherited from Animatable)
BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior) BeginAnimation(DependencyProperty, AnimationTimeline, HandoffBehavior)

Applies an animation to the specified DependencyProperty. The animation is started when the next frame is rendered. If the specified property is already animated, the specified HandoffBehavior is used.

(Inherited from Animatable)
CheckAccess() CheckAccess() CheckAccess() CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.

(Inherited from DependencyObject)
ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.

(Inherited from DependencyObject)
Clone() Clone() Clone() Clone()

Creates a modifiable clone of this MediaTimeline, making deep copies of this object's values. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.

CloneCore(Freezable) CloneCore(Freezable) CloneCore(Freezable) CloneCore(Freezable)

Makes this instance a deep copy of the specified MediaTimeline. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.

CloneCurrentValue() CloneCurrentValue() CloneCurrentValue() CloneCurrentValue()

Creates a modifiable clone of this MediaTimeline object, making deep copies of this object's current values. Resource references, data bindings, and animations are not copied, but their current values are.

CloneCurrentValueCore(Freezable) CloneCurrentValueCore(Freezable) CloneCurrentValueCore(Freezable) CloneCurrentValueCore(Freezable)

Makes this instance a modifiable deep copy of the specified MediaTimeline using current property values. Resource references, data bindings, and animations are not copied, but their current values are.

CoerceValue(DependencyProperty) CoerceValue(DependencyProperty) CoerceValue(DependencyProperty) CoerceValue(DependencyProperty)

Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.

(Inherited from DependencyObject)
CreateClock() CreateClock() CreateClock() CreateClock()

Creates a new MediaClock associated with the MediaTimeline.

CreateClock(Boolean) CreateClock(Boolean) CreateClock(Boolean) CreateClock(Boolean)

Creates a new Clock from this Timeline and specifies whether the new Clock is controllable. If this Timeline has children, a tree of clocks is created with this Timeline as the root.

(Inherited from Timeline)
CreateInstance() CreateInstance() CreateInstance() CreateInstance()

Initializes a new instance of the Freezable class.

(Inherited from Freezable)
CreateInstanceCore() CreateInstanceCore() CreateInstanceCore() CreateInstanceCore()

Creates a new instance of the MediaTimeline.

DesiredFrameRate DesiredFrameRate DesiredFrameRate DesiredFrameRate Inherited from Timeline
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

(Inherited from DependencyObject)
Freeze() Freeze() Freeze() Freeze()

Makes the current object unmodifiable and sets its IsFrozen property to true.

(Inherited from Freezable)
FreezeCore(Boolean) FreezeCore(Boolean) FreezeCore(Boolean) FreezeCore(Boolean)

Makes this instance of MediaTimeline unmodifiable or determines whether it can be made unmodifiable.

GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty) GetAnimationBaseValue(DependencyProperty)

Returns the non-animated value of the specified DependencyProperty.

(Inherited from Animatable)
GetAsFrozen() GetAsFrozen() GetAsFrozen() GetAsFrozen()

Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.

(Inherited from Freezable)
GetAsFrozenCore(Freezable) GetAsFrozenCore(Freezable) GetAsFrozenCore(Freezable) GetAsFrozenCore(Freezable)

Makes this instance a clone of the specified MediaTimeline object.

GetCurrentValueAsFrozen() GetCurrentValueAsFrozen() GetCurrentValueAsFrozen() GetCurrentValueAsFrozen()

Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.

(Inherited from Freezable)
GetCurrentValueAsFrozenCore(Freezable) GetCurrentValueAsFrozenCore(Freezable) GetCurrentValueAsFrozenCore(Freezable) GetCurrentValueAsFrozenCore(Freezable)

Makes this instance a frozen clone of the specified MediaTimeline. Resource references, data bindings, and animations are not copied, but their current values are.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gets a hash code for this DependencyObject.

(Inherited from DependencyObject)
GetLocalValueEnumerator() GetLocalValueEnumerator() GetLocalValueEnumerator() GetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

(Inherited from DependencyObject)
GetNaturalDuration(Clock) GetNaturalDuration(Clock) GetNaturalDuration(Clock) GetNaturalDuration(Clock)

Returns the length of a single iteration of this Timeline.

(Inherited from Timeline)
GetNaturalDurationCore(Clock) GetNaturalDurationCore(Clock) GetNaturalDurationCore(Clock) GetNaturalDurationCore(Clock)

Retrieves the Duration from a specified clock.

GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property on this instance of a DependencyObject.

(Inherited from DependencyObject)
InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty)

Re-evaluates the effective value for the specified dependency property

(Inherited from DependencyObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnChanged() OnChanged() OnChanged() OnChanged()

Called when the current Freezable object is modified.

(Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject) OnFreezablePropertyChanged(DependencyObject, DependencyObject) OnFreezablePropertyChanged(DependencyObject, DependencyObject) OnFreezablePropertyChanged(DependencyObject, DependencyObject)

Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set.

(Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty) OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)

This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.

(Inherited from Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs)

Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable.

(Inherited from Freezable)
ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if it exists.

(Inherited from DependencyObject)
ReadPreamble() ReadPreamble() ReadPreamble() ReadPreamble()

Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties.

(Inherited from Freezable)
SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object)

Sets the value of a dependency property without changing its value source.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object)

Sets the local value of a dependency property, specified by its dependency property identifier.

(Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.

(Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.

(Inherited from DependencyObject)
ToString() ToString() ToString() ToString()

Returns the string that represents the media source.

VerifyAccess() VerifyAccess() VerifyAccess() VerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
WritePostscript() WritePostscript() WritePostscript() WritePostscript()

Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties.

(Inherited from Freezable)
WritePreamble() WritePreamble() WritePreamble() WritePreamble()

Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties.

(Inherited from Freezable)

Explicit Interface Implementations

IUriContext.BaseUri IUriContext.BaseUri IUriContext.BaseUri IUriContext.BaseUri

Gets or sets the base URI of the current application context.

Events

Changed Changed Changed Changed

Occurs when the Freezable or an object it contains is modified.

(Inherited from Freezable)
Completed Completed Completed Completed

Occurs when this timeline has completely finished playing: it will no longer enter its active period.

(Inherited from Timeline)
CurrentGlobalSpeedInvalidated CurrentGlobalSpeedInvalidated CurrentGlobalSpeedInvalidated CurrentGlobalSpeedInvalidated

Occurs when the rate at which time progresses for the timeline's clock changes.

(Inherited from Timeline)
CurrentStateInvalidated CurrentStateInvalidated CurrentStateInvalidated CurrentStateInvalidated

Occurs when the CurrentState property of the timeline's Clock is updated.

(Inherited from Timeline)
CurrentTimeInvalidated CurrentTimeInvalidated CurrentTimeInvalidated CurrentTimeInvalidated

Occurs when the CurrentTime property of the timeline's Clock is updated.

(Inherited from Timeline)
RemoveRequested RemoveRequested RemoveRequested RemoveRequested

Occurs when the clock created for this timeline or one of its parent timelines is removed.

(Inherited from Timeline)

Applies to