Codec

abstract class Codec : MediaCodec.Callback, Running

Base class for asynchronous Android media encoding and decoding.

Inheritors

AudioCodec

VideoCodec

Constructors

Codec

constructor()

Types

Companion

object Companion

Listener

interface Listener

Receives input, format, and output callbacks from the codec.

Setting

open class Setting(codec: Codec?)

Common codec configuration forwarded to the associated codec.

Properties

codec

open var codec: MediaCodec?

The android.media.MediaCodec instance.

inputMimeType

abstract var inputMimeType: String

Specifies the input mime type.

isRunning

open override val isRunning: AtomicBoolean

Indicates whether the receiver is running.

listener

var listener: Codec.Listener?

The listener for codec buffer and format callbacks, or null.

mode

var mode: Int

The processing mode: MODE_ENCODE or MODE_DECODE. Set before starting the codec.

options

var options: List<CodecOption>

Additional media format options applied during configure.

outputMimeType

abstract var outputMimeType: String

Specifies the output mime type.

surface

@set:Synchronized

var surface: Surface?

The surface for a video media codec.

Functions

configure

open fun configure(codec: MediaCodec)

Installs callbacks and configures the codec with its media format, options, surface, and processing mode.

dispose

@Synchronized

open fun dispose()

Releases the Android codec, callback thread, and cached output format.

onCryptoError

open fun onCryptoError(codec: MediaCodec, e: MediaCodec.CryptoException)

onError

open override fun onError(codec: MediaCodec, e: MediaCodec.CodecException)

onInputBufferAvailable

open override fun onInputBufferAvailable(codec: MediaCodec, index: Int)

onMetricsFlushed

open fun onMetricsFlushed(codec: MediaCodec, metrics: PersistableBundle)

onOutputBufferAvailable

@Synchronized

open override fun onOutputBufferAvailable(codec: MediaCodec, index: Int, info: MediaCodec.BufferInfo)

onOutputBuffersAvailable

open fun onOutputBuffersAvailable(codec: MediaCodec, index: Int, infos: ArrayDeque<MediaCodec.BufferInfo?>)

onOutputFormatChanged

@Synchronized

open override fun onOutputFormatChanged(codec: MediaCodec, format: MediaFormat)

startRunning

@Synchronized

override fun startRunning()

Tells the receiver to start running.

stopRunning

@Synchronized

override fun stopRunning()

Tells the receiver to stop running.

withCurrentCodec

fun withCurrentCodec(instance: MediaCodec, operation: () -> Unit): Boolean

Runs a short, nonblocking operation only while instance is the running codec. Use after waiting for input outside the codec's lifetime lock.