harmony 鸿蒙native_mediakeysession.h

2025-06-12
浏览 (4)

native_mediakeysession.h

Overview

The native_mediakeysession.h file declares the MediaKeySession API. The APIs can be used to generate media key requests, process responses to media key requests, listen for events, obtain content protection levels, check media key status, and delete media keys.

Library: libnative_drm.so

File to include: <multimedia/drm_framework/native_mediakeysession.h>

System capability: SystemCapability.Multimedia.Drm.Core

Since: 11

Related module: Drm

Summary

Structs

Name	Description
struct MediaKeySession_Callback	Describes the callback used to listen for events such as media key expiry or change, without returning media key session instances. It applies to the scenario where a single media key session needs to be decrypted.
struct OH_MediaKeySession_Callback	Describes the callback used to listen for events such as media key expiry or change, with media key session instances returned. It applies to the scenario where multiple media key sessions need to be decrypted.

Types

Name	Description
typedef Drm_ErrCode(* MediaKeySession_EventCallback) (DRM_EventType eventType, uint8_t info, int32_t infoLen, char extra)	Defines the callback that is invoked when a media key session event is triggered.
typedef Drm_ErrCode(* MediaKeySession_KeyChangeCallback) (DRM_KeysInfo *keysInfo, bool newKeysAvailable)	Defines the callback that is invoked when the key is changed.
typedef struct MediaKeySession_Callback MediaKeySession_Callback	Defines the callback used to listen for events such as media key expiry or change, without returning media key session instances. It applies to the scenario where a single media key session needs to be decrypted.
typedef Drm_ErrCode(* OH_MediaKeySession_EventCallback) (MediaKeySession mediaKeySession, DRM_EventType eventType, uint8_t info, int32_t infoLen, char *extra)	Defines the callback that is invoked when a DRM event is triggered.
typedef Drm_ErrCode(* OH_MediaKeySession_KeyChangeCallback) (MediaKeySession mediaKeySession, DRM_KeysInfo keysInfo, bool newKeysAvailable)	Defines the callback that is invoked when the key is changed.
typedef struct OH_MediaKeySession_Callback OH_MediaKeySession_Callback	Defines the callback used to listen for events such as media key expiry or change, with media key session instances returned. It applies to the scenario where multiple media key sessions need to be decrypted.

Functions

Name	Description
Drm_ErrCode OH_MediaKeySession_GenerateMediaKeyRequest (MediaKeySession mediaKeySession, DRM_MediaKeyRequestInfo info, DRM_MediaKeyRequest *mediaKeyRequest)	Generates a media key request.
Drm_ErrCode OH_MediaKeySession_ProcessMediaKeyResponse (MediaKeySession mediaKeySession, uint8_t response, int32_t responseLen, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen)	Processes a response to the media key request.
Drm_ErrCode OH_MediaKeySession_CheckMediaKeyStatus (MediaKeySession mediaKeySession, DRM_MediaKeyStatus mediaKeyStatus)	Checks the status of media keys.
Drm_ErrCode OH_MediaKeySession_ClearMediaKeys (MediaKeySession *mediaKeySession)	Clears media keys.
Drm_ErrCode OH_MediaKeySession_GenerateOfflineReleaseRequest (MediaKeySession mediaKeySession, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t releaseRequest, int32_t releaseRequestLen)	Generates a request to release offline media keys.
Drm_ErrCode OH_MediaKeySession_ProcessOfflineReleaseResponse (MediaKeySession mediaKeySession, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen, uint8_t *releaseReponse, int32_t releaseReponseLen)	Processes a response to a request for releasing offline media keys.
Drm_ErrCode OH_MediaKeySession_RestoreOfflineMediaKeys (MediaKeySession mediaKeySession, uint8_t offlineMediaKeyId, int32_t offlineMediaKeyIdLen)	Restores offline media keys.
Drm_ErrCode OH_MediaKeySession_GetContentProtectionLevel (MediaKeySession mediaKeySession, DRM_ContentProtectionLevel contentProtectionLevel)	Obtains the content protection level of a media key session.
Drm_ErrCode OH_MediaKeySession_RequireSecureDecoderModule (MediaKeySession mediaKeySession, const char mimeType, bool *status)	Checks whether secure decoding is required.
Drm_ErrCode OH_MediaKeySession_SetMediaKeySessionCallback (MediaKeySession mediaKeySession, MediaKeySession_Callback callback)	Sets a media key session event callback.
Drm_ErrCode OH_MediaKeySession_SetCallback (MediaKeySession mediaKeySession, OH_MediaKeySession_Callback callback)	Sets a media key session event callback.
Drm_ErrCode OH_MediaKeySession_Destroy (MediaKeySession *mediaKeySession)	Destroys a MediaKeySession instance.