Update the description for the esplusplayer_enable_video_hole() function

Change-Id: Ib63cb40e699ebb98c3a3cb2d88ec7e35262551d4
(cherry picked from commit 75bf625d6af8563766d0e7d83cf9d6c4108666d0)

diff --git a/include/esplusplayer_capi/esplusplayer_capi.h b/include/esplusplayer_capi/esplusplayer_capi.h
index bae8697..0440098 100644 (file)
--- a/include/esplusplayer_capi/esplusplayer_capi.h
+++ b/include/esplusplayer_capi/esplusplayer_capi.h
@@ -111,7 +111,7 @@ typedef enum {
    *                #ESPLUSPLAYER_STATE_READY from #ESPLUSPLAYER_STATE_IDLE.
    *                It changes the state immediately.
    *                It's usually used for sparse stream. (e.g. video packet
-   *                arrives but audio packet does't yet.)
+   *                arrives but audio packet doesn't yet.)
    */
   ESPLUSPLAYER_LOW_LATENCY_MODE_DISABLE_PREROLL = 0x0200,
   /**
@@ -1742,7 +1742,7 @@ int esplusplayer_decoded_buffer_destroy(
  * @exception None
  * @remark    Public supports #ESPLUSPLAYER_LOW_LATENCY_MODE_DISABLE_PREROLL only.
  *            No operation is performed and #ESPLUSPLAYER_ERROR_TYPE_NONE will be returned,
- *            if @a mode is not #ESPLUSPLAYER_LOW_LATENCY_MODE_DISABLE_PREROLL to make compatilbe with TV API.
+ *            if @a mode is not #ESPLUSPLAYER_LOW_LATENCY_MODE_DISABLE_PREROLL to make compatible with TV API.
  * @see       esplusplayer_open()
  */
 int esplusplayer_set_low_latency_mode(esplusplayer_handle handle,
@@ -1912,10 +1912,10 @@ int esplusplayer_get_render_time_offset(esplusplayer_handle handle,
  *            // ... your codes ...
  *            esplusplayer_close(esplayer);
  * @endcode
- * @pre       The player state can be all of #esplusplayer_state except
- *            #ESPLUSPLAYER_STATE_NONE.
- *            But before #ESPLUSPLAYER_STATE_READY, esplusplayer_decoded_video_frame_buffer_type must
+ * @pre       The player state must not be #ESPLUSPLAYER_STATE_NONE.
+ * @remark    To disable video hole, esplusplayer_decoded_video_frame_buffer_type() must
  *            not be set to #ESPLUSPLAYER_DECODED_VIDEO_FRAME_BUFFER_TYPE_NONE.
+ *            To enable video hole, esplusplayer_set_display() must be set to #ESPLUSPLAYER_DISPLAY_TYPE_OVERLAY
  * @post      None
  * @exception None
  * @see       esplusplayer_set_video_frame_buffer_type()