TimedTextCue
TimedTextCue
TimedTextCue
TimedTextCue
Class
Definition
Represents a text cue in a TimedMetadataTrack.
public : sealed class TimedTextCue : IMediaCue, ITimedTextCuepublic sealed class TimedTextCue : IMediaCue, ITimedTextCuePublic NotInheritable Class TimedTextCue Implements IMediaCue, ITimedTextCue// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
After creating a TimeTextCue, you can add it to a TimedMetadataTrack by calling AddCue.
Constructors
TimedTextCue() TimedTextCue() TimedTextCue() TimedTextCue()
Initializes a new instance of the TimedTextCue class.
public : TimedTextCue()public TimedTextCue()Public Sub New()// You can use this method in JavaScript.
Properties
CueRegion CueRegion CueRegion CueRegion
Gets or sets the TimedTextRegion of the cue, which defines the style of the rendering area for the cue.
public : TimedTextRegion CueRegion { get; set; }public TimedTextRegion CueRegion { get; set; }Public ReadWrite Property CueRegion As TimedTextRegion// You can use this property in JavaScript.
The TimedTextRegion of the cue
CueStyle CueStyle CueStyle CueStyle
Gets or sets the TimedTextStyle of the cue, which defines the style of the rendered text.
public : TimedTextStyle CueStyle { get; set; }public TimedTextStyle CueStyle { get; set; }Public ReadWrite Property CueStyle As TimedTextStyle// You can use this property in JavaScript.
The TimedTextStyle of 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 or sets an identifier for the cue.
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
An identifier for the cue.
Lines Lines Lines Lines
Gets the collection of TimedTextLine objects that convey the text of the cue.
public : IVector<TimedTextLine> Lines { get; }public IList<TimedTextLine> Lines { get; }Public ReadOnly Property Lines As IList<TimedTextLine>// You can use this property in JavaScript.
- Value
- IVector<TimedTextLine> IList<TimedTextLine> IList<TimedTextLine> IList<TimedTextLine>
A collection of TimedTextLine objects.
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.