SubtitleData Class

Definition

[Android.Runtime.Register("android/media/SubtitleData", ApiSince=28, DoNotGenerateAcw=true)]
public sealed class SubtitleData : Java.Lang.Object

[<Android.Runtime.Register("android/media/SubtitleData", ApiSince=28, DoNotGenerateAcw=true)>]
type SubtitleData = class
    inherit Object

Inheritance

Object

Object

SubtitleData

Attributes

RegisterAttribute

Remarks

Class encapsulating subtitle data, as received through the MediaPlayer.OnSubtitleDataListener interface. The subtitle data includes: <ul> <li> the track index</li> <li> the start time (in microseconds) of the data</li> <li> the duration (in microseconds) of the data</li> <li> the actual data.</li> </ul> The data is stored in a byte-array, and is encoded in one of the supported in-band subtitle formats. The subtitle encoding is determined by the MIME type of the MediaPlayer.TrackInfo of the subtitle track, one of MediaFormat#MIMETYPE_TEXT_CEA_608, MediaFormat#MIMETYPE_TEXT_CEA_708, MediaFormat#MIMETYPE_TEXT_VTT.

Here is an example of iterating over the tracks of a MediaPlayer, and checking which encoding is used for the subtitle tracks:

MediaPlayer mp = new MediaPlayer();
            mp.setDataSource(myContentLocation);
            mp.prepare(); // synchronous prepare, ready to use when method returns
            final TrackInfo[] trackInfos = mp.getTrackInfo();
            for (TrackInfo info : trackInfo) {
                if (info.getTrackType() == TrackInfo.MEDIA_TRACK_TYPE_SUBTITLE) {
                    final String mime = info.getFormat().getString(MediaFormat.KEY_MIME);
                    if (MediaFormat.MIMETYPE_TEXT_CEA_608.equals(mime) {
                        // subtitle encoding is CEA 608
                    } else if (MediaFormat.MIMETYPE_TEXT_CEA_708.equals(mime) {
                        // subtitle encoding is CEA 708
                    } else if (MediaFormat.MIMETYPE_TEXT_VTT.equals(mime) {
                        // subtitle encoding is WebVTT
                    }
                }
            }

See MediaPlayer#setOnSubtitleDataListener(android.media.MediaPlayer.OnSubtitleDataListener, android.os.Handler) to receive subtitle data from a MediaPlayer object.

Java documentation for android.media.SubtitleData.

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Constructors

Properties

Methods

Explicit Interface Implementations

Extension Methods

Applies to