ImageCue
ImageCue
ImageCue
ImageCue
Class
Definition
Represents a image cue that can be included in a TimedMetadataTrack.
public : sealed class ImageCue : IImageCue, IMediaCuepublic sealed class ImageCue : IImageCue, IMediaCuePublic NotInheritable Class ImageCue Implements IImageCue, IMediaCue// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 Creators Update (introduced v10.0.15063.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v4)
|
Remarks
An ImageCue can be added to a TimedMetadataTrack with the AddCue method. When the cue's start time is reached, the CueEntered event is raised and you can use the MediaCueEventArgs passed into the handler to get a copy of the ImageCue.
Constructors
Properties
Duration Duration Duration Duration
Gets or sets the duration of the cue.
public : TimeSpan Duration { get; set; }public TimeSpan Duration { get; set; }Public ReadWrite Property Duration As TimeSpan// You can use this property in JavaScript.
- Value
- TimeSpan TimeSpan TimeSpan TimeSpan
The duration of the cue.
Remarks
At the end of a cue's duration, the TimedMetadataTrack.CueExited event is raised.
Extent Extent Extent Extent
Gets or sets the extent of the ImageCue, which is the rendered size of the assoociated image either in pixels or in percentage of available space.
public : TimedTextSize Extent { get; set; }public TimedTextSize Extent { get; set; }Public ReadWrite Property Extent As TimedTextSize// You can use this property in JavaScript.
The extent of the ImageCue
Id Id Id Id
Gets the identifier for the timed metadata track.
public : PlatForm::String Id { get; set; }public string Id { get; set; }Public ReadWrite Property Id As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The identifier for the timed metadata track.
Position Position Position Position
Gets or sets the position of the image associated with the ImageCue, relative to the top left corner of the video frame.
public : TimedTextPoint Position { get; set; }public TimedTextPoint Position { get; set; }Public ReadWrite Property Position As TimedTextPoint// You can use this property in JavaScript.
The position of the image associated with the ImageCue
SoftwareBitmap SoftwareBitmap SoftwareBitmap SoftwareBitmap
Gets or sets the image associated with the image cue.
public : SoftwareBitmap SoftwareBitmap { get; set; }public SoftwareBitmap SoftwareBitmap { get; set; }Public ReadWrite Property SoftwareBitmap As SoftwareBitmap// You can use this property in JavaScript.
The image associated with the image cue.
StartTime StartTime StartTime StartTime
Gets the start time of the cue.
public : TimeSpan StartTime { get; set; }public TimeSpan StartTime { get; set; }Public ReadWrite Property StartTime As TimeSpan// You can use this property in JavaScript.
- Value
- TimeSpan TimeSpan TimeSpan TimeSpan
The start time of the cue.
Remarks
When a cue's start time is reached, the TimedMetadataTrack.CueEntered event is raised.