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

# MediaDrm.KeyRequest

*** ** * ** ***

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

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

<br />

*** ** * ** ***

Contains the opaque data an app uses to request keys from a license server. These request types may or may not be generated by a given plugin. Refer to plugin vendor documentation for more information.

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_INITIAL` Key request type is initial license request. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_NONE` Keys are already loaded and are available for use. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_RELEASE` Key request type is license release |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_RENEWAL` Key request type is license renewal. |
| `int` | `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_UPDATE` Keys have been loaded but an additional license request is needed to update their values. |

| ### Public methods ||
|---|---|
| ` byte[]` | ` https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#getData()() ` Get the opaque message data |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#getDefaultUrl()() ` Get the default URL to use when sending the key request message to a server, if known. |
| ` int` | ` https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#getRequestType()() ` Get the type of the request |

### 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

### REQUEST_TYPE_INITIAL

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

```
public static final int REQUEST_TYPE_INITIAL
```

Key request type is initial license request. A license request is necessary to load keys.

<br />

Constant Value: 0 (0x00000000)

### REQUEST_TYPE_NONE

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

```
public static final int REQUEST_TYPE_NONE
```

Keys are already loaded and are available for use. No license request is necessary, and no key request data is returned.

<br />

Constant Value: 3 (0x00000003)

### REQUEST_TYPE_RELEASE

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

```
public static final int REQUEST_TYPE_RELEASE
```

Key request type is license release

<br />

Constant Value: 2 (0x00000002)

### REQUEST_TYPE_RENEWAL

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

```
public static final int REQUEST_TYPE_RENEWAL
```

Key request type is license renewal. A license request is necessary to prevent the keys from expiring.

<br />

Constant Value: 1 (0x00000001)

### REQUEST_TYPE_UPDATE

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

```
public static final int REQUEST_TYPE_UPDATE
```

Keys have been loaded but an additional license request is needed to update their values.

<br />

Constant Value: 4 (0x00000004)

## Public methods

### getData

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

```
public byte[] getData ()
```

Get the opaque message data

<br />

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

### getDefaultUrl

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

```
public String getDefaultUrl ()
```

Get the default URL to use when sending the key request message to a server, if known. The app may prefer to use a different license server URL from other sources. This method returns an empty string if the default URL is not known.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

### getRequestType

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

```
public int getRequestType ()
```

Get the type of the request

<br />

| Returns ||
|---|---|
| `int` | Value is one of the following: - `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_INITIAL` - `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_RENEWAL` - `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_RELEASE` - `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_NONE` - `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest#REQUEST_TYPE_UPDATE` |