Added in API level 26

MediaDescrambler

class MediaDescrambler : AutoCloseable
kotlin.Any
   ↳ android.media.MediaDescrambler

MediaDescrambler class can be used in conjunction with android.media.MediaCodec and android.media.MediaExtractor to decode media data scrambled by conditional access (CA) systems such as those in the ISO/IEC13818-1. A MediaDescrambler object is initialized from a session opened by a MediaCas object, and can be used to descramble media streams scrambled with that session's keys. Scrambling schemes are identified by 16-bit unsigned integer as in CA_system_id.

Summary

Constants
static Byte

Scramble control value indicating that the even key is used.
static Byte

Scramble control value indicating that the odd key is used.
static Byte

Scramble control value reserved and shouldn't be used currently.
static Byte

Scramble control value indicating that the samples are not scrambled.
static Byte

Scramble flag for a hint indicating that the descrambling request is for retrieving the PES header info only.
Public constructors
MediaDescrambler(CA_system_id: Int)

Instantiate a MediaDescrambler.
Public methods
Unit

Int
descramble(srcBuf: ByteBuffer, dstBuf: ByteBuffer, cryptoInfo: MediaCodec.CryptoInfo)

Descramble a ByteBuffer of data described by a android.media.MediaCodec.CryptoInfo structure.
Boolean

Query if the scrambling scheme requires the use of a secure decoder to decode data of the given mime type.
Unit

Associate a MediaCas session with this MediaDescrambler instance.
Protected methods
Unit

Constants

SCRAMBLE_CONTROL_EVEN_KEY

Added in API level 28
static val SCRAMBLE_CONTROL_EVEN_KEY: Byte

Scramble control value indicating that the even key is used.

Value: 2

SCRAMBLE_CONTROL_ODD_KEY

Added in API level 28
static val SCRAMBLE_CONTROL_ODD_KEY: Byte

Scramble control value indicating that the odd key is used.

Value: 3

SCRAMBLE_CONTROL_RESERVED

Added in API level 28
static val SCRAMBLE_CONTROL_RESERVED: Byte

Scramble control value reserved and shouldn't be used currently.

Value: 1

SCRAMBLE_CONTROL_UNSCRAMBLED

Added in API level 28
static val SCRAMBLE_CONTROL_UNSCRAMBLED: Byte

Scramble control value indicating that the samples are not scrambled.

Value: 0

SCRAMBLE_FLAG_PES_HEADER

Added in API level 28
static val SCRAMBLE_FLAG_PES_HEADER: Byte

Scramble flag for a hint indicating that the descrambling request is for retrieving the PES header info only.

Value: 1

Public constructors

MediaDescrambler

Added in API level 26
MediaDescrambler(CA_system_id: Int)

Instantiate a MediaDescrambler.

Parameters
CA_system_id Int: The system id of the scrambling scheme.
Exceptions
android.media.MediaCasException.UnsupportedCasException if the scrambling scheme is not supported.

Public methods

close

Added in API level 26
fun close(): Unit
Exceptions
java.lang.Exception if this resource cannot be closed

descramble

Added in API level 26
fun descramble(
    srcBuf: ByteBuffer, 
    dstBuf: ByteBuffer, 
    cryptoInfo: MediaCodec.CryptoInfo
): Int

Descramble a ByteBuffer of data described by a android.media.MediaCodec.CryptoInfo structure.

Parameters
srcBuf ByteBuffer: ByteBuffer containing the scrambled data, which starts at srcBuf.position(). This value cannot be null.
dstBuf ByteBuffer: ByteBuffer to hold the descrambled data, which starts at dstBuf.position(). This value cannot be null.
cryptoInfo MediaCodec.CryptoInfo: a android.media.MediaCodec.CryptoInfo structure describing the subsamples contained in srcBuf. The iv and mode fields in CryptoInfo are not used. key[0] contains the MPEG2TS scrambling control bits (as defined in ETSI TS 100 289 (2011): "Digital Video Broadcasting (DVB); Support for use of the DVB Scrambling Algorithm version 3 within digital broadcasting systems"), and the value must be one of SCRAMBLE_CONTROL_UNSCRAMBLED, SCRAMBLE_CONTROL_RESERVED, SCRAMBLE_CONTROL_EVEN_KEY or SCRAMBLE_CONTROL_ODD_KEY. key[1] is a set of bit flags, with the only possible bit being SCRAMBLE_FLAG_PES_HEADER currently. key[2~15] are not used. This value cannot be null.
Return
Int number of bytes that have been successfully descrambled, with negative values indicating errors.
Exceptions
java.lang.IllegalStateException if the descrambler instance is not valid.
android.media.MediaCasStateException for CAS-specific state exceptions.

requiresSecureDecoderComponent

Added in API level 26
fun requiresSecureDecoderComponent(mime: String): Boolean

Query if the scrambling scheme requires the use of a secure decoder to decode data of the given mime type.

Parameters
mime String: The mime type of the media data This value cannot be null.
Exceptions
java.lang.IllegalStateException if the descrambler instance is not valid.

setMediaCasSession

Added in API level 26
fun setMediaCasSession(session: MediaCas.Session): Unit

Associate a MediaCas session with this MediaDescrambler instance. The MediaCas session is used to securely load decryption keys for the descrambler. The crypto keys loaded through the MediaCas session may be selected for use during the descrambling operation performed by or @link by specifying even or odd key in the android.media.MediaCodec.CryptoInfo#key field.

Parameters
session MediaCas.Session: the MediaCas session to associate with this MediaDescrambler instance. This value cannot be null.
Exceptions
java.lang.IllegalStateException if the descrambler instance is not valid.
android.media.MediaCasStateException for CAS-specific state exceptions.

Protected methods

finalize

Added in API level 26
protected fun finalize(): Unit
Exceptions
java.lang.Throwable the Exception raised by this method