TimedTextSource TimedTextSource TimedTextSource TimedTextSource Class

Definition

Represents a source of timed text data.

public : sealed class TimedTextSource : ITimedTextSourcepublic sealed class TimedTextSource : ITimedTextSourcePublic NotInheritable Class TimedTextSource Implements ITimedTextSource// 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

Get an instance of TimedTextSource from one of the factory methods, CreateFromStream or CreateFromUri. After obtaining an instance, you can use it to set the MediaSource.ExternalTimedTextSources property of a MediaSource object to initialize its ExternalTimedMetadataTracks collection.

For how-to guidance for working with external timed text sources, see Media items, playlists, and tracks.

Methods

CreateFromStream(IRandomAccessStream) CreateFromStream(IRandomAccessStream) CreateFromStream(IRandomAccessStream) CreateFromStream(IRandomAccessStream)

Creates a new instance of TimedTextSource from the provided stream.

public : static TimedTextSource CreateFromStream(IRandomAccessStream stream)public static TimedTextSource CreateFromStream(IRandomAccessStream stream)Public Static Function CreateFromStream(stream As IRandomAccessStream) As TimedTextSource// You can use this method in JavaScript.
Parameters
stream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

The stream from which the timed text source is created.

Returns
See Also

CreateFromStream(IRandomAccessStream, String) CreateFromStream(IRandomAccessStream, String) CreateFromStream(IRandomAccessStream, String) CreateFromStream(IRandomAccessStream, String)

Creates a new instance of TimedTextSource with the specified default language from the provided stream.

public : static TimedTextSource CreateFromStream(IRandomAccessStream stream, PlatForm::String defaultLanguage)public static TimedTextSource CreateFromStream(IRandomAccessStream stream, String defaultLanguage)Public Static Function CreateFromStream(stream As IRandomAccessStream, defaultLanguage As String) As TimedTextSource// You can use this method in JavaScript.
Parameters
stream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

The stream from which the timed text source is created.

defaultLanguage
PlatForm::String String String String

A string specifying the default language for the timed text source.

Returns
See Also

CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream) CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream) CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream) CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream)

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index streams.

public : static TimedTextSource CreateFromStreamWithIndex(IRandomAccessStream stream, IRandomAccessStream indexStream)public static TimedTextSource CreateFromStreamWithIndex(IRandomAccessStream stream, IRandomAccessStream indexStream)Public Static Function CreateFromStreamWithIndex(stream As IRandomAccessStream, indexStream As IRandomAccessStream) As TimedTextSource// You can use this method in JavaScript.
Parameters
stream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

A stream containing the image data for image-based subtitles.

indexStream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

A stream containing the index data for image-based subtitles.

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

CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream, String) CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream, String) CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream, String) CreateFromStreamWithIndex(IRandomAccessStream, IRandomAccessStream, String)

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index streams and sets the default language.

public : static TimedTextSource CreateFromStreamWithIndex(IRandomAccessStream stream, IRandomAccessStream indexStream, PlatForm::String defaultLanguage)public static TimedTextSource CreateFromStreamWithIndex(IRandomAccessStream stream, IRandomAccessStream indexStream, String defaultLanguage)Public Static Function CreateFromStreamWithIndex(stream As IRandomAccessStream, indexStream As IRandomAccessStream, defaultLanguage As String) As TimedTextSource// You can use this method in JavaScript.
Parameters
stream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

A stream containing the image data for image-based subtitles.

indexStream
IRandomAccessStream IRandomAccessStream IRandomAccessStream IRandomAccessStream

A stream containing the index data for image-based subtitles.

defaultLanguage
PlatForm::String String String String

A string indicating the default language for the timed text source.

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

CreateFromUri(Uri) CreateFromUri(Uri) CreateFromUri(Uri) CreateFromUri(Uri)

Creates a new instance of TimedTextSource from the provided URI.

public : static TimedTextSource CreateFromUri(Uri uri)public static TimedTextSource CreateFromUri(Uri uri)Public Static Function CreateFromUri(uri As Uri) As TimedTextSource// You can use this method in JavaScript.
Parameters
uri
Uri Uri Uri Uri

The URI from which the timed text source is created.

Returns
See Also

CreateFromUri(Uri, String) CreateFromUri(Uri, String) CreateFromUri(Uri, String) CreateFromUri(Uri, String)

Creates a new instance of TimedTextSource with the specified default language from the provided URI.

public : static TimedTextSource CreateFromUri(Uri uri, PlatForm::String defaultLanguage)public static TimedTextSource CreateFromUri(Uri uri, String defaultLanguage)Public Static Function CreateFromUri(uri As Uri, defaultLanguage As String) As TimedTextSource// You can use this method in JavaScript.
Parameters
uri
Uri Uri Uri Uri

The URI from which the timed text source is created.

defaultLanguage
PlatForm::String String String String

A string specifying the default language for the timed text source.

Returns
See Also

CreateFromUriWithIndex(Uri, Uri) CreateFromUriWithIndex(Uri, Uri) CreateFromUriWithIndex(Uri, Uri) CreateFromUriWithIndex(Uri, Uri)

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index URIs.

public : static TimedTextSource CreateFromUriWithIndex(Uri uri, Uri indexUri)public static TimedTextSource CreateFromUriWithIndex(Uri uri, Uri indexUri)Public Static Function CreateFromUriWithIndex(uri As Uri, indexUri As Uri) As TimedTextSource// You can use this method in JavaScript.
Parameters
uri
Uri Uri Uri Uri

The URI of the image data from which the timed text source is created.

indexUri
Uri Uri Uri Uri

The URI of the index data from which the timed text source is created.

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

CreateFromUriWithIndex(Uri, Uri, String) CreateFromUriWithIndex(Uri, Uri, String) CreateFromUriWithIndex(Uri, Uri, String) CreateFromUriWithIndex(Uri, Uri, String)

Creates a new instance of TimedTextSource that uses image-based subtitles from the provided image and index URIs and sets the default language.

public : static TimedTextSource CreateFromUriWithIndex(Uri uri, Uri indexUri, PlatForm::String defaultLanguage)public static TimedTextSource CreateFromUriWithIndex(Uri uri, Uri indexUri, String defaultLanguage)Public Static Function CreateFromUriWithIndex(uri As Uri, indexUri As Uri, defaultLanguage As String) As TimedTextSource// You can use this method in JavaScript.
Parameters
uri
Uri Uri Uri Uri

The URI of the image data from which the timed text source is created.

indexUri
Uri Uri Uri Uri

The URI of the index data from which the timed text source is created.

defaultLanguage
PlatForm::String String String String

A string indicating the default language for the timed text source.

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

Events

Resolved Resolved Resolved Resolved

Occurs when the TimedTextSource is resolved.

public : event TypedEventHandler Resolved<TimedTextSource,  TimedTextSourceResolveResultEventArgs>public event TypedEventHandler Resolved<TimedTextSource,  TimedTextSourceResolveResultEventArgs>Public Event Resolved<TimedTextSource,  TimedTextSourceResolveResultEventArgs>// You can use this event in JavaScript.

See Also