diff --git a/zh-cn/native_sdk/multimedia/av_session/native_avmetadata.h b/zh-cn/native_sdk/multimedia/av_session/native_avmetadata.h index 8ad9c8716f4d3fb59d958bcb22c933350d69e5bd..a458db7ca9705da89da1b7933d10e83a235fa088 100644 --- a/zh-cn/native_sdk/multimedia/av_session/native_avmetadata.h +++ b/zh-cn/native_sdk/multimedia/av_session/native_avmetadata.h @@ -128,10 +128,9 @@ typedef struct OH_AVMetadataStruct OH_AVMetadata; * @brief 创建一个元数据构造器。 * * @param builder 该引用指向创建的构造器的结果。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM} 参数builder为nullptr。 - * {@link AVMETADATA_ERROR_NO_MEMORY} 没有内存来分配新实例。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：参数builder为nullptr。\n + * AVMETADATA_ERROR_NO_MEMORY：没有内存来分配新实例。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_Create(OH_AVMetadataBuilder** builder); @@ -140,9 +139,8 @@ AVMetadata_Result OH_AVMetadataBuilder_Create(OH_AVMetadataBuilder** builder); * @brief 销毁元数据构造器。 * * @param builder 指向元数据构造器的实例。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM} 参数builder为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：参数builder为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_Destroy(OH_AVMetadataBuilder* builder); @@ -152,11 +150,10 @@ AVMetadata_Result OH_AVMetadataBuilder_Destroy(OH_AVMetadataBuilder* builder); * * @param builder 指向元数据构造器的实例。 * @param assetId 资源id。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1.参数builder为nullptr。 - * 2.参数assetId为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1.参数builder为nullptr。\n + * 2.参数assetId为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetAssetId(OH_AVMetadataBuilder* builder, const char* assetId); @@ -166,11 +163,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetAssetId(OH_AVMetadataBuilder* builder, * * @param builder 指向元数据构造器的实例。 * @param title 标题。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}： - * 1. 参数builder为nullptr。 - * 2. 参数title为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数title为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetTitle(OH_AVMetadataBuilder* builder, const char* title); @@ -180,11 +176,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetTitle(OH_AVMetadataBuilder* builder, c * * @param builder 指向元数据构造器的实例。 * @param artist 艺术家。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}： - * 1. 参数builder为nullptr。 - * 2. 参数artist为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数artist为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetArtist(OH_AVMetadataBuilder* builder, const char* artist); @@ -194,11 +189,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetArtist(OH_AVMetadataBuilder* builder, * * @param builder 指向元数据构造器的实例。 * @param author 作者。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}： - * 1. 参数builder为nullptr。 - * 2. 参数author为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数author为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetAuthor(OH_AVMetadataBuilder* builder, const char* author); @@ -208,11 +202,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetAuthor(OH_AVMetadataBuilder* builder, * * @param builder 指向元数据构造器的实例。 * @param album 专辑名。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1. 参数builder为nullptr。 - * 2. 参数album为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数album为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetAlbum(OH_AVMetadataBuilder* builder, const char* album); @@ -222,11 +215,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetAlbum(OH_AVMetadataBuilder* builder, c * * @param builder 指向元数据构造器的实例。 * @param writer 词作者。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1. 参数builder为nullptr。 - * 2. 参数writer为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数writer为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetWriter(OH_AVMetadataBuilder* builder, const char* writer); @@ -236,11 +228,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetWriter(OH_AVMetadataBuilder* builder, * * @param builder 指向元数据构造器的实例。 * @param composer 作曲者。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1. 参数builder为nullptr。 - * 2. 参数composer为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数composer为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetComposer(OH_AVMetadataBuilder* builder, const char* composer); @@ -250,9 +241,8 @@ AVMetadata_Result OH_AVMetadataBuilder_SetComposer(OH_AVMetadataBuilder* builder * * @param builder 指向元数据构造器的实例。 * @param duration 资源播放时长，以ms为单位。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM} 参数builder为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：参数builder为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetDuration(OH_AVMetadataBuilder* builder, int64_t duration); @@ -262,11 +252,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetDuration(OH_AVMetadataBuilder* builder * * @param builder 指向元数据构造器的实例。 * @param mediaImageUri 网络资源图片数据地址。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1.参数builder为nullptr。 - * 2.参数mediaImageUri为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数mediaImageUri为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetMediaImageUri(OH_AVMetadataBuilder* builder, const char* mediaImageUri); @@ -276,11 +265,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetMediaImageUri(OH_AVMetadataBuilder* bu * * @param builder 指向元数据构造器的实例。 * @param subtitle The subtitle of resource. - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1.参数builder为nullptr。 - * 2.参数subtitle为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数subtitle为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetSubtitle(OH_AVMetadataBuilder* builder, const char* subtitle); @@ -290,11 +278,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetSubtitle(OH_AVMetadataBuilder* builder * * @param builder 指向元数据构造器的实例。 * @param description 媒体描述信息。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1.参数builder为nullptr。 - * 2.参数description为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数description为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetDescription(OH_AVMetadataBuilder* builder, const char* description); @@ -304,11 +291,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetDescription(OH_AVMetadataBuilder* buil * * @param builder 指向元数据构造器的实例。 * @param lyric lrc格式的歌词内容。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}： - * 1.参数builder为nullptr。 - * 2.参数lyric为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数lyric为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetLyric(OH_AVMetadataBuilder* builder, const char* lyric); @@ -318,11 +304,10 @@ AVMetadata_Result OH_AVMetadataBuilder_SetLyric(OH_AVMetadataBuilder* builder, c * * @param builder 指向元数据构造器的实例。 * @param intervals 跳转的时间间隔。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}: - * 1.参数builder为nullptr。 - * 2.参数intervals为无效。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数intervals为无效。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetSkipIntervals(OH_AVMetadataBuilder* builder, @@ -333,9 +318,8 @@ AVMetadata_Result OH_AVMetadataBuilder_SetSkipIntervals(OH_AVMetadataBuilder* bu * * @param builder 指向元数据构造器的实例。 * @param tags 用于显示在播控的媒体资源的金标类型。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM} 参数builder为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：参数builder为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_SetDisplayTags(OH_AVMetadataBuilder* builder, int32_t tags); @@ -345,12 +329,11 @@ AVMetadata_Result OH_AVMetadataBuilder_SetDisplayTags(OH_AVMetadataBuilder* buil * * @param builder 指向元数据构造器的实例。 * @param avMetadata 指向元数据的指针对象。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_NO_MEMORY}：内存不足。 - * {@link AVMETADATA_ERROR_INVALID_PARAM}： - * 1.参数builder为nullptr。 - * 2.参数avMetadata为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_NO_MEMORY：内存不足。\n + * AVMETADATA_ERROR_INVALID_PARAM：\n + * 1. 参数builder为nullptr。\n + * 2. 参数avMetadata为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadataBuilder_GenerateAVMetadata(OH_AVMetadataBuilder* builder, @@ -360,9 +343,8 @@ AVMetadata_Result OH_AVMetadataBuilder_GenerateAVMetadata(OH_AVMetadataBuilder* * @brief 释放媒体元数据对象。 * * @param avMetadata 指向元数据的指针对象。 - * @return 函数返回值： - * {@link AVMETADATA_SUCCESS} 函数执行成功。 - * {@link AVMETADATA_ERROR_INVALID_PARAM} 参数avMetadata为nullptr。 + * @return AVMETADATA_SUCCESS：函数执行成功。\n + * AVMETADATA_ERROR_INVALID_PARAM：参数avMetadata为nullptr。 * @since 13 */ AVMetadata_Result OH_AVMetadata_Destroy(OH_AVMetadata* avMetadata); diff --git a/zh-cn/native_sdk/multimedia/av_session/native_avsession.h b/zh-cn/native_sdk/multimedia/av_session/native_avsession.h index 304e953895a7d03fe9587aaaa79215ffcb9b9d6c..f22e5fb939ffd65b27c0d0fd9bf68aebf6ad1320 100644 --- a/zh-cn/native_sdk/multimedia/av_session/native_avsession.h +++ b/zh-cn/native_sdk/multimedia/av_session/native_avsession.h @@ -326,14 +326,13 @@ typedef struct OH_AVSession OH_AVSession; * @param bundleName 创建会话的包名。 * @param abilityName 创建会话的ability名。 * @param avsession 返回的媒体会话对象。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数sessionType无效。 - * 2.参数sessionTag为nullptr。 - * 3.参数bundleName为nullptr。 - * 4.参数abilityName为nullptr。 - * 5.参数avsession为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数sessionType无效。\n + * 2.参数sessionTag为nullptr。\n + * 3.参数bundleName为nullptr。\n + * 4.参数abilityName为nullptr。\n + * 5.参数avsession为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_Create(AVSession_Type sessionType, const char* sessionTag, @@ -343,9 +342,8 @@ AVSession_ErrCode OH_AVSession_Create(AVSession_Type sessionType, const char* se * @brief 销毁会话对象。 * * @param avsession 媒体会话对象。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER} 参数avsession为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_INVALID_PARAMETER：参数avsession为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_Destroy(OH_AVSession* avsession); @@ -354,10 +352,9 @@ AVSession_ErrCode OH_AVSession_Destroy(OH_AVSession* avsession); * @brief 激活会话。 * * @param avsession 媒体会话对象。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER} 参数avsession为nullptr。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_INVALID_PARAMETER：参数avsession为nullptr。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。 * @since 13 */ AVSession_ErrCode OH_AVSession_Activate(OH_AVSession* avsession); @@ -366,10 +363,9 @@ AVSession_ErrCode OH_AVSession_Activate(OH_AVSession* avsession); * @brief 取消激活媒体会话。 * * @param avsession 媒体会话对象。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER} 参数avsession为nullptr。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_INVALID_PARAMETER：参数avsession为nullptr。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。 * @since 13 */ AVSession_ErrCode OH_AVSession_Deactivate(OH_AVSession* avsession); @@ -379,12 +375,11 @@ AVSession_ErrCode OH_AVSession_Deactivate(OH_AVSession* avsession); * * @param avsession 媒体会话对象。 * @param sessionType 返回的会话类型。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常，获取session type错误。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数sessionType为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常，获取session type错误。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数sessionType为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_GetSessionType(OH_AVSession* avsession, AVSession_Type* sessionType); @@ -394,11 +389,10 @@ AVSession_ErrCode OH_AVSession_GetSessionType(OH_AVSession* avsession, AVSession * * @param avsession 媒体会话对象。 * @param sessionId 返回的会话类型id。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数sessionId为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数sessionId为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_GetSessionId(OH_AVSession* avsession, const char** sessionId); @@ -408,12 +402,11 @@ AVSession_ErrCode OH_AVSession_GetSessionId(OH_AVSession* avsession, const char* * * @param avsession 媒体会话对象。 * @param avmetadata 设置媒体元数据信息。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数avmetadata为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数avmetadata为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_SetAVMetadata(OH_AVSession* avsession, OH_AVMetadata* avmetadata); @@ -423,12 +416,11 @@ AVSession_ErrCode OH_AVSession_SetAVMetadata(OH_AVSession* avsession, OH_AVMetad * * @param avsession 媒体会话对象。 * @param playbackState 播放状态。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数playbackState无效。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数playbackState无效。 * @since 13 */ AVSession_ErrCode OH_AVSession_SetPlaybackState(OH_AVSession* avsession, @@ -439,12 +431,11 @@ AVSession_ErrCode OH_AVSession_SetPlaybackState(OH_AVSession* avsession, * * @param avsession 媒体会话对象。 * @param playbackPosition 播放位置对象。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数playbackPosition为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数playbackPosition为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_SetPlaybackPosition(OH_AVSession* avsession, @@ -455,10 +446,9 @@ AVSession_ErrCode OH_AVSession_SetPlaybackPosition(OH_AVSession* avsession, * * @param avsession 媒体会话对象。 * @param favorite 收藏状态，true表示收藏，false表示取消收藏。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: 参数avsession为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：参数avsession为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_SetFavorite(OH_AVSession* avsession, bool favorite); @@ -468,12 +458,11 @@ AVSession_ErrCode OH_AVSession_SetFavorite(OH_AVSession* avsession, bool favorit * * @param avsession 媒体会话对象。 * @param loopMode 循环模式。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数loopMode无效。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数loopMode无效。 * @since 13 */ AVSession_ErrCode OH_AVSession_SetLoopMode(OH_AVSession* avsession, AVSession_LoopMode loopMode); @@ -483,15 +472,14 @@ AVSession_ErrCode OH_AVSession_SetLoopMode(OH_AVSession* avsession, AVSession_Lo * * @param avsession 媒体会话对象。 * @param command 播控的控制命令。 - * @param callback 控制命令的回调{@link OH_AVSessionCallback_OnCommand}。 + * @param callback 控制命令的回调。 * @param userData 指向通过回调函数传递的应用数据指针。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_CODE_COMMAND_INVALID} 控制命令无效。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_CODE_COMMAND_INVALID：控制命令无效。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_RegisterCommandCallback(OH_AVSession* avsession, @@ -502,14 +490,13 @@ AVSession_ErrCode OH_AVSession_RegisterCommandCallback(OH_AVSession* avsession, * * @param avsession 媒体会话对象。 * @param command 播控的控制命令。 - * @param callback 控制命令的回调{@link OH_AVSessionCallback_OnCommand}。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_CODE_COMMAND_INVALID} 控制命令无效。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @param callback 控制命令的回调。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_CODE_COMMAND_INVALID：控制命令无效。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_UnregisterCommandCallback(OH_AVSession* avsession, @@ -519,14 +506,13 @@ AVSession_ErrCode OH_AVSession_UnregisterCommandCallback(OH_AVSession* avsession * @brief 注册快进的回调。 * * @param avsession 媒体会话对象。 - * @param callback 快进命令的回调{@link OH_AVSessionCallback_OnFastForward}。 + * @param callback 快进命令的回调。 * @param userData 指向通过回调函数传递的应用数据指针。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_RegisterForwardCallback(OH_AVSession* avsession, @@ -536,13 +522,12 @@ AVSession_ErrCode OH_AVSession_RegisterForwardCallback(OH_AVSession* avsession, * @brief 取消注册快进的回调。 * * @param avsession 媒体会话对象。 - * @param callback 快进命令的回调{@link OH_AVSessionCallback_OnFastForward}。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @param callback 快进命令的回调。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_UnregisterForwardCallback(OH_AVSession* avsession, @@ -552,14 +537,13 @@ AVSession_ErrCode OH_AVSession_UnregisterForwardCallback(OH_AVSession* avsession * @brief 注册快退的回调。 * * @param avsession 媒体会话对象。 - * @param callback 快退命令的回调{@link OH_AVSessionCallback_OnRewind}。 + * @param callback 快退命令的回调。 * @param userData 指向通过回调函数传递的应用数据指针。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_RegisterRewindCallback(OH_AVSession* avsession, @@ -569,13 +553,12 @@ AVSession_ErrCode OH_AVSession_RegisterRewindCallback(OH_AVSession* avsession, * @brief 取消注册快退的回调。 * * @param avsession 媒体会话对象。 - * @param callback 快退命令的回调{@link OH_AVSessionCallback_OnRewind}。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @param callback 快退命令的回调。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_UnregisterRewindCallback(OH_AVSession* avsession, @@ -585,14 +568,13 @@ AVSession_ErrCode OH_AVSession_UnregisterRewindCallback(OH_AVSession* avsession, * @brief 注册跳转的回调。 * * @param avsession 媒体会话对象。 - * @param callback 跳转命令的回调{@link OH_AVSessionCallback_OnSeek}。 + * @param callback 跳转命令的回调。 * @param userData 指向通过回调函数传递的应用数据指针。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_RegisterSeekCallback(OH_AVSession* avsession, @@ -602,13 +584,12 @@ AVSession_ErrCode OH_AVSession_RegisterSeekCallback(OH_AVSession* avsession, * @brief 取消注册跳转的回调。 * * @param avsession 媒体会话对象。 - * @param callback 跳转命令的回调{@link OH_AVSessionCallback_OnSeek}。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @param callback 跳转命令的回调。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_UnregisterSeekCallback(OH_AVSession* avsession, @@ -618,14 +599,13 @@ AVSession_ErrCode OH_AVSession_UnregisterSeekCallback(OH_AVSession* avsession, * @brief 注册设置循环模式的回调。 * * @param avsession 媒体会话对象。 - * @param callback 设置循环模式命令的回调{@link OH_AVSessionCallback_OnSetLoopMode}。 + * @param callback 设置循环模式命令的回调。 * @param userData 指向通过回调函数传递的应用数据指针。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_RegisterSetLoopModeCallback(OH_AVSession* avsession, @@ -635,13 +615,12 @@ AVSession_ErrCode OH_AVSession_RegisterSetLoopModeCallback(OH_AVSession* avsessi * @brief 取消注册设置循环模式的回调。 * * @param avsession 媒体会话对象。 - * @param callback 设置循环模式命令的回调{@link OH_AVSessionCallback_OnSetLoopMode}。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @param callback 设置循环模式命令的回调。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_UnregisterSetLoopModeCallback(OH_AVSession* avsession, @@ -651,14 +630,13 @@ AVSession_ErrCode OH_AVSession_UnregisterSetLoopModeCallback(OH_AVSession* avses * @brief 设置收藏的回调。 * * @param avsession 媒体会话对象。 - * @param callback 设置收藏命令的回调{@link OH_AVSessionCallback_OnToggleFavorite}。 + * @param callback 设置收藏命令的回调。 * @param userData 指向通过回调函数传递的应用数据指针。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_RegisterToggleFavoriteCallback(OH_AVSession* avsession, @@ -668,13 +646,12 @@ AVSession_ErrCode OH_AVSession_RegisterToggleFavoriteCallback(OH_AVSession* avse * @brief 取消设置收藏的回调。 * * @param avsession 媒体会话对象。 - * @param callback 设置收藏命令的回调{@link OH_AVSessionCallback_OnToggleFavorite}。 - * @return 函数返回值： - * {@link AV_SESSION_ERR_SUCCESS} 函数执行成功。 - * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} 会话服务异常。 - * {@link AV_SESSION_ERR_INVALID_PARAMETER}: - * 1.参数avsession为nullptr。 - * 2.参数callback为nullptr。 + * @param callback 设置收藏命令的回调。 + * @return AV_SESSION_ERR_SUCCESS：函数执行成功。\n + * AV_SESSION_ERR_SERVICE_EXCEPTION：会话服务异常。\n + * AV_SESSION_ERR_INVALID_PARAMETER：\n + * 1.参数avsession为nullptr。\n + * 2.参数callback为nullptr。 * @since 13 */ AVSession_ErrCode OH_AVSession_UnregisterToggleFavoriteCallback(OH_AVSession* avsession, diff --git a/zh-cn/native_sdk/multimedia/drm_framework/common/native_drm_common.h b/zh-cn/native_sdk/multimedia/drm_framework/common/native_drm_common.h index 9ac2e597f2974021d3a86c74b4daf7ea8e37a460..3b07c25aec6656ff782a091f7affd9a3a243ff3d 100644 --- a/zh-cn/native_sdk/multimedia/drm_framework/common/native_drm_common.h +++ b/zh-cn/native_sdk/multimedia/drm_framework/common/native_drm_common.h @@ -18,7 +18,7 @@ * @{ * * @brief 提供数字版权保护能力的API。 - * @kit Drm. + * @kit DrmKit * @since 11 * @version 1.0 */ @@ -27,7 +27,7 @@ * @file native_drm_common.h * @include * - * @brief 定义DRM数据类型 + * @brief 定义DRM数据类型。 * @library libnative_drm.z.so * @syscap SystemCapability.Multimedia.Drm.Core * @since 11 @@ -51,27 +51,27 @@ extern "C" { */ typedef enum DRM_EventType { /** - * DRM基础事件 + * DRM基础事件。 */ EVENT_DRM_BASE = 200, /** - * 设备证书请求事件 + * 设备证书请求事件。 */ EVENT_PROVISION_REQUIRED = 201, /** - * 密钥请求事件 + * 密钥请求事件。 */ EVENT_KEY_REQUIRED = 202, /** - * 密钥过期事件 + * 密钥过期事件。 */ EVENT_KEY_EXPIRED = 203, /** - * 第三方定义事件 + * 第三方定义事件。 */ EVENT_VENDOR_DEFINED = 204, /** - * 密钥过期更新事件 + * 密钥过期更新事件。 */ EVENT_EXPIRATION_UPDATE = 206, } DRM_EventType; @@ -130,27 +130,27 @@ typedef enum DRM_MediaKeyType { */ typedef enum DRM_MediaKeyRequestType { /** - * 未知请求类型 + * 未知请求类型。 */ MEDIA_KEY_REQUEST_TYPE_UNKNOWN = 0, /** - * 初始化请求 + * 初始化请求。 */ MEDIA_KEY_REQUEST_TYPE_INITIAL, /** - * 续订请求 + * 续订请求。 */ MEDIA_KEY_REQUEST_TYPE_RENEWAL, /** - * 释放请求 + * 释放请求。 */ MEDIA_KEY_REQUEST_TYPE_RELEASE, /** - * 无请求 + * 无请求。 */ MEDIA_KEY_REQUEST_TYPE_NONE, /** - * 更新请求 + * 更新请求。 */ MEDIA_KEY_REQUEST_TYPE_UPDATE, } DRM_MediaKeyRequestType; @@ -163,15 +163,15 @@ typedef enum DRM_MediaKeyRequestType { */ typedef enum DRM_OfflineMediaKeyStatus { /** - * 未知状态 + * 未知状态。 */ OFFLINE_MEDIA_KEY_STATUS_UNKNOWN = 0, /** - * 可用状态 + * 可用状态。 */ OFFLINE_MEDIA_KEY_STATUS_USABLE, /** - * 失活状态 + * 失活状态。 */ OFFLINE_MEDIA_KEY_STATUS_INACTIVE, } DRM_OfflineMediaKeyStatus; @@ -184,23 +184,23 @@ typedef enum DRM_OfflineMediaKeyStatus { */ typedef enum DRM_CertificateStatus { /** - * 设备已安装设备证书 + * 设备已安装设备证书。 */ CERT_STATUS_PROVISIONED = 0, /** - * 设备未安装设备证书 + * 设备未安装设备证书。 */ CERT_STATUS_NOT_PROVISIONED, /** - * 设备证书过期 + * 设备证书过期。 */ CERT_STATUS_EXPIRED, /** - * 无效设备证书 + * 无效设备证书。 */ CERT_STATUS_INVALID, /** - * 设备证书不可用 + * 设备证书不可用。 */ CERT_STATUS_UNAVAILABLE, } DRM_CertificateStatus; @@ -243,7 +243,7 @@ typedef enum DRM_CertificateStatus { */ typedef struct DRM_MediaKeyRequestInfo { /** - * 密钥类型 + * 密钥类型。 */ DRM_MediaKeyType type; /** @@ -360,11 +360,11 @@ typedef struct DRM_Statistics { * @version 1.0 */ typedef struct DRM_OfflineMediakeyIdArray { - /* ID计数 */ + /* ID计数。 */ uint32_t idsCount; - /* ID长度集合 */ + /* ID长度集合。 */ int32_t idsLen[MAX_OFFLINE_MEDIA_KEY_ID_COUNT]; - /* ID数据集合 */ + /* ID数据集合。 */ uint8_t ids[MAX_OFFLINE_MEDIA_KEY_ID_COUNT][MAX_OFFLINE_MEDIA_KEY_ID_LEN]; } DRM_OfflineMediakeyIdArray; @@ -395,7 +395,7 @@ typedef struct DRM_OfflineMediakeyIdArray { typedef struct DRM_KeysInfo { /* 钥匙计数。 */ uint32_t keysInfoCount; - /* 密钥ID集合 */ + /* 密钥ID集合。 */ uint8_t keyId[MAX_KEY_INFO_COUNT][MAX_KEY_ID_LEN]; /* 关键状态值。 */ char statusValue[MAX_KEY_INFO_COUNT][MAX_KEY_STATUS_VALUE_LEN]; @@ -454,7 +454,7 @@ typedef struct DRM_MediaKeyStatus { */ typedef struct DRM_PsshInfo { /** - * Uuid. + * UUID。 */ uint8_t uuid[DRM_UUID_LEN]; /** diff --git a/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysession.h b/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysession.h index d0391b7c321008fdd461e512efd50228ca3d01a6..b0b40add0bf5194cd1fd3dd6bf512c17500a86b5 100644 --- a/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysession.h +++ b/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysession.h @@ -18,14 +18,14 @@ * @{ * * @brief 提供数字版权保护能力的API。 - * @kit DrmKit. + * @kit DrmKit * @since 11 * @version 1.0 */ /** * @file native_mediakeysession.h - * @brief 定义Drm MediaKeySession API。提供以下功能： + * @brief 定义Drm MediaKeySession API。提供以下功能：\n * 生成媒体密钥请求、处理媒体密钥响应、事件侦听、获取内容保护级别、 * 检查媒体密钥状态、删除媒体密钥等。 * @library libnative_drm.z.so @@ -54,7 +54,7 @@ extern "C" * @param info 从媒体密钥会话获取的事件信息。 * @param infoLen 事件信息长度。 * @param extra 从媒体密钥会话中获得的额外信息。 - * @return Drm_ErrCode 错误码。 + * @return 错误码。 * @since 11 * @version 1.0 */ @@ -93,7 +93,7 @@ typedef struct MediaKeySession_Callback { * @param info 从媒体密钥会话获取的事件信息。 * @param infoLen 事件信息长度。 * @param extra 从媒体密钥会话中获得的额外信息。 - * @return Drm_ErrCode 错误码。 + * @return 错误码。 * @since 12 */ typedef Drm_ErrCode (*OH_MediaKeySession_EventCallback)(MediaKeySession *mediaKeySession, DRM_EventType eventType, @@ -130,11 +130,10 @@ typedef struct OH_MediaKeySession_Callback { * @param mediaKeySession 媒体密钥会话实例。 * @param info 媒体密钥请求信息。 * @param mediaKeyRequest 媒体密钥请求。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或输入参数info为空指针，或输入参数mediaKeyRequest为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或输入参数info为空指针，或输入参数mediaKeyRequest为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -148,11 +147,10 @@ Drm_ErrCode OH_MediaKeySession_GenerateMediaKeyRequest(MediaKeySession *mediaKey * @param responseLen 媒体密钥响应长度。 * @param offlineMediaKeyId 离线媒体密钥标识符。 * @param offlineMediaKeyIdLen 缓冲区内和缓冲区外数据的离线媒体密钥标识符的长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -163,11 +161,10 @@ Drm_ErrCode OH_MediaKeySession_ProcessMediaKeyResponse(MediaKeySession *mediaKey * @brief 检查媒体密钥状态。 * @param mediaKeySession 媒体密钥会话实例。 * @param mediaKeyStatus 媒体密钥状态。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或输入参数mediaKeyStatus为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或输入参数mediaKeyStatus为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -177,10 +174,9 @@ Drm_ErrCode OH_MediaKeySession_CheckMediaKeyStatus(MediaKeySession *mediaKeySess /** * @brief 清除当前会话的媒体密钥。 * @param mediaKeySession 媒体密钥会话实例。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -191,11 +187,10 @@ Drm_ErrCode OH_MediaKeySession_ClearMediaKeys(MediaKeySession *mediaKeySession); * @param mediaKeySession 媒体密钥会话实例。 * @param offlineMediaKeyId 离线媒体密钥标识符。 * @param releaseRequestLen 离线媒体密钥标识符长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -210,10 +205,9 @@ Drm_ErrCode OH_MediaKeySession_GenerateOfflineReleaseRequest(MediaKeySession *me * @param offlineMediaKeyIdLen 离线媒体密钥标识符长度。 * @param releaseReponse 媒体密钥响应。 * @param releaseReponseLen 媒体密钥响应长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -226,10 +220,9 @@ Drm_ErrCode OH_MediaKeySession_ProcessOfflineReleaseResponse(MediaKeySession *me * @param mediaKeySession 媒体密钥会话实例。 * @param offlineMediaKeyId 离线媒体密钥标识符。 * @param offlineMediaKeyIdLen 离线媒体密钥标识符长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -240,10 +233,9 @@ Drm_ErrCode OH_MediaKeySession_RestoreOfflineMediaKeys(MediaKeySession *mediaKey * @brief 获取会话的内容保护级别。 * @param mediaKeySession 媒体密钥会话实例。 * @param contentProtectionLevel 内容保护级别。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或输入参数contentProtectionLevel为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或输入参数contentProtectionLevel为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -255,10 +247,9 @@ Drm_ErrCode OH_MediaKeySession_GetContentProtectionLevel(MediaKeySession *mediaK * @param mediaKeySession 媒体密钥会话实例。 * @param mimeType 媒体类型。 * @param status 是否需要安全解码。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -269,9 +260,8 @@ Drm_ErrCode OH_MediaKeySession_RequireSecureDecoderModule(MediaKeySession *media * @brief 设置媒体密钥会话事件回调。 * @param mediaKeySession 媒体密钥会话实例。 * @param callback 要设置为媒体密钥会话的回调。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或输入参数callback为空指针。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或输入参数callback为空指针。 * @since 11 * @version 1.0 */ @@ -282,9 +272,8 @@ Drm_ErrCode OH_MediaKeySession_SetMediaKeySessionCallback(MediaKeySession *media * @brief 设置媒体密钥会话事件回调。 * @param mediaKeySession 媒体密钥会话实例。 * @param callback 要设置为媒体密钥会话的回调。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效，或输入参数callback为空指针。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效，或输入参数callback为空指针。 * @since 12 */ Drm_ErrCode OH_MediaKeySession_SetCallback(MediaKeySession *mediaKeySession, @@ -293,10 +282,9 @@ Drm_ErrCode OH_MediaKeySession_SetCallback(MediaKeySession *mediaKeySession, /** * @brief 释放会话资源。 * @param mediaKeySession 媒体密钥会话实例。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySession为空指针或无效；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySession为空指针或无效。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ diff --git a/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysystem.h b/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysystem.h index 5243e9c241d6198dc028a3b29147f0bd78d3ccce..f066bc47a653749fd8654075bf6e1a0fc04362a4 100644 --- a/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysystem.h +++ b/zh-cn/native_sdk/multimedia/drm_framework/native_mediakeysystem.h @@ -18,17 +18,17 @@ * @{ * * @brief 提供Drm的API。 - * @kit Drm. + * @kit DrmKit * @since 11 * @version 1.0 */ /** * @file native_mediakeysystem.h - * @brief 定义Drm MediaKeySystem API。提供以下功能： - * 查询是否支持特定的drm，创建媒体密钥会话，获取和设置配置， - * 获取统计信息，获取内容保护级别，生成提供请求，处理提供响应， - * 事件监听，获取内容防护级别，管理离线媒体密钥等。 + * @brief 定义Drm MediaKeySystem API。提供以下功能：\n + * 查询是否支持特定的drm、创建媒体密钥会话、获取和设置配置、 + * 获取统计信息、获取内容保护级别、生成提供请求、处理提供响应、 + * 事件监听、获取内容防护级别、管理离线媒体密钥等。 * @library libnative_drm.z.so * @include * @syscap SystemCapability.Multimedia.Drm.Core @@ -55,9 +55,8 @@ extern "C" { * @param info 从媒体密钥系统获取的事件信息。 * @param infoLen 事件信息长度。 * @param extra 从媒体密钥系统获得的额外信息。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_INVALID_VAL}输入参数无效。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数无效。 * @since 11 * @version 1.0 */ @@ -71,9 +70,8 @@ typedef Drm_ErrCode (*MediaKeySystem_Callback)(DRM_EventType eventType, uint8_t * @param info 从媒体密钥系统获取的事件信息。 * @param infoLen 事件信息长度。 * @param extra 从媒体密钥系统获得的额外信息。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_INVALID_VAL}输入参数无效。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数无效。 * @since 12 */ typedef Drm_ErrCode (*OH_MediaKeySystem_Callback)(MediaKeySystem *mediaKeySystem, DRM_EventType eventType, @@ -83,9 +81,8 @@ typedef Drm_ErrCode (*OH_MediaKeySystem_Callback)(MediaKeySystem *mediaKeySystem * @brief 设置媒体密钥系统事件回调。 * @param mediaKeySystem 媒体密钥系统实例。 * @param callback 将回调设置为媒体密钥系统。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效。 * @since 12 */ Drm_ErrCode OH_MediaKeySystem_SetCallback(MediaKeySystem *mediaKeySystem, OH_MediaKeySystem_Callback callback); @@ -94,10 +91,11 @@ Drm_ErrCode OH_MediaKeySystem_SetCallback(MediaKeySystem *mediaKeySystem, OH_Med * @brief 获取支持的媒体密钥系统的名称和uuid。 * @param infos 用于保存媒体密钥系统的名称和uuid的数组。 * @param count 用于指示结构体DRM_MediaKeySystemMapInfo的计数。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_INVALID_VAL}可能原因：1.输入参数infos为空指针或输入参数count为空指针；2.输入参数infos长度不足；\n - * {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：可能原因：\n + * 1.输入参数infos为空指针或输入参数count为空指针。\n + * 2.输入参数infos长度不足。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 12 * @version 1.0 */ @@ -140,12 +138,13 @@ bool OH_MediaKeySystem_IsSupported3(const char *name, const char *mimeType, * @param mediaKeySystem 媒体密钥系统实例。 * @return 当参数检查失败时返回DRM_ERR_INVALID_VAL，当函数调用成功时返回DRM_ERR_OK， * 当达到媒体密钥系统的最大数量时，返回DRM_ERR_MAX_SYSTEM_NUM_REACHED。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_INVALID_VAL}可能原因：1.输入参数name为空指针或长度为0；2.输入参数mediaKeySystem为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息；\n - *         {@link DRM_ERR_SERVICE_DIED}服务死亡；\n - *         {@link DRM_ERR_MAX_SYSTEM_NUM_REACHED}已创建的MediaKeySystem数量达到最大限制(64个)。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：可能原因：\n + * 1.输入参数name为空指针或长度为0。\n + * 2.输入参数mediaKeySystem为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。\n + * DRM_ERR_SERVICE_DIED：服务死亡。\n + * DRM_ERR_MAX_SYSTEM_NUM_REACHED：已创建的MediaKeySystem数量达到最大限制(64个)。 * @since 11 * @version 1.0 */ @@ -156,9 +155,8 @@ Drm_ErrCode OH_MediaKeySystem_Create(const char *name, MediaKeySystem **mediaKey * @param mediaKeySystem 媒体密钥系统实例。 * @param configName 配置名称字符串。 * @param value 要设置的字符串的配置值。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，或输入参数value为空指针。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，或输入参数value为空指针。 * @since 11 * @version 1.0 */ @@ -171,11 +169,10 @@ Drm_ErrCode OH_MediaKeySystem_SetConfigurationString(MediaKeySystem *mediaKeySys * @param configName 字符串类型配置名。 * @param value 字符串形式配置值。 * @param valueLen 字符串形式配置值长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，或输入参数value为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，或输入参数value为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -188,11 +185,10 @@ Drm_ErrCode OH_MediaKeySystem_GetConfigurationString(MediaKeySystem *mediaKeySys * @param configName 字符数组类型配置名。 * @param value 字节数组形式配置值。 * @param valueLen 字节数组形式配置值长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，或输入参数value为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，或输入参数value为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -205,11 +201,10 @@ Drm_ErrCode OH_MediaKeySystem_SetConfigurationByteArray(MediaKeySystem *mediaKey * @param configName 字符数组类型配置名称。 * @param value 要获取数组中的配置值。 * @param valueLen 数据的配置值长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，输入参数value为空指针，或valueLen为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，输入参数configName为空指针，输入参数value为空指针，或valueLen为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -220,11 +215,10 @@ Drm_ErrCode OH_MediaKeySystem_GetConfigurationByteArray(MediaKeySystem *mediaKey * @brief 获取媒体密钥系统度量信息。 * @param mediaKeySystem 媒体密钥系统实例。 * @param statistics 已获取度量信息。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数statistics为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数statistics为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -234,10 +228,9 @@ Drm_ErrCode OH_MediaKeySystem_GetStatistics(MediaKeySystem *mediaKeySystem, DRM_ * @brief 获取支持的最高内容保护级别的媒体密钥系统。 * @param mediaKeySystem 媒体密钥系统实例。 * @param contentProtectionLevel 内容保护级别。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数contentProtectionLevel为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数contentProtectionLevel为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -248,9 +241,8 @@ Drm_ErrCode OH_MediaKeySystem_GetMaxContentProtectionLevel(MediaKeySystem *media * @brief 设置媒体密钥系统事件回调。 * @param mediaKeySystem 媒体密钥系统实例。 * @param callback 将回调设置为媒体密钥系统。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效。 * @since 11 * @version 1.0 */ @@ -262,13 +254,12 @@ Drm_ErrCode OH_MediaKeySystem_SetMediaKeySystemCallback(MediaKeySystem *mediaKey * @param mediaKeySystem 将创建媒体密钥会话的媒体密钥系统实例。 * @param level 指定内容保护级别。 * @param mediaKeySession 媒体密钥会话实例。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数level超出合理范围，或mediaKeySession为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息；\n - *         {@link DRM_ERR_SERVICE_DIED}服务死亡；\n - *         {@link DRM_ERR_MAX_SESSION_NUM_REACHED}当前MediaKeySystem已创建的MediaKeySession数量达到最大限制(64个)。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数level超出合理范围，或mediaKeySession为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。\n + * DRM_ERR_SERVICE_DIED：服务死亡。\n + * DRM_ERR_MAX_SESSION_NUM_REACHED：当前MediaKeySystem已创建的MediaKeySession数量达到最大限制(64个)。 * @since 11 * @version 1.0 */ @@ -282,11 +273,10 @@ Drm_ErrCode OH_MediaKeySystem_CreateMediaKeySession(MediaKeySystem *mediaKeySyst * @param requestLen 设备证书请求的长度。 * @param defaultUrl 设备证书服务器的网址。 * @param defaultUrlLen 设备证书服务器的网址长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -298,10 +288,9 @@ Drm_ErrCode OH_MediaKeySystem_GenerateKeySystemRequest(MediaKeySystem *mediaKeyS * @param mediaKeySystem 媒体密钥系统实例。 * @param response 将处理的响应。 * @param responseLen 响应长度. - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数response为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数response为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -312,11 +301,10 @@ Drm_ErrCode OH_MediaKeySystem_ProcessKeySystemResponse(MediaKeySystem *mediaKeyS * @brief 获取离线媒体密钥ID。 * @param mediaKeySystem 媒体密钥系统实例。 * @param offlineMediaKeyIds 所有离线媒体密钥的媒体密钥ID。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - * {@link DRM_ERR_NO_MEMORY}内存不足，内存分配失败；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数offlineMediaKeyIds为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_NO_MEMORY：内存不足，内存分配失败。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数offlineMediaKeyIds为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -329,10 +317,9 @@ Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyIds(MediaKeySystem *mediaKeySyst * @param offlineMediaKeyId 离线媒体密钥标识符。 * @param offlineMediaKeyIdLen 离线媒体密钥标识符长度。 * @param status 已获取媒体密钥状态。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或其它指针类型输入参数为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或其它指针类型输入参数为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -344,10 +331,9 @@ Drm_ErrCode OH_MediaKeySystem_GetOfflineMediaKeyStatus(MediaKeySystem *mediaKeyS * @param mediaKeySystem 媒体密钥系统实例。 * @param offlineMediaKeyId 离线媒体密钥标识符。 * @param offlineMediaKeyIdLen 离线媒体密钥标识符长度。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数offlineMediaKeyId为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数offlineMediaKeyId为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -358,10 +344,9 @@ Drm_ErrCode OH_MediaKeySystem_ClearOfflineMediaKeys(MediaKeySystem *mediaKeySyst * @brief 获取媒体密钥系统的证书状态。 * @param mediaKeySystem 媒体密钥系统实例。 * @param certStatus 获得的证书状态值。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效，或输入参数certStatus为空指针；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效，或输入参数certStatus为空指针。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */ @@ -371,10 +356,9 @@ Drm_ErrCode OH_MediaKeySystem_GetCertificateStatus(MediaKeySystem *mediaKeySyste /** * @brief Destroy a 媒体密钥系统实例。 * @param mediaKeySystem 指定将销毁哪个媒体密钥系统实例。 - * @return 函数结果代码： - * {@link DRM_ERR_OK}执行成功；\n - *         {@link DRM_ERR_INVALID_VAL}输入参数mediaKeySystem为空指针或无效；\n - *         {@link DRM_ERR_UNKNOWN}发生内部错误，请查看日志详细信息。 + * @return DRM_ERR_OK：执行成功。\n + * DRM_ERR_INVALID_VAL：输入参数mediaKeySystem为空指针或无效。\n + * DRM_ERR_UNKNOWN：发生内部错误，请查看日志详细信息。 * @since 11 * @version 1.0 */