Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Constants](https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#constants) \| [Methods](https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#inhmethods)

# MediaDrm.KeyStatus

*** ** * ** ***

` public static final class MediaDrm.KeyStatus `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.media.MediaDrm.KeyStatus |

<br />

*** ** * ** ***

Defines the status of a key. A KeyStatus for each key in a session is provided to the `https://developer.android.com/reference/android/media/MediaDrm.OnKeyStatusChangeListener#onKeyStatusChange(android.media.MediaDrm,%20byte[],%20java.util.List<android.media.MediaDrm.KeyStatus>,%20boolean)` listener.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_EXPIRED` The key is no longer usable to decrypt media data because its expiration time has passed. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_INTERNAL_ERROR` The key is not currently usable to decrypt media data because of an internal error in processing unrelated to input parameters. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_OUTPUT_NOT_ALLOWED` The key is not currently usable to decrypt media data because its output requirements cannot currently be met. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_PENDING` The status of the key is not yet known and is being determined. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_USABLE` The key is currently usable to decrypt media data |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_USABLE_IN_FUTURE` The key is not yet usable to decrypt media because the start time is in the future. |

| ### Public methods ||
|---|---|
| ` byte[]` | ` https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#getKeyId()() ` Returns the id for the key |
| ` int` | ` https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#getStatusCode()() ` Returns the status code for the key |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Constants

### STATUS_EXPIRED

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_EXPIRED
```

The key is no longer usable to decrypt media data because its expiration time has passed.

<br />

Constant Value: 1 (0x00000001)

### STATUS_INTERNAL_ERROR

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_INTERNAL_ERROR
```

The key is not currently usable to decrypt media data because of an internal error in processing unrelated to input parameters. This error is not actionable by an app.

<br />

Constant Value: 4 (0x00000004)

### STATUS_OUTPUT_NOT_ALLOWED

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_OUTPUT_NOT_ALLOWED
```

The key is not currently usable to decrypt media data because its output requirements cannot currently be met.

<br />

Constant Value: 2 (0x00000002)

### STATUS_PENDING

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_PENDING
```

The status of the key is not yet known and is being determined. The status will be updated with the actual status when it has been determined.

<br />

Constant Value: 3 (0x00000003)

### STATUS_USABLE

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_USABLE
```

The key is currently usable to decrypt media data

<br />

Constant Value: 0 (0x00000000)

### STATUS_USABLE_IN_FUTURE

Added in [API level 29](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int STATUS_USABLE_IN_FUTURE
```

The key is not yet usable to decrypt media because the start time is in the future. The key will become usable when its start time is reached.

<br />

Constant Value: 5 (0x00000005)

## Public methods

### getKeyId

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public byte[] getKeyId ()
```

Returns the id for the key

<br />

| Returns ||
|---|---|
| `byte[]` | This value cannot be `null`. <br /> |

### getStatusCode

Added in [API level 23](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getStatusCode ()
```

Returns the status code for the key

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_USABLE` - `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_EXPIRED` - `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_OUTPUT_NOT_ALLOWED` - `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_PENDING` - `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_INTERNAL_ERROR` - `https://developer.android.com/reference/android/media/MediaDrm.KeyStatus#STATUS_USABLE_IN_FUTURE` |