MediaItem.DrmConfiguration

Artifact: androidx.media3:media3-common

View Source

---

Kotlin |Java

public final class MediaItem.DrmConfiguration

---

DRM configuration for a media item.

Summary

Nested types
public final class MediaItem.DrmConfiguration.Builder Builder for DrmConfiguration.

Public fields
final boolean	forceDefaultLicenseUri Whether to force use of licenseUri even if the media specifies its own DRM license server URI.
final ImmutableList<@C.TrackType Integer>	forcedSessionTrackTypes The types of tracks for which to always use a DRM session even if the content is unencrypted.
final @Nullable byte[]	keySetId
final ImmutableMap<String, String>	licenseRequestHeaders The headers to attach to requests sent to the DRM license server.
final @Nullable Uri	licenseUri Optional default DRM license server Uri.
final boolean	multiSession Whether the DRM configuration is multi session enabled.
final boolean	playClearContentWithoutKey Whether clear samples within protected content should be played when keys for the encrypted part of the content have yet to be loaded.
final ImmutableMap<String, String>	@UnstableApi requestHeaders This field is deprecated. Use licenseRequestHeaders instead.
final UUID	scheme The UUID of the protection scheme.
final ImmutableList<@C.TrackType Integer>	@UnstableApi sessionForClearTypes This field is deprecated. Use forcedSessionTrackTypes.
final UUID	@UnstableApi uuid This field is deprecated. Use scheme instead.

Public methods
MediaItem.DrmConfiguration.Builder	buildUpon() Returns a Builder initialized with the values of this instance.
boolean	equals(@Nullable Object obj)
static MediaItem.DrmConfiguration	@UnstableApi fromBundle(Bundle bundle) Restores a DrmConfiguration from a Bundle.
@Nullable byte[]	getKeySetId() Returns the key set ID of the offline license.
int	hashCode()
Bundle	@UnstableApi toBundle()

Public fields

forceDefaultLicenseUri

public final boolean forceDefaultLicenseUri

Whether to force use of licenseUri even if the media specifies its own DRM license server URI.

forcedSessionTrackTypes

public final ImmutableList<@C.TrackType Integer> forcedSessionTrackTypes

The types of tracks for which to always use a DRM session even if the content is unencrypted.

keySetId

public final @Nullable byte[] keySetId

licenseRequestHeaders

public final ImmutableMap<String, String> licenseRequestHeaders

The headers to attach to requests sent to the DRM license server.

licenseUri

public final @Nullable Uri licenseUri

Optional default DRM license server Uri. If null then the DRM license server must be specified by the media.

multiSession

public final boolean multiSession

Whether the DRM configuration is multi session enabled.

playClearContentWithoutKey

public final boolean playClearContentWithoutKey

Whether clear samples within protected content should be played when keys for the encrypted part of the content have yet to be loaded.

requestHeaders

@UnstableApi
public final ImmutableMap<String, String> requestHeaders

This field is deprecated.

Use licenseRequestHeaders instead.

scheme

public final UUID scheme

The UUID of the protection scheme.

sessionForClearTypes

@UnstableApi
public final ImmutableList<@C.TrackType Integer> sessionForClearTypes

This field is deprecated.

Use forcedSessionTrackTypes.

uuid

@UnstableApi
public final UUID uuid

This field is deprecated.

Use scheme instead.

Public methods

buildUpon

public MediaItem.DrmConfiguration.Builder buildUpon()

Returns a Builder initialized with the values of this instance.

equals

public boolean equals(@Nullable Object obj)

fromBundle

@UnstableApi
public static MediaItem.DrmConfiguration fromBundle(Bundle bundle)

Restores a DrmConfiguration from a Bundle.

getKeySetId

public @Nullable byte[] getKeySetId()

Returns the key set ID of the offline license.

hashCode

public int hashCode()

toBundle

@UnstableApi
public Bundle toBundle()