SubtitleData Class

Reference

Definition

Namespace:: Android.Media

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Class encapsulating subtitle data, as received through the MediaPlayer.OnSubtitleDataListener interface.

[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

SubtitleData(Int32, Int64, Int64, Byte[])

Constructor.

Properties

Class	Returns the runtime class of this `Object`. (Inherited from Object)
DurationUs	Returns the duration in microsecond during which the subtitle should be displayed.
Handle	The handle to the underlying Android instance. (Inherited from Object)
JniIdentityHashCode	(Inherited from Object)
JniPeerMembers
PeerReference	(Inherited from Object)
StartTimeUs	Returns the media time at which the subtitle should be displayed, expressed in microseconds.
ThresholdClass	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
ThresholdType	This API supports the Mono for Android infrastructure and is not intended to be used directly from your code. (Inherited from Object)
TrackIndex	Returns the index of the media player track which contains this subtitle data.

Methods

Clone()	Creates and returns a copy of this object. (Inherited from Object)
Dispose()	(Inherited from Object)
Dispose(Boolean)	(Inherited from Object)
Equals(Object)	Indicates whether some other object is "equal to" this one. (Inherited from Object)
GetData()	Returns the encoded data for the subtitle content.
GetHashCode()	Returns a hash code value for the object. (Inherited from Object)
JavaFinalize()	Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. (Inherited from Object)
Notify()	Wakes up a single thread that is waiting on this object's monitor. (Inherited from Object)
NotifyAll()	Wakes up all threads that are waiting on this object's monitor. (Inherited from Object)
SetHandle(IntPtr, JniHandleOwnership)	Sets the Handle property. (Inherited from Object)
ToArray<T>()	(Inherited from Object)
ToString()	Returns a string representation of the object. (Inherited from Object)
UnregisterFromRuntime()	(Inherited from Object)
Wait()	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>. (Inherited from Object)
Wait(Int64)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)
Wait(Int64, Int32)	Causes the current thread to wait until it is awakened, typically by being <em>notified</em> or <em>interrupted</em>, or until a certain amount of real time has elapsed. (Inherited from Object)

Explicit Interface Implementations

IJavaPeerable.Disposed()	(Inherited from Object)
IJavaPeerable.DisposeUnlessReferenced()	(Inherited from Object)
IJavaPeerable.Finalized()	(Inherited from Object)
IJavaPeerable.JniManagedPeerState	(Inherited from Object)
IJavaPeerable.SetJniIdentityHashCode(Int32)	(Inherited from Object)
IJavaPeerable.SetJniManagedPeerState(JniManagedPeerStates)	(Inherited from Object)
IJavaPeerable.SetPeerReference(JniObjectReference)	(Inherited from Object)

Extension Methods

JavaCast<TResult>(IJavaObject)	Performs an Android runtime-checked type conversion.
JavaCast<TResult>(IJavaObject)
GetJniTypeName(IJavaPeerable)

Applies to