[0.3.121] update api reference about DRM 80/212080/8
authorEunhye Choi <eunhae1.choi@samsung.com>
Wed, 14 Aug 2019 05:12:51 +0000 (14:12 +0900)
committerEunhye Choi <eunhae1.choi@samsung.com>
Mon, 19 Aug 2019 11:40:33 +0000 (20:40 +0900)
- Update API reference about DRM restriction.
- Some API could not be supported by DRM policy of each product.
- Apply docxygen feedback about ACR-1427

Change-Id: I33b83ac0bbc08e7e0706bd915ac649a97acdedc1

include/player.h

index 0de1fff..f0bd5ed 100644 (file)
@@ -1054,6 +1054,8 @@ int player_set_display(player_h player, player_display_type_e type, player_displ
  *          and the media packet is available until it's destroyed by media_packet_destroy().\n
  *          The packet have to be destroyed as quickly as possible after rendering the packet\n
  *          and all the packets have to be destroyed before player_unprepare() is called.\n
+ * @remarks If the content is encrypted or there are copyright issues with it,
+ *          this function could be unsupported depending on the DRM policy.
  * @param[in] player The handle to the media player
  * @param[in] callback The callback function to be registered
  * @param[in] user_data The user data to be passed to the callback function
@@ -1094,6 +1096,8 @@ int player_unset_media_packet_video_frame_decoded_cb(player_h player);
  * @remarks If audio offload is enabled by calling player_audio_offload_set_enabled(),
  *          this function will return #PLAYER_ERROR_INVALID_OPERATION and
  *          this will not work at all even if it was called before enabling offload. (Since 5.5)
+ * @remarks If the content is encrypted or there are copyright issues with it,
+ *          this function could be unsupported depending on the DRM policy.
  * @param[in] player     The handle to the media player
  * @param[in] format     The media format handle about required audio PCM specification.
  *                       This format has to include PCM MIME type, audio channel and sampling rate.
@@ -1169,7 +1173,7 @@ int player_unset_media_packet_audio_frame_decoded_cb(player_h player);
 int player_push_media_stream(player_h player, media_packet_h packet);
 
 /**
- * @brief Retrieves all supported media format for playback of external media stream.
+ * @brief Retrieves all supported media formats for the playback of external media stream.
  * @details The supported media format can vary depending on the device capabilities.
  * @since_tizen 5.5
  * @param[in] player      The handle to the media player
@@ -1841,6 +1845,9 @@ int player_audio_effect_equalizer_is_available(player_h player, bool *available)
 /**
  * @brief Captures the video frame, asynchronously.
  * @since_tizen @if WEARABLE 2.3.1 @else 2.3 @endif
+ * @remarks If the content is encrypted or there are copyright issues with it,
+ *          this function could be unsupported depending on the DRM policy.
+ *          In case the function is not supported by the DRM policy, it will return an error.
  * @param[in] player      The handle to the media player
  * @param[in] callback    The callback function to register
  * @param[in] user_data   The user data to be passed to the callback function