MediaDataSource | API reference | Android Developers (original) (raw)

abstract class MediaDataSource : Closeable

For supplying media data to the framework. Implement this if your app has special requirements for the way media data is obtained.

Methods of this interface may be called on multiple different threads. There will be a thread synchronization point between each call to ensure that modifications to the state of your MediaDataSource are visible to future calls. This means you don't need to do your own synchronization unless you're modifying the MediaDataSource from another thread while it's being used by the framework.

Summary

Public constructors
MediaDataSource()

Public methods
abstract Long	getSize() Called to get the size of the data source.
abstract Int	readAt(position: Long, buffer: ByteArray!, offset: Int, size: Int) Called to request data from the given position.

Inherited functions
From class Closeable Unit close() Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in AutoCloseable.close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Inherited functions

From class Closeable Unit close() Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in AutoCloseable.close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Public constructors

MediaDataSource

MediaDataSource()

Public methods

getSize

abstract fun getSize(): Long

Called to get the size of the data source.

Return
Long	the size of data source in bytes, or -1 if the size is unknown.

Exceptions
java.io.IOException	on fatal errors

readAt

abstract fun readAt(
    position: Long,
    buffer: ByteArray!,
    offset: Int,
    size: Int
): Int

Called to request data from the given position. Implementations should fill buffer with up to size bytes of data, and return the number of valid bytes in the buffer. Return 0 if size is zero (thus no bytes are read). Return -1 to indicate that end of stream is reached.

Parameters
position	Long: the position in the data source to read from.
buffer	ByteArray!: the buffer to read the data into.
offset	Int: the offset within buffer to read the data into.
size	Int: the number of bytes to read.

Return
Int	the number of bytes read, or -1 if end of stream is reached.

Exceptions
java.io.IOException	on fatal errors.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2025-02-10 UTC.