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
Attributes
Windows 10 requirements
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

ImageCue() ImageCue() ImageCue()

Initializes a new instance of the ImageCue class.

public ImageCue()public ImageCue()Public Sub New()
Attributes

Properties

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
Value
TimeSpan TimeSpan TimeSpan

The duration of the cue.

Attributes

Remarks

At the end of a cue's duration, the TimedMetadataTrack.CueExited event is raised.

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
Value
TimedTextSize TimedTextSize TimedTextSize

The extent of the ImageCue

Attributes

Id Id Id

Gets the identifier for the timed metadata track.

public string Id { get; set; }public string Id { get; set; }Public ReadWrite Property Id As string
Value
string string string

The identifier for the timed metadata track.

Attributes

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
Value
TimedTextPoint TimedTextPoint TimedTextPoint

The position of the image associated with the ImageCue

Attributes

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
Value
SoftwareBitmap SoftwareBitmap SoftwareBitmap

The image associated with the image cue.

Attributes

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
Value
TimeSpan TimeSpan TimeSpan

The start time of the cue.

Attributes

Remarks

When a cue's start time is reached, the TimedMetadataTrack.CueEntered event is raised.