/**
* @brief Definition for camera-id parameter of source node.
- * @details Index number of camera to activate.
+ * @details Index number of camera to activate.\n
* Data type is integer and default value is 0.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for capture-width parameter of source node.
- * @details Width for camera size to capture.
+ * @details Width for camera size to capture.\n
* Data type is integer and default value is 1600.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for capture-height parameter of source node.
- * @details Height for camera size to capture.
+ * @details Height for camera size to capture.\n
* Data type is integer and default value is 1200.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for is-live parameter of source node.
- * @details Whether to act as a live source.
+ * @details Whether to act as a live source.\n
* Data type is boolean and default value is false.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for URI parameter of source node.
- * @details URI to read from.
+ * @details URI to read from.\n
* Data type is string.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for user-agent parameter of source node.
- * @details Value of the User-Agent HTTP request header field.
+ * @details Value of the User-Agent HTTP request header field.\n
* Data type is string.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for stream type parameter of source node.
- * @details The type of the push data stream.
+ * @details The type of the push data stream.\n
* 0:stream, 1:seekable, 2:random-access (default:0)
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for port parameter of source or sink node.
- * @details The port to receive the packets from.
+ * @details The port to receive the packets from.\n
* Data type is integer and default value is 5004.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for video port parameter of source node.
- * @details The port to receive the video packets from.
+ * @details The port to receive the video packets from.\n
* Data type is integer.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for audio port parameter of source node.
- * @details The port to receive the audio packets from.
+ * @details The port to receive the audio packets from.\n
* Data type is integer.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for video port parameter of sink node.
- * @details The port to send the video packets to.
+ * @details The port to send the video packets to.\n
* Data type is integer.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for audio port parameter of sink node.
- * @details The port to send the audio packets to.
+ * @details The port to send the audio packets to.\n
* Data type is integer.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for IP address parameter of source node.
- * @details IP address to send/receive packets for.
+ * @details IP address to send/receive packets for.\n
* Data type is string and default value is "0.0.0.0".
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for the peer type of WebRTC node.
- * @details The type of WebRTC peer, it can be "answer" or "offer".
+ * @details The type of WebRTC peer, it can be "answer" or "offer".\n
* Data type is string and default value is "answer".
* @since_tizen 6.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for remote session description.
- * @details Value of the session description of the remote peer over its signaling channel.
+ * @details Value of the session description of the remote peer over its signaling channel.\n
* Data type is string.
* @since_tizen 6.0
* @see media_streamer_node_get_params() */
/**
* @brief Definition for ICE candidate of WebRTC node.
- * @details Value of ICE candidate of the remote peer over its signaling channel.
+ * @details Value of ICE candidate of the remote peer over its signaling channel.\n
* Data type is string.
* @since_tizen 6.0
* @see media_streamer_node_get_params() */
/**
* @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"
+ * @details ALSA device, as defined in an asound configuration file.\n
+ * ex) "hw:0,0", "hw:0,1"\n
* Data type is string and default value is "default".
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for sync parameter of sink node.
- * @details Synchronize on the clock
+ * @details Synchronize on the clock.\n
* Data type is boolean and default value is true.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @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
+ * @details Rotate angle of display output.\n
+ * 0:none/1:rotate 90 degree/2:rotate 180 degree/3:rotate 270 degree\n
* Default value is 3(rotate 270 degree).
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for flip parameter of sink node.
- * @details Flip for display.
- * 0:none, 1:horizontal, 2:vertical, 3:both
+ * @details Flip for display.\n
+ * 0:none, 1:horizontal, 2:vertical, 3:both\n
* Default value is 0.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for display geometry method parameter of sink node.
- * @details Geometrical method for display.
- * 0:Letter box
- * 1:Original size
- * 2:Full-screen
- * 3:Cropped full screen
+ * @details Geometrical method for display.\n
+ * 0:Letter box\n
+ * 1:Original size\n
+ * 2:Full-screen\n
+ * 3:Cropped full screen\n
* 4:Original size if surface size is larger than video size(width/height),
* or Letter box if video size(width/height) is larger than surface size.
- * 5:Custom ROI
+ * 5:Custom ROI\n
* Default value is 0(Letter box).
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for display parameter of sink node.
- * @details It is a object to draw video frame on.
+ * @details It is a object to draw video frame on.\n
* Data type is pointer.
* @since_tizen 3.0
- * @remarks This parameter must be set in main thread of application.
- * Otherwise, media_streamer_node_set_param() will return #MEDIA_STREAMER_ERROR_INVALID_OPERATION by internal restriction.
+ * @remarks This parameter must be set in main thread of application.\n
+ * Otherwise, media_streamer_node_set_param() will return #MEDIA_STREAMER_ERROR_INVALID_OPERATION by internal restriction.\n
* To avoid #MEDIA_STREAMER_ERROR_INVALID_OPERATION in sub thread, ecore_thread_main_loop_begin() and
* ecore_thread_main_loop_end() can be used, but deadlock can be also occurred if main thread is busy.
* @see media_streamer_node_get_params()
/**
* @brief Definition for visible parameter of sink node.
- * @details Draws screen or blacks out.
+ * @details Draws screen or blacks out.\n
* Data type is boolean and default value is true(visible).
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for use-tbm parameter of sink node.
- * @details Use Tizen Buffer Memory instead of Shared Memory.
- * The sink node must receive the tbm-buffer created by the previous node.
- * The value is changeable only in the #MEDIA_STREAMER_STATE_IDLE state.
+ * @details Use Tizen Buffer Memory instead of Shared Memory.\n
+ * The sink node must receive the tbm-buffer created by the previous node.\n
+ * The value is changeable only in the #MEDIA_STREAMER_STATE_IDLE state.\n
* Data type is boolean and default value is false.
* @since_tizen 5.5
* @see media_streamer_node_get_params()
/**
* @brief Definition for host parameter of sink node.
- * @details The host/IP/Multicast group to send the packets to.
+ * @details The host/IP/Multicast group to send the packets to.\n
* Data type is string and default value is "localhost".
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for segment location parameter of adaptive sink node.
- * @details Path for writing playlist from.
+ * @details Path for writing playlist from.\n
* Data type is string.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
/**
* @brief Definition for playlist location parameter of adaptive sink node.
- * @details Path for writing playlist from. Data type is string.
+ * @details Path for writing playlist from.\n
+ * Data type is string.
* @since_tizen 3.0
* @see media_streamer_node_get_params()
*/
/**
* @brief Called when error occurs in media streamer.
* @since_tizen 3.0
- * @remarks Following error codes can be delivered.
+ * @remarks Following error codes can be delivered.\n
* #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
* #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
* #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
/**
* @brief Called when the media streamer WebRTC node needs to send the message to the remote peer of the WebRTC connection.
* @since_tizen 6.0
- * @remarks Two types will be delivered with @a message which is a JSON string.
- * One is for the remote session description and the other is for a new ICE candidate.
- * For the remote session description, @a message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
+ * @remarks Two types will be delivered with @a message which is a JSON string.\n
+ * One is for the remote session description and the other is for a new ICE candidate.\n
+ * For the remote session description, @a message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.\n
* For the new ICE candidate, @a message will be {"ice":{"candidate":"..."}}.
* @param[in] webrtc Media streamer WebRTC node handle
* @param[in] message The message to be passed to the remote peer over the signaling channel
/**
* @brief Gets the total running time of the associated media.
* @since_tizen 3.0
- * @remarks The streamer's source 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.\n
* 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
/**
* @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 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().
+ * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to play from network.\n
+ * The camera privilege(%http://tizen.org/privilege/camera) should be added if the source node handles the camera device.\n
+ * The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the source node handles the recorder device.\n
+ * You can release the @a src using media_streamer_node_destroy().
* @param[in] type Media streamer source node type
* @param[out] src Media streamer source node handle
* @return @c 0 on success,
/**
* @brief Creates media streamer sink node.
* @since_tizen 3.0
- * @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.
+ * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to transmit the output data.\n
+ * You can release the @a sink using media_streamer_node_destroy().\n
+ * 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
* @brief Creates media streamer node except #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
* @details Creates node specific @a type with specific format of input 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 source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
- * The internet privilege (%http://tizen.org/privilege/internet) should be added if #MEDIA_STREAMER_NODE_TYPE_WEBRTC is set.
- * You can release @a node using media_streamer_node_destroy().
+ * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.\n
+ * To create source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.\n
+ * The internet privilege (%http://tizen.org/privilege/internet) should be added if #MEDIA_STREAMER_NODE_TYPE_WEBRTC is set.\n
+ * You can release the @a node using media_streamer_node_destroy().
* @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
/**
* @brief Adds node to media streamer.
* @since_tizen 3.0
- * @remarks Before 6.0, this function returns #MEDIA_STREAMER_ERROR_INVALID_STATE if @a streamer is not in the #MEDIA_STREAMER_STATE_IDLE state.
+ * @remarks Before 6.0, this function returns #MEDIA_STREAMER_ERROR_INVALID_STATE if @a streamer is not in the #MEDIA_STREAMER_STATE_IDLE state.\n
* Since 6.0, this is no longer required.
* @param[in] streamer Media streamer handle
* @param[in] node Media streamer node handle to be added
/**
* @brief Removes media streamer node from streamer.
* @since_tizen 3.0
- * @remarks To remove node without error posting, the state of streamer should be #MEDIA_STREAMER_STATE_IDLE.
+ * @remarks To remove node without error posting, the state of streamer should be #MEDIA_STREAMER_STATE_IDLE.\n
* If the node is linked, it will be unlinked before removing.
* @param[in] streamer Media streamer handle
* @param[in] node Media streamer node handle
/**
* @brief Links two media streamer nodes.
* @since_tizen 3.0
- * @remarks Pads are node's input and output, where you can connect other nodes.
- * (@a node1) - (@a node2)
- * @a node1 and @a node2 are determined relatively.
- * In case of (A)-(B)-(C),
- * (B) can be @a node2 with (A) or (B) can be @a node1 with (C).
- * However, source type node is always @a node1 and sink type node is always @a node2.
- * (A) is source type node and it should be @a node1.
+ * @remarks Pads are node's input and output, where you can connect other nodes.\n
+ * (@a node1) - (@a node2)\n
+ * @a node1 and @a node2 are determined relatively.\n
+ * In case of (A)-(B)-(C),\n
+ * (B) can be @a node2 with (A) or (B) can be @a node1 with (C).\n
+ * However, source type node is always @a node1 and sink type node is always @a node2.\n
+ * (A) is source type node and it should be @a node1.\n
* (C) is sink type node and it should be @a node2.
* @param[in] node1 Media streamer node handle which has the @a src_pad_name pad
* @param[in] src_pad_name The name of the source pad of the @a node1
/**
* @brief Gets name of node pads.
* @since_tizen 3.0
- * @remarks The @a src_pad_name and the @a sink_pad_name should be released using free().
- * src_pad_name or sink_pad_name can be null according to the node type.
- * In case of source type node, sink_pad_name will be null.
- * In case of sink type node, src_pad_name will be null.
+ * @remarks The @a src_pad_name and the @a sink_pad_name should be released using free().\n
+ * @a src_pad_name or @a sink_pad_name can be null according to the node type.\n
+ * In case of source type node, @a sink_pad_name will be null.\n
+ * In case of sink type node, @a 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
* @brief Sets parameters of node.
* @details Many parameters can be set at one time all together by using bundle.
* @since_tizen 3.0
- * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
+ * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.\n
* 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
/**
* @brief Gets node parameter list.
* @since_tizen 3.0
- * @remarks The @a param_list should be released using bundle_free().
+ * @remarks The @a param_list should be released using bundle_free().\n
* 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
* @brief Sets single parameter of node.
* @details Sets parameter one by one without creating param bundle.
* @since_tizen 3.0
- * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
+ * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.\n
* 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
projects / platform / core / api / mediastreamer.git / commitdiff