Contents

ContentProtectionKeyRequest

A request for an item’s content protection key.

Declaration

object ContentProtectionKeyRequest

Properties

NameTypeDescription
assetIdentifierstring

The item’s content key asset identifier.

context RequiredPlayerContext

The content the client is playing.

keyRequest Requiredbyte

An encrypted key request that contains session, authentication, and integrity information. For FairPlay Streaming, this is the server playback context (SPC); for more information, see FairPlay Streaming Overview.

keySystem RequiredContentProtectionKeySystem

The content’s encryption type, which must match the configuration in ExtensionConfig.Media.Queues.ContentProtectionKey.Cks.

userActivity RequiredUserActivity

A description of the client’s current playback queue.

version Requiredstring

The version of the client’s SiriKitMediaAPI library.

Discussion

If your service implements content protection, the client requests an item’s content protection key after each of the following events:

  • The client receives the queue’s initial item.

  • The client preloads each subsequent item in the queue.

  • The user manually transitions to an item in the queue.

For more information on providing your service’s content protection configuration, see ExtensionConfig.Media.Queues.ContentProtectionKey and Retrieve an Asset’s Content Protection Key.

See Also

Content Protection