* limitations under the License.
*/
-#ifndef __TIZEN_MEDIASTREAMER_H__
-#define __TIZEN_MEDIASTREAMER_H__
+#ifndef __TIZEN_MULTIMEDIA_MEDIA_STREAMER_H__
+#define __TIZEN_MULTIMEDIA_MEDIA_STREAMER_H__
#include <tizen.h>
#include <bundle.h>
} media_streamer_error_e;
/**
- * @brief Enumeration of media streamer buffer status of custom src
+ * @brief Enumeration of media streamer buffer status of custom src.
*
* @since_tizen 3.0
*/
} media_streamer_interrupted_code_e;
/**
- * @brief Definition for "camera-id" parameter of source node.
+ * @brief Definition for camera-id parameter of source node.
* @details Index number of camera to activate.
* Data type is integer and default value is 0.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_CAMERA_ID "camera-id"
/**
- * @brief Definition for capture parameter of source node.
+ * @brief Definition for capture-width parameter of source node.
* @details Width for camera size to capture.
* Data type is integer and default value is 1600.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_CAPTURE_WIDTH "capture-width"
/**
- * @brief Definition for capture parameter of source node.
+ * @brief Definition for capture-height parameter of source node.
* @details Height for camera size to capture.
* Data type is integer and default value is 1200.
* @since_tizen 3.0
/**
* @brief Definition for uri parameter of source node.
- * @details Uri to read from
+ * @details URI to read from
* Data type is string.
* @since_tizen 3.0
* @see media_streamer_node_get_params
#define MEDIA_STREAMER_PARAM_URI "uri"
/**
- * @brief Definition for user-agent parameter of source node
+ * @brief Definition for user-agent parameter of source node.
* @details Value of the User-Agent HTTP request header field.
* Data type is string.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_USER_AGENT "user-agent"
/**
- * @brief Definition for stream type parameter of source node
+ * @brief Definition for stream type parameter of source node.
* @details The type of the push data stream.
* 0:stream, 1:seekable, 2:random-access (default:0)
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_STREAM_TYPE "stream-type"
/**
- * @brief Definition for port parameter of source or sink node
+ * @brief Definition for port parameter of source or sink node.
* @details The port to receive the packets from.
* Data type is integer and default value is 5004.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_PORT "port"
/**
- * @brief Definition for video port parameter of source node
+ * @brief Definition for video port parameter of source node.
* @details The port to receive the video packets from.
* Data type is integer.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_VIDEO_IN_PORT "video_in_port"
/**
- * @brief Definition for audio port parameter of source node
+ * @brief Definition for audio port parameter of source node.
* @details The port to receive the audio packets from.
* Data type is integer.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_AUDIO_IN_PORT "audio_in_port"
/**
- * @brief Definition for video port parameter of sink node
+ * @brief Definition for video port parameter of sink node.
* @details The port to send the video packets to.
* Data type is integer.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_VIDEO_OUT_PORT "video_out_port"
/**
- * @brief Definition for audio port parameter of sink node
+ * @brief Definition for audio port parameter of sink node.
* @details The port to send the audio packets to.
* Data type is integer.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_AUDIO_OUT_PORT "audio_out_port"
/**
- * @brief Definition for IP address parameter of source node
+ * @brief Definition for IP address parameter of source node.
* @details IP address to send/receive packets for.
* Data type is string and default value is "0.0.0.0".
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_IP_ADDRESS "address"
/**
- * @brief Definition for audio device name parameter of source or sink node
+ * @brief Definition for audio device name parameter of source or sink node.
* @details ALSA device, as defined in an asound configuration file.
* ex) "hw:0,0", "hw:0,1"
* Data type is string and default value is "default".
#define MEDIA_STREAMER_PARAM_AUDIO_DEVICE "audio_device"
/**
- * @brief Definition for sync parameter of sink node
+ * @brief Definition for sync parameter of sink node.
* @details Synchronize on the clock
* Data type is boolean and default value is true.
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_CLOCK_SYNCHRONIZED "sync"
/**
- * @brief Definition for rotate parameter of sink node
+ * @brief Definition for rotate parameter of sink node.
* @details Rotate angle of display output.
* 0:none/1:rotate 90 degree/2:rotate 180 degree/3:rotate 270 degree
* Default value is 3(rotate 270 degree).
#define MEDIA_STREAMER_PARAM_ROTATE "rotate"
/**
- * @brief Definition for flip parameter of sink node
+ * @brief Definition for flip parameter of sink node.
* @details Flip for display.
* 0:none, 1:horizontal, 2:vertical, 3:both
* Default value is 0.
#define MEDIA_STREAMER_PARAM_FLIP "flip"
/**
- * @brief Definition for display geometry method parameter of sink node
+ * @brief Definition for display geometry method parameter of sink node.
* @details Geometrical method for display.
* 0:Letter box
* 1:Original size
#define MEDIA_STREAMER_PARAM_DISPLAY "display"
/**
- * @brief Definition for visible parameter of sink node
+ * @brief Definition for visible parameter of sink node.
* @details Draws screen or blacks out.
* Data type is boolean and default value is true(visible).
* @since_tizen 3.0
#define MEDIA_STREAMER_PARAM_VISIBLE "visible"
/**
- * @brief Definition for host parameter of sink node
+ * @brief Definition for host parameter of sink node.
* @details The host/IP/Multicast group to send the packets to.
* Data type is string and default value is "localhost".
* @since_tizen 3.0
/**
* @brief Called when error occurs in media streamer.
- * @details Following error codes can be delivered.
+ * @since_tizen 3.0
+ * @remarks Following error codes can be delivered.
* #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
* #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
* #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
* #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
* #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
- * @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [in] error The error that occurred in media steamer
- * @param [in] user_data The user data passed from the code where
- * media_streamer_set_error_cb() was invoked
- * This data will be accessible from @a media_streamer_error_cb
+ * @param[in] streamer Media streamer handle
+ * @param[in] error The error that occurred in media steamer
+ * @param[in] user_data The user data passed from the code where
+ * media_streamer_set_error_cb() was invoked
+ * This data will be accessible from media_streamer_error_cb
* @pre Create media streamer handle by calling media_streamer_create() function
* @see media_streamer_set_error_cb()
* @see media_streamer_unset_error_cb()
/**
* @brief Called when media streamer state is changed.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [in] previous_state The previous state of the media streamer
- * @param [in] current_state The current state of media streamer
- * @param [in] user_data The user data passed from the code where
- * media_streamer_set_state_changed_cb() was invoked
- * This data will be accessible from @a media_streamer_state_changed_cb
+ * @param[in] streamer Media streamer handle
+ * @param[in] previous_state The previous state of the media streamer
+ * @param[in] current_state The current state of media streamer
+ * @param[in] user_data The user data passed from the code where
+ * media_streamer_set_state_changed_cb() was invoked
+ * This data will be accessible from media_streamer_state_changed_cb
* @pre Create media streamer handle by calling media_streamer_create() function
* @see media_streamer_set_state_change_cb()
* @see media_streamer_unset_state_change_cb()
* or no free space in custom source buffer.
* @since_tizen 3.0
* @remarks Callback can be applied only for MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
- * @param [in] node Media streamer source node handle
- * @param [in] user_data The user data passed from the callback registration function
+ * @param[in] node Media streamer source node handle
+ * @param[in] status Media streamer custom buffer status
+ * @param[in] user_data The user data passed from the callback registration function
* @see media_streamer_src_set_buffer_status_cb()
* @see media_streamer_node_get_param()
* @see media_streamer_node_set_param()
* @brief Called when new data is available from custom sink.
* @details This callback can be applied only to MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
* @since_tizen 3.0
- * @param [in] node Media streamer sink node handle
- * @param [in] user_data The user data passed from the code where
+ * @param[in] node Media streamer sink node handle
+ * @param[in] user_data The user data passed from the code where
* media_streamer_sink_set_data_ready_cb() was invoked
- * This data will be accessible from @a media_streamer_sink_data_ready_cb
+ * This data will be accessible from media_streamer_sink_data_ready_cb
* @pre media_streamer_sink_set_data_ready_cb()
* @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
* @see media_streamer_sink_set_data_ready_cb()
* @brief Called when the end-of-stream has been reached.
* @details This callback can be applied only to MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
* @since_tizen 3.0
- * @param [in] node Media streamer sink node handle
- * @param [in] user_data The user data passed from the code where
+ * @param[in] node Media streamer sink node handle
+ * @param[in] user_data The user data passed from the code where
* media_streamer_sink_set_eos_cb() was invoked
- * This data will be accessible from @a media_streamer_sink_eos_cb
+ * This data will be accessible from media_streamer_sink_eos_cb
* @pre media_streamer_sink_set_eos_cb()
* @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
* @see media_streamer_sink_set_eos_cb()
/**
* @brief Called when the media streamer is interrupted.
* @since_tizen 3.0
- * @param[in] error_code The interrupted error code
- * @param[in] user_data The user data passed from the callback registration function
+ * @param[in] code The interrupted error code
+ * @param[in] user_data The user data passed from the callback registration function
* @see media_streamer_set_interrupted_cb()
* @see media_streamer_unset_interrupted_cb()
*/
typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e code, void *user_data);
/**
- * @brief Registers a error callback function to be invoked when an error occurs.
+ * @brief Sets a error callback function to be invoked when an error occurs.
* @details Following error codes can be delivered by error callback.
* #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
* #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
* #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
* #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [in] callback Callback function pointer
- * @param [in] user_data The user data passed from the code where
- * media_streamer_set_error_cb() was invoked
- * This data will be accessible from @a media_streamer_error_cb
+ * @param[in] streamer Media streamer handle
+ * @param[in] callback Callback function pointer
+ * @param[in] user_data The user data passed from the code where
+ * media_streamer_set_error_cb() was invoked
+ * This data will be accessible from media_streamer_error_cb
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_set_error_cb(media_streamer_h streamer, media_streamer_error_cb callback, void *user_data);
/**
- * @brief Unregisters the error callback function.
+ * @brief Unsets the error callback function.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_unset_error_cb(media_streamer_h streamer);
/**
- * @brief Registers a callback that will be triggered after media streamer state is changed.
+ * @brief Sets a callback that will be triggered after media streamer state is changed.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [in] callback Callback function pointer
- * @param [in] user_data The user data passed from the code
- * where media_streamer_set_state_change_cb() was invoked
- * This data will be accessible from @a media_streamer_state_changed_cb
+ * @param[in] streamer Media streamer handle
+ * @param[in] callback Callback function pointer
+ * @param[in] user_data The user data passed from the code
+ * where media_streamer_set_state_change_cb() was invoked
+ * This data will be accessible from media_streamer_state_changed_cb
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_set_state_change_cb(media_streamer_h streamer, media_streamer_state_changed_cb callback, void *user_data);
/**
- * @brief Unregisters the state changed callback function.
+ * @brief Unsets the state changed callback function.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_unset_state_change_cb(media_streamer_h streamer);
/**
- * @brief Registers a callback function to be invoked when the media streamer is interrupted.
+ * @brief Sets a callback function to be invoked when the media streamer is interrupted.
* @since_tizen 3.0
- * @param[in] streamer Media streamer handle
- * @param[in] callback The callback function to register
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] streamer Media streamer handle
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_set_interrupted_cb(media_streamer_h streamer, media_streamer_interrupted_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unsets the callback function.
* @since_tizen 3.0
* @param[in] streamer Media streamer handle
* @return @c 0 on success,
int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
/**
- * @brief Registers a callback function to be invoked when buffer underrun or overflow is occurred.
+ * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred.
* @details This function can be called only for MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
* @since_tizen 3.0
- * @remarks This API is used for media stream playback only.
- * @param [in] source Media streamer source node handle
- * @param [in] callback The buffer status callback function to register
- * @param [in] user_data The user data passed from the code where
+ * @remarks This function is used for media stream playback only.
+ * @param[in] source Media streamer source node handle
+ * @param[in] callback The buffer status callback function to register
+ * @param[in] user_data The user data passed from the code where
* media_streamer_src_set_buffer_status_cb() was invoked
- * This data will be accessible from @a media_streamer_custom_buffer_status_cb()
+ * This data will be accessible from media_streamer_custom_buffer_status_cb()
* @return @c 0 on success,
- * otherwise a negative error value
+ * otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
int media_streamer_src_set_buffer_status_cb(media_streamer_node_h source, media_streamer_custom_buffer_status_cb callback, void *user_data);
/**
- * @brief Unregisters the src buffer status callback function.
+ * @brief Unsets the src buffer status callback function.
* @since_tizen 3.0
- * @param [in] source Media streamer source node handle
+ * @param[in] source Media streamer source node handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h source);
/**
- * @brief Registers a callback function to be called when the custom sink is ready for data processing.
+ * @brief Sets a callback function to be called when the custom sink is ready for data processing.
* @details This function can be called only for MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
* @since_tizen 3.0
- * @param [in] sink Media streamer sink node handle
- * @param [in] callback Callback function pointer
- * @param [in] user_data The user data passed from the code where
+ * @param[in] sink Media streamer sink node handle
+ * @param[in] callback Callback function pointer
+ * @param[in] user_data The user data passed from the code where
* media_streamer_sink_set_data_ready_cb() was invoked
- * This data will be accessible from @a media_streamer_sink_data_ready_cb
+ * This data will be accessible from media_streamer_sink_data_ready_cb
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_sink_set_data_ready_cb(media_streamer_node_h sink, media_streamer_sink_data_ready_cb callback, void *user_data);
/**
- * @brief Unregisters the sink data ready callback function.
+ * @brief Unsets the sink data ready callback function.
* @since_tizen 3.0
- * @param [in] sink Media streamer sink node handle
+ * @param[in] sink Media streamer sink node handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_sink_unset_data_ready_cb(media_streamer_node_h sink);
/**
- * @brief Registers a callback function to be called when custom sink detect the end-of-stream.
+ * @brief Sets a callback function to be called when custom sink detect the end-of-stream.
* @since_tizen 3.0
- * @param [in] sink Media streamer sink node handle
- * @param [in] callback Callback function pointer
- * @param [in] user_data The user data passed from the code where
+ * @param[in] sink Media streamer sink node handle
+ * @param[in] callback Callback function pointer
+ * @param[in] user_data The user data passed from the code where
* media_streamer_sink_set_eos_cb() was invoked.
- * This data will be accessible from @a media_streamer_sink_eos_cb
+ * This data will be accessible from media_streamer_sink_eos_cb
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_sink_set_eos_cb(media_streamer_node_h sink, media_streamer_sink_eos_cb callback, void *user_data);
/**
- * @brief Unregisters the sink end-of-stream callback function.
+ * @brief Unsets the sink end-of-stream callback function.
* @since_tizen 3.0
- * @param [in] sink Media streamer sink node handle
+ * @param[in] sink Media streamer sink node handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* passes the handle to the caller.
* @since_tizen 3.0
* @remarks You must release @a streamer using media_streamer_destroy()
- * @param [out] streamer Media streamer handle
+ * @param[out] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Sets media streamer state to MEDIA_STREAMER_STATE_READY.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
* @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE
+ * @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
* by calling media_streamer_node_create_src(), media_streamer_node_create_sink() and media_streamer_node_link().
* @brief Sets media streamer state to MEDIA_STREAMER_STATE_IDLE.
* @details The most recently used media is reset and no longer associated with the media streamer.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @brief Sets media streamer state to MEDIA_STREAMER_STATE_PLAYING.
* @details Start running the current streamer, or resumes it if paused.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Pauses the media streamer.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Stops the media streamer.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Destroys media streamer.
* @since_tizen 3.0
- * @remark Nodes in streamer will be removed automatically.
- * Don't need to remove nodes by calling media_streamer_node_remove().
- * If you want to change the node without destroying streamer handle,
- * you can call the media_streamer_node_remove() function
- * after setting the streamer state to MEDIA_STREAMER_STATE_IDLE state.
- * @param [in] streamer Media streamer handle
+ * @remarks Nodes in streamer will be removed automatically.
+ * Don't need to remove nodes by calling media_streamer_node_remove().
+ * If you want to change the node without destroying streamer handle,
+ * you can call the media_streamer_node_remove() function
+ * after setting the streamer state to MEDIA_STREAMER_STATE_IDLE state.
+ * @param[in] streamer Media streamer handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Changes playback position to the defined time value, asynchronously.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [in] time Time in millisecond
- * @param [in] accurate If @c true, it will seek to the accurate position, but this might be considerably slower for some formats,
- * otherwise @c false, it will seek to the nearest keyframe.
- * @param [in] callback The callback function to register
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] streamer Media streamer handle
+ * @param[in] time Time in millisecond
+ * @param[in] accurate If @c true, it will seek to the accurate position, but this might be considerably slower for some formats,
+ * otherwise @c false, it will seek to the nearest keyframe
+ * @param[in] callback The callback function to register
+ * @param[in] user_data The user data to be passed to the callback function
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Gets the current position in milliseconds.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [out] time The current position in milliseconds
+ * @param[in] streamer Media streamer handle
+ * @param[out] time The current position in milliseconds
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @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.
* 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
+ * @param[in] streamer Media streamer handle
+ * @param[out] duration The duration in milliseconds
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Gets media streamer state.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [out] state Media streamer state
+ * @param[in] streamer Media streamer handle
+ * @param[out] state Media streamer state
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Creates media streamer source node.
* @since_tizen 3.0
+ * @privilege http://tizen.org/privilege/internet
+ * http://tizen.org/privilege/camera
+ * http://tizen.org/privilege/recorder
* @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.
- * You can release @a source node using media_streamer_node_destroy() function.
- * @param [in] type Media streamer source node type
- * @param [out] src Media streamer source node handle
+ * 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
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @brief Pushes packet into custom source node.
* @details This function can be called only for MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM.
* @since_tizen 3.0
- * @param [in] src Media streamer source node handle
- * @param [in] packet Media packet handle
+ * @param[in] src Media streamer source node handle
+ * @param[in] packet Media packet handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
- * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
* @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
* @pre Create a source node handle by calling media_streamer_node_create_src() function
- * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE at least.
+ * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE at least.
* @see #media_packet_h
*/
int media_streamer_node_push_packet(media_streamer_node_h src, media_packet_h packet);
/**
* @brief Creates media streamer sink node.
* @since_tizen 3.0
+ * @privilege http://tizen.org/privilege/internet
* @remarks The internet privilege(http://tizen.org/privilege/internet) should be added if any URIs are used to transmit the output data.
* You can release @a sink node using media_streamer_node_destroy()
* @remarks If @a type is #MEDIA_STREAMER_NODE_SINK_TYPE_ADAPTIVE, the HTTP server will be started and the server will be able to transmit the output data to the other device.
* The application must have an authentication responsibility between a server and client because the data transmission is not secure.
- * @param [in] type Type of sink node to be created
- * @param [out] sink Media streamer sink node handle
+ * @param[in] type Type of sink node to be created
+ * @param[out] sink Media streamer sink node handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @brief Pulls packet from custom sink node.
* @details This function can be called only for MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
* @since_tizen 3.0
- * @param [in] sink Media streamer sink node handle
- * @param [out] packet Media packet handle
+ * @param[in] sink Media streamer sink node handle
+ * @param[out] packet Media packet handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @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.
* 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
- * @param [in] out_fmt Media format handle for output data
- * @param [out] node Media streamer node handle to be created
+ * @param[in] type Created node type
+ * @param[in] in_fmt Media format handle for input data
+ * @param[in] out_fmt Media format handle for output data
+ * @param[out] node Media streamer node handle to be created
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Adds node to media streamer.
* @since_tizen 3.0
- * @param [in] streamer Media streamer handle
- * @param [in] node Media streamer node handle to be added
+ * @param[in] streamer Media streamer handle
+ * @param[in] node Media streamer node handle to be added
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Destroys media streamer node.
* @since_tizen 3.0
- * @param [in] node Media streamer node handle
+ * @param[in] node Media streamer node handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @since_tizen 3.0
* @remarks To remove node without error posting, the state of streamer should be MEDIA_STREAMER_STATE_IDLE.
* If the node is linked, it will be unlinked before removing.
- * @param [in] streamer Media streamer handle
- * @param [in] node Media streamer node handle
+ * @param[in] streamer Media streamer handle
+ * @param[in] node Media streamer node handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Links two media streamer nodes.
* @since_tizen 3.0
- * @remark Pads are node's input and output, where you can connect other nodes.
- * (src_node) - (sink_node)
- * 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.
- * @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
- * @param [in] sink_pad_name The name of the sink pad of the destination node
+ * @remarks Pads are node's input and output, where you can connect other nodes.
+ * (src_node) - (sink_node)
+ * 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.
+ * @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
+ * @param[in] sink_pad_name The name of the sink pad of the destination node
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Sets media format for pad of media streamer node.
* @since_tizen 3.0
- * @param [in] node Media streamer node handle
- * @param [in] pad_name Pad name
- * @param [in] fmt Media format handle
+ * @param[in] node Media streamer node handle
+ * @param[in] pad_name Pad name
+ * @param[in] fmt Media format handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Gets media format for pad of media streamer node.
* @since_tizen 3.0
- * @param [in] node Media streamer node handle
- * @param [in] pad_name Pad name
- * @param [out] fmt Media format handle
+ * @param[in] node Media streamer node handle
+ * @param[in] pad_name Pad name
+ * @param[out] fmt Media format handle
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Gets name of node pads.
* @since_tizen 3.0
- * @remark 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 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
- * @param [out] src_pad_num The number of source pads
- * @param [out] sink_pad_name Array of sink pad name
- * @param [out] sink_pad_num The number of sink pads
+ * @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 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
+ * @param[out] src_pad_num The number of source pads
+ * @param[out] sink_pad_name Array of sink pad name
+ * @param[out] sink_pad_num The number of sink pads
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad_name,
int *src_pad_num, char ***sink_pad_name, int *sink_pad_num);
-
/**
* @brief Sets parameters of node.
* @details Many parameters can be set at one time all together by using bundle.
* @since_tizen 3.0
+ * @privilege http://tizen.org/privilege/mediastorage
+ * http://tizen.org/privilege/externalstorage
* @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
* The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
- * @param [in] node Media streamer node handle
- * @param [in] param_list Key value array of media streamer node parameters
+ * @param[in] node Media streamer node handle
+ * @param[in] param_list Key value array of media streamer node parameters
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
/**
* @brief Gets node parameter list.
* @since_tizen 3.0
- * @remark After using param_list, it have to be free by calling bundle_free() in bundle.h
- * Refer to the "Parameter information of node" in this file to get info.
- * @param [in] node Media streamer node handle
- * @param [out] param_list Key value array of media streamer node parameters
+ * @remarks After using param_list, it have to be free by calling bundle_free() in bundle.h
+ * Refer to the "Parameter information of node" in this file to get info.
+ * @param[in] node Media streamer node handle
+ * @param[out] param_list Key value array of media streamer node parameters
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @brief Sets single parameter of node.
* @details Sets parameter one by one without creating param bundle.
* @since_tizen 3.0
+ * @privilege http://tizen.org/privilege/mediastorage
+ * http://tizen.org/privilege/externalstorage
* @remarks The mediastorage privilege(http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
* The externalstorage privilege(http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
- * @param [in] node Media streamer node handle
- * @param [in] param_name Param name of node
- * @param [in] param_value Param value of node
+ * @param[in] node Media streamer node handle
+ * @param[in] param_name Param name of node
+ * @param[in] param_value Param value of node
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
* @brief Gets value of parameter.
* @details Gets parameter one by one without creating param bundle.
* @since_tizen 3.0
- * @param [in] node Media streamer node handle
- * @param [in] param_name Param name of node
- * @param [out] param_value Param value of node
+ * @param[in] node Media streamer node handle
+ * @param[in] param_name Param name of node
+ * @param[out] param_value Param value of node
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_STREAMER_ERROR_NONE Successful
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIASTREAMER_H__ */
+#endif /* __TIZEN_MULTIMEDIA_MEDIA_STREAMER_H__ */
projects / platform / core / api / mediastreamer.git / commitdiff