# ExoMediaDrm.KeyRequest

Artifact: [androidx.media3:media3-exoplayer](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/exoplayer/drm/ExoMediaDrm.java+class:androidx.media3.exoplayer.drm.ExoMediaDrm.KeyRequest)

*** ** * ** ***


```
public final class ExoMediaDrm.KeyRequest
```

<br />

*** ** * ** ***

Contains data used to request keys from a license server.

| See also |
|---|---|
| `https://developer.android.com/reference/android/media/MediaDrm.KeyRequest.html` |   |

## Summary

| ### Nested types |
|---|
| `@https://developer.android.com/reference/java/lang/annotation/Documented.html @https://developer.android.com/reference/java/lang/annotation/Retention.html(value = https://developer.android.com/reference/java/lang/annotation/RetentionPolicy.html#SOURCE) @https://developer.android.com/reference/java/lang/annotation/Target.html(value = https://developer.android.com/reference/java/lang/annotation/ElementType.html#TYPE_USE) @https://developer.android.com/reference/androidx/annotation/IntDef(value = ) public annotation https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest.RequestType` Key request types. |

| ### Constants |
|---|---|
| `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_INITIAL() = 0` Key request type for an initial license request. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_NONE() = 3` Key request type if keys are already loaded and available for use. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_RELEASE() = 2` Key request type for license release. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_RENEWAL() = 1` Key request type for license renewal. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UNKNOWN() = -2147483648` Value returned from `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#getRequestType()` if the underlying key request does not specify a type. |
| `static final int` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UPDATE() = 4` Key request type if keys have been loaded, but an additional license request is needed to update their values. |

| ### Public fields |
|---|---|
| `final byte[]` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#data()` |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#licenseServerUrl()` |
| `final int` | `@https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest.RequestType https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#requestType()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#KeyRequest(byte[],java.lang.String)(byte[] data, https://developer.android.com/reference/java/lang/String.html licenseServerUrl)` Creates an instance with `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UNKNOWN()`. |
| `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#KeyRequest(byte[],java.lang.String,int)( byte[] data, https://developer.android.com/reference/java/lang/String.html licenseServerUrl, @https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest.RequestType int requestType )` Creates an instance. |

| ### Public methods |
|---|---|
| `byte[]` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#getData()()` Returns the opaque key request data. |
| `https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#getLicenseServerUrl()()` Returns the URL of the license server to which the request should be made. |
| `int` | `@https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest.RequestType https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#getRequestType()()` Returns the type of the request, or `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UNKNOWN()` if the underlying key request does not specify a type. |

## Constants

### REQUEST_TYPE_INITIAL

```
public static final int REQUEST_TYPE_INITIAL = 0
```

Key request type for an initial license request.

### REQUEST_TYPE_NONE

```
public static final int REQUEST_TYPE_NONE = 3
```

Key request type if keys are already loaded and available for use. No license request is necessary, and no key request data is returned.

### REQUEST_TYPE_RELEASE

```
public static final int REQUEST_TYPE_RELEASE = 2
```

Key request type for license release.

### REQUEST_TYPE_RENEWAL

```
public static final int REQUEST_TYPE_RENEWAL = 1
```

Key request type for license renewal.

### REQUEST_TYPE_UNKNOWN

```
public static final int REQUEST_TYPE_UNKNOWN = -2147483648
```

Value returned from `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#getRequestType()` if the underlying key request does not specify a type.

### REQUEST_TYPE_UPDATE

```
public static final int REQUEST_TYPE_UPDATE = 4
```

Key request type if keys have been loaded, but an additional license request is needed to update their values.

## Public fields

### data

```
public final byte[] data
```

### licenseServerUrl

```
public final String licenseServerUrl
```

### requestType

```
@ExoMediaDrm.KeyRequest.RequestType
public final int requestType
```

## Public constructors

### KeyRequest

```
public KeyRequest(byte[] data, String licenseServerUrl)
```

Creates an instance with `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UNKNOWN()`.

| Parameters |
|---|---|
| `byte[] data` | The opaque key request data. |
| `https://developer.android.com/reference/java/lang/String.html licenseServerUrl` | The license server URL to which the request should be made. |

### KeyRequest

```
public KeyRequest(
    byte[] data,
    String licenseServerUrl,
    @ExoMediaDrm.KeyRequest.RequestType int requestType
)
```

Creates an instance.

| Parameters |
|---|---|
| `byte[] data` | The opaque key request data. |
| `https://developer.android.com/reference/java/lang/String.html licenseServerUrl` | The license server URL to which the request should be made. |
| `@https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest.RequestType int requestType` | The type of the request, or `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UNKNOWN()`. |

## Public methods

### getData

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

Returns the opaque key request data.

### getLicenseServerUrl

```
public String getLicenseServerUrl()
```

Returns the URL of the license server to which the request should be made.

### getRequestType

```
@ExoMediaDrm.KeyRequest.RequestType
public int getRequestType()
```

Returns the type of the request, or `https://developer.android.com/reference/androidx/media3/exoplayer/drm/ExoMediaDrm.KeyRequest#REQUEST_TYPE_UNKNOWN()` if the underlying key request does not specify a type.