DataCue DataCue DataCue DataCue Class

Definition

Represents a data cue that can be included in a TimedMetadataTrack.

public : sealed class DataCue : IDataCue, IDataCue2, IMediaCuepublic sealed class DataCue : IDataCue, IDataCue2, IMediaCuePublic NotInheritable Class DataCue Implements IDataCue, IDataCue2, IMediaCue// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

A DataCue 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 DataCue. The Data property of DataCue is an IBuffer that can contain any type of data. If you want to display text when the cue is encountered, the TimedTextCue class is provided for this scenario.

Constructors

DataCue() DataCue() DataCue() DataCue()

Initializes a new instance of the DataCue class.

public : DataCue()public DataCue()Public Sub New()// You can use this method in JavaScript.

Properties

Data Data Data Data

Gets the data associated with the cue.

public : IBuffer Data { get; set; }public IBuffer Data { get; set; }Public ReadWrite Property Data As IBuffer// You can use this property in JavaScript.
Value
IBuffer IBuffer IBuffer IBuffer

The data associated with the cue.

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.

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.

Properties Properties Properties Properties

Gets the collection of custom properties associated with the data cue.

public : PropertySet Properties { get; }public PropertySet Properties { get; }Public ReadOnly Property Properties As PropertySet// You can use this property in JavaScript.
Value
PropertySet PropertySet PropertySet PropertySet

The collection of custom properties associated with the data cue.

Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

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.

See Also