openharmony/interface_sdk_c
1
0
Fork 0
mirror of https://gitee.com/openharmony/interface_sdk_c synced 2024-11-23 23:00:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

!1048 【Drm】修改错误码描述

Browse Source 
Merge pull request !1048 from 姜春丽/master
This commit is contained in:
openharmony_ci 2024-07-27 09:31:12 +00:00 committed by Gitee
commit 9cb0e65063
No known key found for this signature in database
GPG Key ID: 173E9B9CA92EEF8F
2 changed files with 108 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
multimedia/drm_framework/native_mediakeysession.h
View File

@ -133,7 +133,10 @@ typedef struct OH_MediaKeySession_Callback {
* @param mediaKeySession Media key session instance.
* @param info Media key request info.
* @param mediaKeyRequest Media key request.
* @return Drm_ErrCode.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -147,7 +150,10 @@ Drm_ErrCode OH_MediaKeySession_GenerateMediaKeyRequest(MediaKeySession *mediaKey
* @param responseLen Media Key resposne len.
* @param offlineMediaKeyId Offline media key identifier.
* @param offlineMediaKeyIdLen Offline media key identifier len for in buffer and out data.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -158,7 +164,10 @@ Drm_ErrCode OH_MediaKeySession_ProcessMediaKeyResponse(MediaKeySession *mediaKey
* @brief Check media key status.
* @param mediaKeySession Media key session instance.
* @param mediaKeyStatus Media key status.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -168,7 +177,9 @@ Drm_ErrCode OH_MediaKeySession_CheckMediaKeyStatus(MediaKeySession *mediaKeySess
/**
* @brief Clear media keys of the current session .
* @param mediaKeySession Media key session instance.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -181,7 +192,10 @@ Drm_ErrCode OH_MediaKeySession_ClearMediaKeys(MediaKeySession *mediaKeySessoin);
* @param offlineMediaKeyIdLen Offline media key identifier len.
* @param releaseRequest Media Key release request.
* @param releaseRequestLen Media Key release request len for in buffer and out data.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -196,7 +210,9 @@ Drm_ErrCode OH_MediaKeySession_GenerateOfflineReleaseRequest(MediaKeySession *me
* @param offlineMediaKeyIdLen Offline media key identifier len.
* @param releaseReponse Media Key resposne.
* @param releaseReponseLen Media Key resposne len.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -209,7 +225,9 @@ Drm_ErrCode OH_MediaKeySession_ProcessOfflineReleaseResponse(MediaKeySession *me
* @param mediaKeySession Media key session instance.
* @param offlineMediaKeyId Offline media key identifier.
* @param offlineMediaKeyIdLen Offline media key identifier len.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -220,7 +238,9 @@ Drm_ErrCode OH_MediaKeySession_RestoreOfflineMediaKeys(MediaKeySession *mediaKey
* @brief Get content protection level of the session.
* @param mediaKeySession Media key session instance.
* @param contentProtectionLevel Content protection level.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -232,7 +252,9 @@ Drm_ErrCode OH_MediaKeySession_GetContentProtectionLevel(MediaKeySession *mediaK
* @param mediaKeySession Media key session instance.
* @param mimeType The media type.
* @param status Whether secure decoder is required.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -243,7 +265,8 @@ Drm_ErrCode OH_MediaKeySession_RequireSecureDecoderModule(MediaKeySession *media
* @brief Set media key session event callback.
* @param mediaKeySession Media key session instance.
* @param callback Callback to be set to the media key session.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
* @since 11
* @version 1.0
*/
@ -254,7 +277,8 @@ Drm_ErrCode OH_MediaKeySession_SetMediaKeySessionCallback(MediaKeySession *media
* @brief Set media key session event callback.
* @param mediaKeySession Media key session instance.
* @param callback Callback to be set to the media key session.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
* @since 12
* @version 1.0
*/
@ -264,7 +288,9 @@ Drm_ErrCode OH_MediaKeySession_SetCallback(MediaKeySession *mediaKeySessoin,
/**
* @brief Release the resource before the session gonna be unused.
* @param mediaKeySession Media key session instance.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/

87
multimedia/drm_framework/native_mediakeysystem.h
View File

@ -80,7 +80,9 @@ typedef Drm_ErrCode (*OH_MediaKeySystem_Callback)(MediaKeySystem *mediaKeySystem
* @brief Set media key system event callback.
* @param mediaKeySystem Media key system instance.
* @param callback Callback to be set to the media key system.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - If the mediaKeySystem instance is nullptr or invalid,
* or the mediaKeySession is nullptr or invalid.
* @since 12
* @version 1.0
*/
@ -90,7 +92,11 @@ Drm_ErrCode OH_MediaKeySystem_SetCallback(MediaKeySystem *mediaKeySystem, OH_Med
* @brief Acquire supported media key systems' name and uuid.
* @param descs Array used to save media key systems' name and uuid.
* @param count Used to indicate count of struct DRM_MediaKeySystemDescription.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - Probably caused by:
* 1.the description or the count is nullptr.
* 2. the size of the description array is smaller than the actual number obtained.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 12
* @version 1.0
*/
@ -131,6 +137,13 @@ bool OH_MediaKeySystem_IsSupported3(const char *name, const char *mimeType,
* @param mediaKeySystem Media key system instance.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully,
* return DRM_ERR_MAX_SYSTEM_NUM_REACHED when max num media key system reached.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - Probably caused by:
* 1. the name is nullptr or the length of name is zero.
* 2. the mediaKeySystem is nullptr.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
 *         {@link DRM_ERR_SERVICE_DIED} 24700507 - Service died.
 *         {@link DRM_ERR_MAX_SYSTEM_NUM_REACHED} 24700510 - The maximum number of media key systems is reached.
* @since 11
* @version 1.0
*/
@ -140,7 +153,8 @@ Drm_ErrCode OH_MediaKeySystem_Create(const char *name, MediaKeySystem **mediaKey
* @param mediaKeySystem Media key system instance.
* @param configName Configuration name string.
* @param value Configuration vaule string to be set.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
* @since 11
* @version 1.0
*/
@ -152,7 +166,10 @@ Drm_ErrCode OH_MediaKeySystem_SetConfigurationString(MediaKeySystem *mediaKeySys
* @param configName Configuration name string.
* @param value Configuration vaule string to be get.
* @param valueLen Configuration vaule string len for in buffer.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -164,7 +181,10 @@ Drm_ErrCode OH_MediaKeySystem_GetConfigurationString(MediaKeySystem *mediaKeySys
* @param configName Configuration name string.
* @param value Configuration vaule in byte array to be set.
* @param valueLen Value array len.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -176,7 +196,10 @@ Drm_ErrCode OH_MediaKeySystem_SetConfigurationByteArray(MediaKeySystem *mediaKey
* @param configName Configuration name string.
* @param value Configuration vaule in byte array to be get.
* @param valueLen Configuration vaule len for in buffer and out data.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -186,7 +209,10 @@ Drm_ErrCode OH_MediaKeySystem_GetConfigurationByteArray(MediaKeySystem *mediaKey
* @brief Get media key system statistics info.
* @param mediaKeySystem Media key system instance.
* @param statistics Statistic info gotten.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -195,7 +221,9 @@ Drm_ErrCode OH_MediaKeySystem_GetStatistics(MediaKeySystem *mediaKeySystem, DRM_
* @brief Get the max content protection level media key system supported.
* @param mediaKeySystem Media key system instance.
* @param contentProtectionLevel Content protection level.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -205,7 +233,8 @@ Drm_ErrCode OH_MediaKeySystem_GetMaxContentProtectionLevel(MediaKeySystem *media
* @brief Set media key system event callback.
* @param mediaKeySystem Media key system instance.
* @param callback Callback to be set to the media key system.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
* @since 11
* @version 1.0
*/
@ -217,8 +246,14 @@ Drm_ErrCode OH_MediaKeySystem_SetMediaKeySystemCallback(MediaKeySystem *mediaKey
* @param mediaKeySystem Media key system instance which will create the media key session.
* @param level Specifies the content protection level.
* @param mediaKeySession Media key session instance.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully,
* return DRM_ERR_MAX_SESSION_NUM_REACHED when max num media key system reached.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - Probably caused by:
* 1. The parameter passed in is a null pointer or invalid.
* 2. the level is beyond reasonable range.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
 *         {@link DRM_ERR_SERVICE_DIED} 24700507 - Service died.
 *         {@link DRM_ERR_MAX_SESSION_NUM_REACHED} 24700511 - The maximum number of media key sessions is reached.
* @since 11
* @version 1.0
*/
@ -232,7 +267,10 @@ Drm_ErrCode OH_MediaKeySystem_CreateMediaKeySession(MediaKeySystem *mediaKeySyst
* @param requestLen Provision request data len for in buffer and out data.
* @param defaultUrl Provision server URL.
* @param defaultUrlLen Provision server URL len for in buffer.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -244,7 +282,9 @@ Drm_ErrCode OH_MediaKeySystem_GenerateKeySystemRequest(MediaKeySystem *mediaKeyS
* @param mediaKeySystem Media key system instance.
* @param response The provision reponse will be processed.
* @param responseLen The response len.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -255,7 +295,10 @@ Drm_ErrCode OH_MediaKeySystem_ProcessKeySystemResponse(MediaKeySystem *mediaKeyS
* @brief Get offline media key ids .
* @param mediaKeySystem Media key system instance.
* @param offlineMediaKeyIds Media key ids of all offline media keys.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
*         {@link DRM_ERR_NO_MEMORY} 24700501 - Memory errors.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -268,7 +311,9 @@ Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyIds(MediaKeySystem *mediaKeySyst
* @param offlineMediaKeyId Offline media key identifier.
* @param offlineMediaKeyIdLen Offline media key identifier len.
* @param status The media key status gotten.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -280,7 +325,9 @@ Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyStatus(MediaKeySystem *mediaKeyS
* @param mediaKeySystem Media key system instance.
* @param offlineMediaKeyId Offline media key identifier.
* @param offlineMediaKeyIdLen Offline media key identifier len.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -291,7 +338,9 @@ Drm_ErrCode OH_MediaKeySystem_ClearOfflineMediaKeys(MediaKeySystem *mediaKeySyst
* @brief Get certificate status of media key system.
* @param mediaKeySystem Media key system instance.
* @param certStatus Status will be gotten.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/
@ -301,7 +350,9 @@ Drm_ErrCode OH_MediaKeySystem_GetCertificateStatus(MediaKeySystem *mediaKeySyste
/**
* @brief Destroy a media key system instance.
* @param mediaKeySystem Secifies which media key system instance will be destroyed.
* @return DRM_ERR_INVALID_VAL when the params checked failure, return DRM_ERR_OK when function called successfully.
* @return {@link DRM_ERR_OK} 0 - Success.
 *         {@link DRM_ERR_INVALID_VAL} 24700503 - The parameter passed in is a null pointer or invalid.
 *         {@link DRM_ERR_UNKNOWN} 24700506 - Internal error occurred, it is recommended to check the logs.
* @since 11
* @version 1.0
*/