Revise description - change 'src' to 'source'

Change-Id: Iecd584434cf12248745d8c572e41c13879f2ba9e
Signed-off-by: Sangchul Lee <sc11.lee@samsung.com>

diff --git a/include/media_streamer.h b/include/media_streamer.h
index 76a7e04c8180ab0c6c4c7eea43f4fe47ce264581..0917f47cdcb98716c44e8cb2ca5180138868732a 100644 (file)
--- a/include/media_streamer.h
+++ b/include/media_streamer.h
@@ -57,7 +57,7 @@ typedef void *media_streamer_node_h;
  */
 typedef enum {
        MEDIA_STREAMER_NODE_TYPE_NONE,                 /**<  Not defined type */
-       MEDIA_STREAMER_NODE_TYPE_SRC,                  /**<  Src node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_src() */
+       MEDIA_STREAMER_NODE_TYPE_SRC,                  /**<  Source node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_src() */
        MEDIA_STREAMER_NODE_TYPE_SINK,                 /**<  Sink node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_sink() */
        MEDIA_STREAMER_NODE_TYPE_VIDEO_ENCODER,        /**<  Video encoder node type */
        MEDIA_STREAMER_NODE_TYPE_VIDEO_DECODER,        /**<  Video decoder node type */
@@ -93,17 +93,17 @@ typedef enum {
  * @since_tizen 3.0
  */
 typedef enum {
-       MEDIA_STREAMER_NODE_SRC_TYPE_NONE,           /**<  Not defined src type */
-       MEDIA_STREAMER_NODE_SRC_TYPE_FILE,           /**<  Local file src type */
-       MEDIA_STREAMER_NODE_SRC_TYPE_HTTP,           /**<  Http src type, Network internet feature is required */
-       MEDIA_STREAMER_NODE_SRC_TYPE_RTSP,           /**<  Rtsp src type, Network internet feature is required */
-       MEDIA_STREAMER_NODE_SRC_TYPE_CAMERA,         /**<  Camera src type, Camera feature is required */
-       MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_CAPTURE,  /**<  Audio capture src type, Microphone feature is required */
-       MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_CAPTURE,  /**<  Video capture src type, Camera feature is required */
-       MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_TEST,     /**<  Audio test src type */
-       MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_TEST,     /**<  Video test src type */
-       MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM,         /**<  Custom src type */
-       MEDIA_STREAMER_NODE_SRC_TYPE_ADAPTIVE        /**<  Adaptive src type, Network internet feature is required */
+       MEDIA_STREAMER_NODE_SRC_TYPE_NONE,           /**<  Not defined source type */
+       MEDIA_STREAMER_NODE_SRC_TYPE_FILE,           /**<  Local file source type */
+       MEDIA_STREAMER_NODE_SRC_TYPE_HTTP,           /**<  Http source type, Network internet feature is required */
+       MEDIA_STREAMER_NODE_SRC_TYPE_RTSP,           /**<  Rtsp source type, Network internet feature is required */
+       MEDIA_STREAMER_NODE_SRC_TYPE_CAMERA,         /**<  Camera source type, Camera feature is required */
+       MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_CAPTURE,  /**<  Audio capture source type, Microphone feature is required */
+       MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_CAPTURE,  /**<  Video capture source type, Camera feature is required */
+       MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_TEST,     /**<  Audio test source type */
+       MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_TEST,     /**<  Video test source type */
+       MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM,         /**<  Custom source type */
+       MEDIA_STREAMER_NODE_SRC_TYPE_ADAPTIVE        /**<  Adaptive source type, Network internet feature is required */
 } media_streamer_node_src_type_e;
 
 /**
@@ -156,13 +156,13 @@ typedef enum {
 } media_streamer_error_e;
 
 /**
- * @brief Enumeration of media streamer buffer status of custom src.
+ * @brief Enumeration of media streamer buffer status of custom source.
  *
  * @since_tizen 3.0
  */
 typedef enum {
-       MEDIA_STREAMER_CUSTOM_BUFFER_UNDERRUN,  /**< Buffer underrun of custom src */
-       MEDIA_STREAMER_CUSTOM_BUFFER_OVERFLOW,  /**< Buffer overflow of custom src */
+       MEDIA_STREAMER_CUSTOM_BUFFER_UNDERRUN,  /**< Buffer underrun of custom source */
+       MEDIA_STREAMER_CUSTOM_BUFFER_OVERFLOW,  /**< Buffer overflow of custom source */
 } media_streamer_custom_buffer_status_e;
 
 /**
@@ -629,7 +629,7 @@ int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
 int media_streamer_src_set_buffer_status_cb(media_streamer_node_h source, media_streamer_custom_buffer_status_cb callback, void *user_data);
 
 /**
- * @brief Unsets the src buffer status callback function.
+ * @brief Unsets the source buffer status callback function.
  * @since_tizen 3.0
  * @param[in] source    Media streamer source node handle
  * @return @c 0 on success,
@@ -738,7 +738,7 @@ int media_streamer_create(media_streamer_h *streamer);
  * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
  * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE
  *      by calling media_streamer_create() or media_streamer_unprepare().
- * @pre At least one src and one sink should be added and linked in the streamer
+ * @pre At least one source and one sink should be added and linked in the streamer
  *      by calling media_streamer_node_create_src(), media_streamer_node_create_sink() and media_streamer_node_link().
  * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
  * @see media_streamer_unprepare()
@@ -882,7 +882,7 @@ int media_streamer_get_play_position(media_streamer_h streamer, int *time);
 /**
  * @brief Gets the total running time of the associated media.
  * @since_tizen 3.0
- * @remarks The streamer's src node type should be #MEDIA_STREAMER_NODE_SRC_TYPE_FILE or #MEDIA_STREAMER_NODE_SRC_TYPE_HTTP.
+ * @remarks The streamer's source node type should be #MEDIA_STREAMER_NODE_SRC_TYPE_FILE or #MEDIA_STREAMER_NODE_SRC_TYPE_HTTP.
  *          If not, return value will be #MEDIA_STREAMER_ERROR_NONE and duration will be -1.
  * @param[in]  streamer     Media streamer handle
  * @param[out] duration     The duration in milliseconds
@@ -915,11 +915,11 @@ int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *
  * @brief Creates media streamer source node.
  * @since_tizen 3.0
  * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to play from network.
- *          The camera privilege(%http://tizen.org/privilege/camera) should be added if the src node handle the camera device.
- *          The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the src node handle the recorder device.
+ *          The camera privilege(%http://tizen.org/privilege/camera) should be added if the source node handles the camera device.
+ *          The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the source node handles the recorder device.
  *          You can release source node using media_streamer_node_destroy() function.
  * @param[in]  type     Media streamer source node type
- * @param[out] src      Media streamer source node handle
+ * @param[out] source   Media streamer source node handle
  * @return @c 0 on success,
  *         otherwise a negative error value
  * @retval #MEDIA_STREAMER_ERROR_NONE Successful
@@ -995,7 +995,7 @@ int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *
  *          and output data.
  * @since_tizen 3.0
  * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
- *          To create src / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
+ *          To create source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
  *          You can release @a node using media_streamer_node_destroy() function
  * @param[in]  type      Created node type
  * @param[in]  in_fmt    Media format handle for input data
@@ -1078,9 +1078,9 @@ int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h
  *          src_node and sink_node is determined relatively.
  *          In case of (A)-(B)-(C),
  *          (B) can be sink_node with (A) or (B) can be src_node with (C).
- *          However, src type node is always src node and sink type node is always sink node.
- *          (A) is src node and can not be sink node at all.
- *          (C) is sink node and can not be src node at all.
+ *          However, source type node is always source node and sink type node is always sink node.
+ *          (A) is source node and can not be sink node at all.
+ *          (C) is sink node and can not be source node at all.
  * @param[in] src_node      Media streamer node handle
  * @param[in] src_pad_name  The name of the source pad of the source node
  * @param[in] dest_node     The destination media streamer node handle
@@ -1141,7 +1141,7 @@ int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *p
  * @since_tizen 3.0
  * @remarks After using the src_pad_name and sink_pad_name, it have to be free.
  *          src_pad_name or sink_pad_name can be null according to the node type.
- *          In case of src type node, sink_pad_name will be null.
+ *          In case of source type node, sink_pad_name will be null.
  *          In case of sink type node, src_pad_name will be null.
  * @param[in]  node            Media streamer node handle
  * @param[out] src_pad_name    Array of source pad name