2 * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef __TIZEN_MEDIA_STREAMER_H__
18 #define __TIZEN_MEDIA_STREAMER_H__
22 #include <media_format.h>
23 #include <media_packet.h>
30 * @file media_streamer.h
31 * @brief This file contains the capi media streamer API.
35 * @addtogroup CAPI_MEDIA_STREAMER_MODULE
40 * @brief Media Streamer handle type.
44 typedef void *media_streamer_h;
47 * @brief Media Streamer node handle type.
51 typedef void *media_streamer_node_h;
54 * @brief Enumeration for media streamer node type.
59 MEDIA_STREAMER_NODE_TYPE_NONE, /**< Not defined type */
60 MEDIA_STREAMER_NODE_TYPE_SRC, /**< Source node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_src() */
61 MEDIA_STREAMER_NODE_TYPE_SINK, /**< Sink node type. Not available for media_streamer_node_create(). Use media_streamer_node_create_sink() */
62 MEDIA_STREAMER_NODE_TYPE_VIDEO_ENCODER, /**< Video encoder node type */
63 MEDIA_STREAMER_NODE_TYPE_VIDEO_DECODER, /**< Video decoder node type */
64 MEDIA_STREAMER_NODE_TYPE_AUDIO_ENCODER, /**< Audio encoder node type */
65 MEDIA_STREAMER_NODE_TYPE_AUDIO_DECODER, /**< Audio decoder node type */
66 MEDIA_STREAMER_NODE_TYPE_VIDEO_CONVERTER, /**< Video converter node type */
67 MEDIA_STREAMER_NODE_TYPE_AUDIO_CONVERTER, /**< Audio converter node type */
68 MEDIA_STREAMER_NODE_TYPE_AUDIO_RESAMPLE, /**< Audio resample node type */
69 MEDIA_STREAMER_NODE_TYPE_VIDEO_PAY, /**< RTP video payloader */
70 MEDIA_STREAMER_NODE_TYPE_AUDIO_PAY, /**< RTP audio payloader */
71 MEDIA_STREAMER_NODE_TYPE_VIDEO_DEPAY, /**< RTP video depayloader */
72 MEDIA_STREAMER_NODE_TYPE_AUDIO_DEPAY, /**< RTP audio depayloader */
73 MEDIA_STREAMER_NODE_TYPE_VIDEO_RATE, /**< Rate node type */
74 MEDIA_STREAMER_NODE_TYPE_VIDEO_SCALE, /**< Scale node type */
75 MEDIA_STREAMER_NODE_TYPE_TEXT_OVERLAY, /**< Overlay node type */
76 MEDIA_STREAMER_NODE_TYPE_PARSER, /**< Parser node type */
77 MEDIA_STREAMER_NODE_TYPE_FILTER, /**< Filter node type, to limit formats of data */
78 MEDIA_STREAMER_NODE_TYPE_TEE, /**< Tee node type, splits data to multiple path */
79 MEDIA_STREAMER_NODE_TYPE_QUEUE, /**< Queue node type */
80 MEDIA_STREAMER_NODE_TYPE_MQUEUE, /**< Multiple data queue node type */
81 MEDIA_STREAMER_NODE_TYPE_MUXER, /**< Muxer node type */
82 MEDIA_STREAMER_NODE_TYPE_DEMUXER, /**< Demuxer node type */
83 MEDIA_STREAMER_NODE_TYPE_RTP, /**< RTP component to send and receive data */
84 MEDIA_STREAMER_NODE_TYPE_INPUT_SELECTOR, /**< N-to-1 input stream selector */
85 MEDIA_STREAMER_NODE_TYPE_OUTPUT_SELECTOR, /**< 1-to-N output stream selector */
86 MEDIA_STREAMER_NODE_TYPE_INTERLEAVE, /**< Folds many mono channel into one interleaved audio stream */
87 MEDIA_STREAMER_NODE_TYPE_DEINTERLEAVE, /**< Splits multi channel audio into many mono audio */
88 MEDIA_STREAMER_NODE_TYPE_WEBRTC /**< WebRTC component to send and receive data */
89 } media_streamer_node_type_e;
92 * @brief Enumeration for media streamer source node type.
97 MEDIA_STREAMER_NODE_SRC_TYPE_NONE, /**< Not defined source type */
98 MEDIA_STREAMER_NODE_SRC_TYPE_FILE, /**< Local file source type */
99 MEDIA_STREAMER_NODE_SRC_TYPE_HTTP, /**< HTTP source type, Network internet feature is required */
100 MEDIA_STREAMER_NODE_SRC_TYPE_RTSP, /**< RTSP source type, Network internet feature is required */
101 MEDIA_STREAMER_NODE_SRC_TYPE_CAMERA, /**< Camera source type, Camera feature is required */
102 MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_CAPTURE, /**< Audio capture source type, Microphone feature is required */
103 MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_CAPTURE, /**< Video capture source type, Camera feature is required */
104 MEDIA_STREAMER_NODE_SRC_TYPE_AUDIO_TEST, /**< Audio test source type */
105 MEDIA_STREAMER_NODE_SRC_TYPE_VIDEO_TEST, /**< Video test source type */
106 MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM, /**< Custom source type */
107 MEDIA_STREAMER_NODE_SRC_TYPE_ADAPTIVE /**< Adaptive source type, Network internet feature is required */
108 } media_streamer_node_src_type_e;
111 * @brief Enumeration for media streamer sink node type.
116 MEDIA_STREAMER_NODE_SINK_TYPE_NONE, /**< Not defined sink type */
117 MEDIA_STREAMER_NODE_SINK_TYPE_FILE, /**< Local file sink type */
118 MEDIA_STREAMER_NODE_SINK_TYPE_RTSP, /**< RTSP sink type, Network internet feature is required */
119 MEDIA_STREAMER_NODE_SINK_TYPE_HTTP, /**< HTTP sink type, Network internet feature is required */
120 MEDIA_STREAMER_NODE_SINK_TYPE_AUDIO, /**< Audio sink type */
121 MEDIA_STREAMER_NODE_SINK_TYPE_OVERLAY,/**< Overlay sink type */
122 MEDIA_STREAMER_NODE_SINK_TYPE_FAKE, /**< Fake sink type */
123 MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM, /**< Custom sink type */
124 MEDIA_STREAMER_NODE_SINK_TYPE_ADAPTIVE /**< Adaptive sink type to generate fragmented files */
125 } media_streamer_node_sink_type_e;
128 * @brief Enumeration for media streamer state.
133 MEDIA_STREAMER_STATE_NONE, /**< Streamer is not created */
134 MEDIA_STREAMER_STATE_IDLE, /**< Streamer is created but not prepared */
135 MEDIA_STREAMER_STATE_READY, /**< Streamer is ready to play */
136 MEDIA_STREAMER_STATE_PLAYING, /**< Streamer is playing */
137 MEDIA_STREAMER_STATE_PAUSED, /**< Streamer is paused */
138 MEDIA_STREAMER_STATE_SEEKING /**< Seek is under operation */
139 } media_streamer_state_e;
142 * @brief Enumeration for media streamer error.
147 MEDIA_STREAMER_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
148 MEDIA_STREAMER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
149 MEDIA_STREAMER_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */
150 MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< No space left on the device */
151 MEDIA_STREAMER_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< The feature is not supported */
152 MEDIA_STREAMER_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
153 MEDIA_STREAMER_ERROR_INVALID_STATE = TIZEN_ERROR_MEDIA_STREAMER | 0x01, /**< Invalid state */
154 MEDIA_STREAMER_ERROR_CONNECTION_FAILED = TIZEN_ERROR_MEDIA_STREAMER | 0x02, /**< Connection failed */
155 MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT = TIZEN_ERROR_MEDIA_STREAMER | 0x03, /**< Resource conflict */
156 MEDIA_STREAMER_ERROR_SEEK_FAILED = TIZEN_ERROR_MEDIA_STREAMER | 0x04, /**< Seek operation failure */
157 } media_streamer_error_e;
160 * @brief Enumeration for media streamer buffer status of custom source.
165 MEDIA_STREAMER_CUSTOM_BUFFER_UNDERRUN, /**< Buffer underrun of custom source */
166 MEDIA_STREAMER_CUSTOM_BUFFER_OVERFLOW, /**< Buffer overflow of custom source */
167 } media_streamer_custom_buffer_status_e;
170 * @brief Enumeration for media streamer's interruption type.
175 MEDIA_STREAMER_INTERRUPTED_BY_RESOURCE_CONFLICT, /**< Interrupted by a resource conflict */
176 MEDIA_STREAMER_INTERRUPTED_BY_SECURITY, /**< Interrupted by a security policy */
177 } media_streamer_interrupted_code_e;
180 * @brief Definition for camera-id parameter of source node.
181 * @details Index number of camera to activate.
182 * Data type is integer and default value is 0.
184 * @see media_streamer_node_get_params()
186 #define MEDIA_STREAMER_PARAM_CAMERA_ID "camera-id"
189 * @brief Definition for capture-width parameter of source node.
190 * @details Width for camera size to capture.
191 * Data type is integer and default value is 1600.
193 * @see media_streamer_node_get_params()
195 #define MEDIA_STREAMER_PARAM_CAPTURE_WIDTH "capture-width"
198 * @brief Definition for capture-height parameter of source node.
199 * @details Height for camera size to capture.
200 * Data type is integer and default value is 1200.
202 * @see media_streamer_node_get_params()
204 #define MEDIA_STREAMER_PARAM_CAPTURE_HEIGHT "capture-height"
207 * @brief Definition for is-live parameter of source node.
208 * @details Whether to act as a live source.
209 * Data type is boolean and default value is false.
211 * @see media_streamer_node_get_params()
213 #define MEDIA_STREAMER_PARAM_IS_LIVE_STREAM "is-live"
216 * @brief Definition for uri parameter of source node.
217 * @details URI to read from
218 * Data type is string.
220 * @see media_streamer_node_get_params()
222 #define MEDIA_STREAMER_PARAM_URI "uri"
225 * @brief Definition for user-agent parameter of source node.
226 * @details Value of the User-Agent HTTP request header field.
227 * Data type is string.
229 * @see media_streamer_node_get_params()
231 #define MEDIA_STREAMER_PARAM_USER_AGENT "user-agent"
234 * @brief Definition for stream type parameter of source node.
235 * @details The type of the push data stream.
236 * 0:stream, 1:seekable, 2:random-access (default:0)
238 * @see media_streamer_node_get_params()
240 #define MEDIA_STREAMER_PARAM_STREAM_TYPE "stream-type"
243 * @brief Definition for port parameter of source or sink node.
244 * @details The port to receive the packets from.
245 * Data type is integer and default value is 5004.
247 * @see media_streamer_node_get_params()
249 #define MEDIA_STREAMER_PARAM_PORT "port"
252 * @brief Definition for video port parameter of source node.
253 * @details The port to receive the video packets from.
254 * Data type is integer.
256 * @see media_streamer_node_get_params()
258 #define MEDIA_STREAMER_PARAM_VIDEO_IN_PORT "video_in_port"
261 * @brief Definition for audio port parameter of source node.
262 * @details The port to receive the audio packets from.
263 * Data type is integer.
265 * @see media_streamer_node_get_params()
267 #define MEDIA_STREAMER_PARAM_AUDIO_IN_PORT "audio_in_port"
270 * @brief Definition for video port parameter of sink node.
271 * @details The port to send the video packets to.
272 * Data type is integer.
274 * @see media_streamer_node_get_params()
276 #define MEDIA_STREAMER_PARAM_VIDEO_OUT_PORT "video_out_port"
279 * @brief Definition for audio port parameter of sink node.
280 * @details The port to send the audio packets to.
281 * Data type is integer.
283 * @see media_streamer_node_get_params()
285 #define MEDIA_STREAMER_PARAM_AUDIO_OUT_PORT "audio_out_port"
288 * @brief Definition for IP address parameter of source node.
289 * @details IP address to send/receive packets for.
290 * Data type is string and default value is "0.0.0.0".
292 * @see media_streamer_node_get_params()
294 #define MEDIA_STREAMER_PARAM_IP_ADDRESS "address"
297 * @brief Definition for the peer type of WebRTC node.
298 * @details The type of WebRTC peer, it can be "answer" or "offer".
299 * Data type is string and default value is "answer".
301 * @see media_streamer_node_get_params()
303 #define MEDIA_STREAMER_PARAM_WEBRTC_PEER_TYPE "webrtc-peer-type"
306 * @brief Definition for remote session description.
307 * @details Value of the session description of the remote peer over its signaling channel
308 * Data type is string.
310 * @see media_streamer_node_get_params() */
311 #define MEDIA_STREAMER_PARAM_WEBRTC_REMOTE_SESSION_DESCRIPTION "webrtc-remote-session-description"
314 * @brief Definition for ICE candidate of WebRTC node.
315 * @details Value of ICE candidate of the remote peer over its signaling channel
316 * Data type is string.
318 * @see media_streamer_node_get_params() */
319 #define MEDIA_STREAMER_PARAM_WEBRTC_ADD_ICE_CANDIDATE "webrtc-add-ice-candidate"
322 * @brief Definition for audio device name parameter of source or sink node.
323 * @details ALSA device, as defined in an asound configuration file.
324 * ex) "hw:0,0", "hw:0,1"
325 * Data type is string and default value is "default".
327 * @see media_streamer_node_get_params()
329 #define MEDIA_STREAMER_PARAM_AUDIO_DEVICE "audio_device"
332 * @brief Definition for sync parameter of sink node.
333 * @details Synchronize on the clock
334 * Data type is boolean and default value is true.
336 * @see media_streamer_node_get_params()
338 #define MEDIA_STREAMER_PARAM_CLOCK_SYNCHRONIZED "sync"
341 * @brief Definition for rotate parameter of sink node.
342 * @details Rotate angle of display output.
343 * 0:none/1:rotate 90 degree/2:rotate 180 degree/3:rotate 270 degree
344 * Default value is 3(rotate 270 degree).
346 * @see media_streamer_node_get_params()
348 #define MEDIA_STREAMER_PARAM_ROTATE "rotate"
351 * @brief Definition for flip parameter of sink node.
352 * @details Flip for display.
353 * 0:none, 1:horizontal, 2:vertical, 3:both
354 * Default value is 0.
356 * @see media_streamer_node_get_params()
358 #define MEDIA_STREAMER_PARAM_FLIP "flip"
361 * @brief Definition for display geometry method parameter of sink node.
362 * @details Geometrical method for display.
366 * 3:Cropped full screen
367 * 4:Original size if surface size is larger than video size(width/height),
368 * or Letter box if video size(width/height) is larger than surface size.
370 * Default value is 0(Letter box).
372 * @see media_streamer_node_get_params()
374 #define MEDIA_STREAMER_PARAM_DISPLAY_GEOMETRY_METHOD "display-geometry-method"
377 * @brief Definition for display parameter of sink node.
378 * @details It is a object to draw video frame on.
379 * Data type is pointer.
381 * @see media_streamer_node_get_params()
383 #define MEDIA_STREAMER_PARAM_DISPLAY "display"
386 * @brief Definition for visible parameter of sink node.
387 * @details Draws screen or blacks out.
388 * Data type is boolean and default value is true(visible).
390 * @see media_streamer_node_get_params()
392 #define MEDIA_STREAMER_PARAM_VISIBLE "visible"
395 * @brief Definition for use-tbm parameter of sink node.
396 * @details Use Tizen Buffer Memory instead of Shared Memory.
397 * The sink node must receive the tbm-buffer created by the previous node.
398 * The value is changeable only in the #MEDIA_STREAMER_STATE_IDLE state.
399 * Data type is boolean and default value is false.
401 * @see media_streamer_node_get_params()
403 #define MEDIA_STREAMER_PARAM_USE_TBM "use-tbm"
406 * @brief Definition for host parameter of sink node.
407 * @details The host/IP/Multicast group to send the packets to.
408 * Data type is string and default value is "localhost".
410 * @see media_streamer_node_get_params()
412 #define MEDIA_STREAMER_PARAM_HOST "host"
415 * @brief Definition for segment location parameter of adaptive sink node.
416 * @details Path for writing playlist from
417 * Data type is string.
419 * @see media_streamer_node_get_params()
421 #define MEDIA_STREAMER_PARAM_SEGMENT_LOCATION "location"
424 * @brief Definition for playlist location parameter of adaptive sink node.
425 * @details Path for writing playlist from. Data type is string.
427 * @see media_streamer_node_get_params()
429 #define MEDIA_STREAMER_PARAM_PLAYLIST_LOCATION "playlist-location"
432 * @brief Called when error occurs in media streamer.
434 * @remarks Following error codes can be delivered.
435 * #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
436 * #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
437 * #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
438 * #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
439 * #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
440 * @param[in] streamer Media streamer handle
441 * @param[in] error The error that occurred in media steamer
442 * @param[in] user_data The user data passed from the code where
443 * media_streamer_set_error_cb() was invoked
444 * This data will be accessible from media_streamer_error_cb()
445 * @pre Create media streamer handle by calling media_streamer_create().
446 * @see media_streamer_set_error_cb()
447 * @see media_streamer_unset_error_cb()
449 typedef void (*media_streamer_error_cb)(media_streamer_h streamer,
450 media_streamer_error_e error, void *user_data);
453 * @brief Called when media streamer state is changed.
455 * @param[in] streamer Media streamer handle
456 * @param[in] previous_state The previous state of the media streamer
457 * @param[in] current_state The current state of media streamer
458 * @param[in] user_data The user data passed from the code where
459 * media_streamer_set_state_changed_cb() was invoked
460 * This data will be accessible from media_streamer_state_changed_cb()
461 * @pre Create media streamer handle by calling media_streamer_create().
462 * @see media_streamer_set_state_change_cb()
463 * @see media_streamer_unset_state_change_cb()
465 typedef void (*media_streamer_state_changed_cb)(media_streamer_h streamer,
466 media_streamer_state_e previous_state, media_streamer_state_e current_state, void *user_data);
469 * @brief Called when the custom source needs more data or has enough data.
470 * @details This callback will be invoked when the buffer level drops below the threshold of max size
471 * or no free space in custom source buffer.
473 * @remarks Callback can be applied only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
474 * @param[in] src Media streamer source node handle
475 * @param[in] status Media streamer custom buffer status
476 * @param[in] user_data The user data passed from the callback registration function
477 * @see media_streamer_src_set_buffer_status_cb()
478 * @see media_streamer_node_get_param()
479 * @see media_streamer_node_set_param()
481 typedef void (*media_streamer_custom_buffer_status_cb)(media_streamer_node_h src,
482 media_streamer_custom_buffer_status_e status, void *user_data);
485 * @brief Called when new data is available from custom sink.
486 * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
488 * @param[in] sink Media streamer sink node handle
489 * @param[in] user_data The user data passed from the code where
490 * media_streamer_sink_set_data_ready_cb() was invoked
491 * This data will be accessible from media_streamer_sink_data_ready_cb()
492 * @pre media_streamer_sink_set_data_ready_cb()
493 * @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
494 * @see media_streamer_sink_set_data_ready_cb()
495 * @see media_streamer_sink_unset_data_ready_cb()
497 typedef void (*media_streamer_sink_data_ready_cb)(media_streamer_node_h sink, void *user_data);
500 * @brief Called when the end-of-stream has been reached.
501 * @details This callback can be applied only to #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
503 * @param[in] sink Media streamer sink node handle
504 * @param[in] user_data The user data passed from the code where
505 * media_streamer_sink_set_eos_cb() was invoked
506 * This data will be accessible from media_streamer_sink_eos_cb()
507 * @pre media_streamer_sink_set_eos_cb()
508 * @see MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
509 * @see media_streamer_sink_set_eos_cb()
510 * @see media_streamer_sink_unset_eos_cb()
512 typedef void (*media_streamer_sink_eos_cb)(media_streamer_node_h sink, void *user_data);
515 * @brief Called when the seek operation is completed.
517 * @param[in] user_data The user data passed from the callback registration function
518 * @see media_streamer_set_play_position()
520 typedef void (*media_streamer_position_changed_cb)(void *user_data);
523 * @brief Called when the media streamer is interrupted.
525 * @param[in] code The interrupted error code
526 * @param[in] user_data The user data passed from the callback registration function
527 * @see media_streamer_set_interrupted_cb()
528 * @see media_streamer_unset_interrupted_cb()
530 typedef void (*media_streamer_interrupted_cb)(media_streamer_interrupted_code_e code, void *user_data);
533 * @brief Called when the media streamer node is ready for decoded data.
535 * @param[in] webrtc Media streamer node handle
536 * @param[in] src_pad_name The source pad name that can give decoded data to another one
537 * @param[in] media_type The media type of the data from the given source pad such as 'video/x-raw', 'audio/x-raw', and so on
538 * @param[in] user_data The user data passed from the callback registration function
539 * @see media_streamer_node_set_decoded_ready_cb()
540 * @see media_streamer_node_link()
541 * @see media_streamer_node_unset_decoded_ready_cb()
543 typedef void (*media_streamer_node_decoded_ready_cb)(media_streamer_node_h node, const char *src_pad_name, const char *media_type, void *user_data);
546 * @brief Called when the media streamer WebRTC node needs to send the message to the remote peer of WebRTC connection.
548 * @remarks Two types will be delivered with @ message which is JSON string.
549 * One is for the remote session description and the other is for a new ICE candidate.
550 * For the remote session description, @ message will be {"sdp":{"type":"offer or answer","sdp":"..."}}.
551 * For the new ICE candidate, @ message will be {"ice":{"candidate":"..."}}.
552 * @param[in] webrtc Media streamer WebRTC node handle
553 * @param[in] message The message to be passed to the remote peer over the signaling channel
554 * @param[in] user_data The user data passed from the callback registration function
555 * @see media_streamer_webrtc_node_set_message_cb()
556 * @see media_streamer_webrtc_node_unset_message_cb()
558 typedef void (*media_streamer_webrtc_message_cb)(media_streamer_node_h webrtc, const char *message, void *user_data);
561 * @brief Sets a error callback function to be invoked when an error occurs.
562 * @details Following error codes can be delivered by error callback.
563 * #MEDIA_STREAMER_ERROR_INVALID_OPERATION,
564 * #MEDIA_STREAMER_ERROR_FILE_NO_SPACE_ON_DEVICE,
565 * #MEDIA_STREAMER_ERROR_NOT_SUPPORTED,
566 * #MEDIA_STREAMER_ERROR_CONNECTION_FAILED,
567 * #MEDIA_STREAMER_ERROR_RESOURCE_CONFLICT
569 * @param[in] streamer Media streamer handle
570 * @param[in] callback Callback function pointer
571 * @param[in] user_data The user data passed from the code where
572 * media_streamer_set_error_cb() was invoked
573 * This data will be accessible from media_streamer_error_cb()
574 * @return @c 0 on success,
575 * otherwise a negative error value
576 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
577 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
578 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
579 * @pre Create a media streamer handle by calling media_streamer_create().
580 * @post media_streamer_error_cb() will be invoked.
581 * @see media_streamer_unset_error_cb()
582 * @see media_streamer_error_cb()
584 int media_streamer_set_error_cb(media_streamer_h streamer, media_streamer_error_cb callback, void *user_data);
587 * @brief Unsets the error callback function.
589 * @param[in] streamer Media streamer handle
590 * @return @c 0 on success,
591 * otherwise a negative error value
592 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
593 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
594 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
595 * @see media_streamer_error_cb()
597 int media_streamer_unset_error_cb(media_streamer_h streamer);
600 * @brief Sets a callback that will be triggered after media streamer state is changed.
602 * @param[in] streamer Media streamer handle
603 * @param[in] callback Callback function pointer
604 * @param[in] user_data The user data passed from the code
605 * where media_streamer_set_state_change_cb() was invoked
606 * This data will be accessible from media_streamer_state_changed_cb()
607 * @return @c 0 on success,
608 * otherwise a negative error value
609 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
610 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
611 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
612 * @pre Create a media streamer handle by calling media_streamer_create().
613 * @post media_streamer_state_changed_cb() will be invoked.
614 * @see media_streamer_unset_state_change_cb()
615 * @see media_streamer_state_changed_cb()
617 int media_streamer_set_state_change_cb(media_streamer_h streamer, media_streamer_state_changed_cb callback, void *user_data);
620 * @brief Unsets the state changed callback function.
622 * @param[in] streamer Media streamer handle
623 * @return @c 0 on success,
624 * otherwise a negative error value
625 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
626 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
627 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
628 * @see media_streamer_set_state_change_cb()
630 int media_streamer_unset_state_change_cb(media_streamer_h streamer);
633 * @brief Sets a callback function to be invoked when the media streamer is interrupted.
635 * @param[in] streamer Media streamer handle
636 * @param[in] callback The callback function to register
637 * @param[in] user_data The user data to be passed to the callback function
638 * @return @c 0 on success,
639 * otherwise a negative error value
640 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
641 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
642 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
643 * @post media_streamer_interrupted_cb() will be invoked.
644 * @see media_streamer_unset_interrupted_cb()
645 * @see #media_streamer_interrupted_code_e
647 int media_streamer_set_interrupted_cb(media_streamer_h streamer, media_streamer_interrupted_cb callback, void *user_data);
650 * @brief Unsets the callback function.
652 * @param[in] streamer Media streamer handle
653 * @return @c 0 on success,
654 * otherwise a negative error value
655 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
656 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
657 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
658 * @see media_streamer_set_interrupted_cb()
660 int media_streamer_unset_interrupted_cb(media_streamer_h streamer);
663 * @brief Sets a callback function to be invoked when buffer underrun or overflow is occurred.
664 * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM source type
666 * @remarks This function is used for media stream playback only.
667 * @param[in] src Media streamer source node handle
668 * @param[in] callback The buffer status callback function to register
669 * @param[in] user_data The user data passed from the code where
670 * media_streamer_src_set_buffer_status_cb() was invoked
671 * This data will be accessible from media_streamer_custom_buffer_status_cb()
672 * @return @c 0 on success,
673 * otherwise a negative error value
674 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
675 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
676 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
677 * @pre Create a media streamer source node handle by calling media_streamer_node_create_src().
678 * @pre Add created media streamer source node to media streamer by calling media_streamer_node_add().
679 * @post media_streamer_custom_buffer_status_cb() will be invoked.
680 * @see media_streamer_src_unset_buffer_status_cb()
681 * @see media_streamer_custom_buffer_status_cb()
683 int media_streamer_src_set_buffer_status_cb(media_streamer_node_h src, media_streamer_custom_buffer_status_cb callback, void *user_data);
686 * @brief Unsets the source buffer status callback function.
688 * @param[in] src Media streamer source node handle
689 * @return @c 0 on success,
690 * otherwise a negative error value
691 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
692 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
693 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
694 * @see media_streamer_src_set_buffer_status_cb()
696 int media_streamer_src_unset_buffer_status_cb(media_streamer_node_h src);
699 * @brief Sets a callback function to be called when the custom sink is ready for data processing.
700 * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM sink type
702 * @param[in] sink Media streamer sink node handle
703 * @param[in] callback Callback function pointer
704 * @param[in] user_data The user data passed from the code where
705 * media_streamer_sink_set_data_ready_cb() was invoked
706 * This data will be accessible from media_streamer_sink_data_ready_cb()
707 * @return @c 0 on success,
708 * otherwise a negative error value
709 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
710 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
711 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
712 * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink().
713 * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add().
714 * @post media_streamer_sink_data_ready_cb() will be invoked.
715 * @see media_streamer_sink_unset_data_ready_cb()
716 * @see media_streamer_sink_data_ready_cb()
718 int media_streamer_sink_set_data_ready_cb(media_streamer_node_h sink, media_streamer_sink_data_ready_cb callback, void *user_data);
721 * @brief Unsets the sink data ready callback function.
723 * @param[in] sink Media streamer sink node handle
724 * @return @c 0 on success,
725 * otherwise a negative error value
726 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
727 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
728 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
729 * @see media_streamer_sink_set_data_ready_cb()
731 int media_streamer_sink_unset_data_ready_cb(media_streamer_node_h sink);
734 * @brief Sets a callback function to be called when custom sink detect the end-of-stream.
736 * @param[in] sink Media streamer sink node handle
737 * @param[in] callback Callback function pointer
738 * @param[in] user_data The user data passed from the code where
739 * media_streamer_sink_set_eos_cb() was invoked.
740 * This data will be accessible from media_streamer_sink_eos_cb()
741 * @return @c 0 on success,
742 * otherwise a negative error value
743 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
744 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
745 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
746 * @pre Create a media streamer sink handle by calling media_streamer_node_create_sink().
747 * @pre Add created media streamer sink node to media streamer by calling media_streamer_node_add().
748 * @post media_streamer_sink_eos_cb() will be invoked.
749 * @see media_streamer_sink_unset_eos_cb()
750 * @see media_streamer_sink_eos_cb()
752 int media_streamer_sink_set_eos_cb(media_streamer_node_h sink, media_streamer_sink_eos_cb callback, void *user_data);
755 * @brief Unsets the sink end-of-stream callback function.
757 * @param[in] sink Media streamer sink node handle
758 * @return @c 0 on success,
759 * otherwise a negative error value
760 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
761 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
762 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
763 * @see media_streamer_sink_set_eos_cb()
765 int media_streamer_sink_unset_eos_cb(media_streamer_node_h sink);
768 * @brief Creates an instance of media streamer and
769 * passes the handle to the caller.
771 * @remarks You must release @a streamer using media_streamer_destroy()
772 * @param[out] streamer Media streamer handle
773 * @return @c 0 on success,
774 * otherwise a negative error value
775 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
776 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
777 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
778 * @post The media streamer state will be #MEDIA_STREAMER_STATE_IDLE.
779 * @see media_streamer_destroy()
781 int media_streamer_create(media_streamer_h *streamer);
784 * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_READY.
786 * @param[in] streamer Media streamer handle
787 * @return @c 0 on success,
788 * otherwise a negative error value
789 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
790 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
791 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
792 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
793 * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE
794 * by calling media_streamer_create() or media_streamer_unprepare().
795 * @pre At least one source and one sink should be added and linked in the streamer
796 * by calling media_streamer_node_create_src(), media_streamer_node_create_sink() and media_streamer_node_link().
797 * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
798 * @see media_streamer_unprepare()
799 * @see media_streamer_create()
801 int media_streamer_prepare(media_streamer_h streamer);
804 * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_IDLE.
805 * @details The most recently used media is reset and no longer associated with the media streamer.
807 * @param[in] streamer Media streamer handle
808 * @return @c 0 on success,
809 * otherwise a negative error value
810 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
811 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
812 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
813 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
814 * @pre The media streamer state should be higher than #MEDIA_STREAMER_STATE_IDLE.
815 * @post The media streamer state will be #MEDIA_STREAMER_STATE_IDLE.
816 * @see media_streamer_prepare()
818 int media_streamer_unprepare(media_streamer_h streamer);
821 * @brief Sets media streamer state to #MEDIA_STREAMER_STATE_PLAYING.
822 * @details Start running the current streamer, or resumes it if paused.
824 * @param[in] streamer Media streamer handle
825 * @return @c 0 on success,
826 * otherwise a negative error value
827 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
828 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
829 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
830 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
831 * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_READY by calling media_streamer_prepare() or
832 * set to #MEDIA_STREAMER_STATE_PAUSED by calling media_streamer_pause().
833 * @post The media streamer state will be #MEDIA_STREAMER_STATE_PLAYING.
834 * @see media_streamer_create()
835 * @see media_streamer_pause()
836 * @see media_streamer_stop()
838 int media_streamer_play(media_streamer_h streamer);
841 * @brief Pauses the media streamer.
843 * @param[in] streamer Media streamer handle
844 * @return @c 0 on success,
845 * otherwise a negative error value
846 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
847 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
848 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
849 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
850 * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING.
851 * @post The media streamer state will be #MEDIA_STREAMER_STATE_PAUSED.
852 * @see media_streamer_create()
853 * @see media_streamer_play()
855 int media_streamer_pause(media_streamer_h streamer);
858 * @brief Stops the media streamer.
860 * @param[in] streamer Media streamer handle
861 * @return @c 0 on success,
862 * otherwise a negative error value
863 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
864 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
865 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
866 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
867 * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_PLAYING by calling media_streamer_play() or
868 * set to #MEDIA_STREAMER_STATE_PAUSED by calling media_streamer_pause().
869 * @post The media streamer state will be #MEDIA_STREAMER_STATE_READY.
870 * @see media_streamer_create()
871 * @see media_streamer_play()
872 * @see media_streamer_pause()
874 int media_streamer_stop(media_streamer_h streamer);
877 * @brief Destroys media streamer.
879 * @remarks Nodes in streamer will be removed automatically.
880 * Don't need to remove nodes by calling media_streamer_node_remove().
881 * If you want to change the node without destroying streamer handle,
882 * you can call the media_streamer_node_remove().
883 * after setting the streamer state to #MEDIA_STREAMER_STATE_IDLE state.
884 * @param[in] streamer Media streamer handle
885 * @return @c 0 on success,
886 * otherwise a negative error value
887 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
888 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
889 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
890 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
891 * @pre Create a media streamer handle by calling media_streamer_create().
892 * @post The media streamer state will be #MEDIA_STREAMER_STATE_NONE.
893 * @see media_streamer_create()
895 int media_streamer_destroy(media_streamer_h streamer);
898 * @brief Changes playback position to the defined time value, asynchronously.
900 * @param[in] streamer Media streamer handle
901 * @param[in] time Time in millisecond
902 * @param[in] accurate If @c true, it will seek to the accurate position, but this might be considerably slower for some formats,
903 * otherwise @c false, it will seek to the nearest keyframe
904 * @param[in] callback The callback function to register
905 * @param[in] user_data The user data to be passed to the callback function
906 * @return @c 0 on success,
907 * otherwise a negative error value
908 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
909 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
910 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
911 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
912 * @retval #MEDIA_STREAMER_ERROR_SEEK_FAILED Seek operation failure
913 * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
914 * @post It invokes media_streamer_set_play_position() when seek operation completes, if you set a callback.
915 * @see media_streamer_get_play_position()
917 int media_streamer_set_play_position(media_streamer_h streamer, int time,
918 bool accurate, media_streamer_position_changed_cb callback, void *user_data);
921 * @brief Gets the current position in milliseconds.
923 * @param[in] streamer Media streamer handle
924 * @param[out] time The current position in milliseconds
925 * @return @c 0 on success,
926 * otherwise a negative error value
927 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
928 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
929 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
930 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
931 * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
932 * @see media_streamer_set_play_position()
934 int media_streamer_get_play_position(media_streamer_h streamer, int *time);
937 * @brief Gets the total running time of the associated media.
939 * @remarks The streamer's source node type should be #MEDIA_STREAMER_NODE_SRC_TYPE_FILE or #MEDIA_STREAMER_NODE_SRC_TYPE_HTTP.
940 * If not, return value will be #MEDIA_STREAMER_ERROR_NONE and duration will be -1.
941 * @param[in] streamer Media streamer handle
942 * @param[out] duration The duration in milliseconds
943 * @return @c 0 on success,
944 * otherwise a negative error value
945 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
946 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
947 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
948 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
949 * @pre The media streamer state must be one of these: #MEDIA_STREAMER_STATE_PAUSED, or #MEDIA_STREAMER_STATE_PLAYING.
951 int media_streamer_get_duration(media_streamer_h streamer, int *duration);
954 * @brief Gets media streamer state.
956 * @param[in] streamer Media streamer handle
957 * @param[out] state Media streamer state
958 * @return @c 0 on success,
959 * otherwise a negative error value
960 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
961 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
962 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
963 * @pre Create a media streamer handle by calling media_streamer_create().
964 * @see #media_streamer_state_e
966 int media_streamer_get_state(media_streamer_h streamer, media_streamer_state_e *state);
969 * @brief Creates media streamer source node.
971 * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to play from network.
972 * The camera privilege(%http://tizen.org/privilege/camera) should be added if the source node handles the camera device.
973 * The recorder privilege(%http://tizen.org/privilege/recorder) should be added if the source node handles the recorder device.
974 * You can release source node using media_streamer_node_destroy().
975 * @param[in] type Media streamer source node type
976 * @param[out] src Media streamer source node handle
977 * @return @c 0 on success,
978 * otherwise a negative error value
979 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
980 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
981 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
982 * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
983 * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
984 * @see #media_streamer_node_src_type_e
985 * @see media_streamer_node_destroy()
987 int media_streamer_node_create_src(media_streamer_node_src_type_e type, media_streamer_node_h *src);
990 * @brief Pushes packet into custom source node.
991 * @details This function can be called only for #MEDIA_STREAMER_NODE_SRC_TYPE_CUSTOM.
993 * @param[in] src Media streamer source node handle
994 * @param[in] packet Media packet handle
995 * @return @c 0 on success,
996 * otherwise a negative error value
997 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
998 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
999 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1000 * @pre Create a source node handle by calling media_streamer_node_create_src().
1001 * @pre The media streamer state must be set to #MEDIA_STREAMER_STATE_IDLE at least.
1002 * @see #media_packet_h
1004 int media_streamer_node_push_packet(media_streamer_node_h src, media_packet_h packet);
1007 * @brief Creates media streamer sink node.
1009 * @remarks The internet privilege(%http://tizen.org/privilege/internet) should be added if any URIs are used to transmit the output data.
1010 * You can release @a sink node using media_streamer_node_destroy()
1011 * @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.
1012 * The application must have an authentication responsibility between a server and client because the data transmission is not secure.
1013 * @param[in] type Type of sink node to be created
1014 * @param[out] sink Media streamer sink node handle
1015 * @return @c 0 on success,
1016 * otherwise a negative error value
1017 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1018 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1019 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1020 * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
1021 * @retval #MEDIA_STREAMER_ERROR_NOT_SUPPORTED Not supported
1022 * @see #media_streamer_node_sink_type_e
1023 * @see media_streamer_node_destroy()
1025 int media_streamer_node_create_sink(media_streamer_node_sink_type_e type, media_streamer_node_h *sink);
1028 * @brief Pulls packet from custom sink node.
1029 * @details This function can be called only for #MEDIA_STREAMER_NODE_SINK_TYPE_CUSTOM
1031 * @param[in] sink Media streamer sink node handle
1032 * @param[out] packet Media packet handle
1033 * @return @c 0 on success,
1034 * otherwise a negative error value
1035 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1036 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1037 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1038 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1039 * @pre Create a sink node handle by calling media_streamer_node_create_sink().
1040 * @pre Set media_streamer_sink_data_ready_cb by calling media_streamer_sink_set_data_ready_cb().
1041 * @see #media_packet_h
1042 * @see media_streamer_node_create_sink()
1044 int media_streamer_node_pull_packet(media_streamer_node_h sink, media_packet_h *packet);
1047 * @brief Creates media streamer node except #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
1048 * @details Creates node specific @a type with specific format of input
1051 * @remarks The node type should not be #MEDIA_STREAMER_NODE_TYPE_SRC and #MEDIA_STREAMER_NODE_TYPE_SINK.
1052 * To create source / sink type node, media_streamer_node_create_src() / media_streamer_node_create_sink() should be called.
1053 * You can release @a node using media_streamer_node_destroy().
1054 * @param[in] type Created node type
1055 * @param[in] in_fmt Media format handle for input data
1056 * @param[in] out_fmt Media format handle for output data
1057 * @param[out] node Media streamer node handle to be created
1058 * @return @c 0 on success,
1059 * otherwise a negative error value
1060 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1061 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1062 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1063 * @see #media_streamer_node_type_e
1064 * @see #media_format_h
1065 * @see media_streamer_node_destroy()
1067 int media_streamer_node_create(media_streamer_node_type_e type, media_format_h in_fmt,
1068 media_format_h out_fmt, media_streamer_node_h *node);
1071 * @brief Adds node to media streamer.
1073 * @param[in] streamer Media streamer handle
1074 * @param[in] node Media streamer node handle to be added
1075 * @return @c 0 on success,
1076 * otherwise a negative error value
1077 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1078 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1079 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1080 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1081 * @pre Create media streamer handle by calling media_streamer_create().
1082 * @pre Create node handle by calling media_streamer_node_create().
1083 * @see media_streamer_create()
1084 * @see media_streamer_node_create()
1085 * @see media_streamer_node_create_src()
1086 * @see media_streamer_node_create_sink()
1088 int media_streamer_node_add(media_streamer_h streamer, media_streamer_node_h node);
1091 * @brief Destroys media streamer node.
1093 * @param[in] node Media streamer node handle
1094 * @return @c 0 on success,
1095 * otherwise a negative error value
1096 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1097 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1098 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1099 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1100 * @pre Create node handle by calling media_streamer_node_create().
1101 * @pre If the node was added to media streamer, it has to be removed by calling media_streamer_node_remove().
1102 * @see media_streamer_node_create()
1103 * @see media_streamer_node_create_src()
1104 * @see media_streamer_node_create_sink()
1105 * @see media_streamer_node_remove()
1107 int media_streamer_node_destroy(media_streamer_node_h node);
1110 * @brief Removes media streamer node from streamer.
1112 * @remarks To remove node without error posting, the state of streamer should be #MEDIA_STREAMER_STATE_IDLE.
1113 * If the node is linked, it will be unlinked before removing.
1114 * @param[in] streamer Media streamer handle
1115 * @param[in] node Media streamer node handle
1116 * @return @c 0 on success,
1117 * otherwise a negative error value
1118 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1119 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1120 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1121 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1122 * @pre Add node to streamer by calling media_streamer_node_add().
1123 * @see media_streamer_node_add()
1125 int media_streamer_node_remove(media_streamer_h streamer, media_streamer_node_h node);
1128 * @brief Links two media streamer nodes.
1130 * @remarks Pads are node's input and output, where you can connect other nodes.
1131 * (@a node1) - (@a node2)
1132 * @a node1 and @a node2 are determined relatively.
1133 * In case of (A)-(B)-(C),
1134 * (B) can be @a node2 with (A) or (B) can be @a node1 with (C).
1135 * However, source type node is always @a node1 and sink type node is always @a node2.
1136 * (A) is source type node and it should be @a node1.
1137 * (C) is sink type node and it should be @a node2.
1138 * @param[in] node1 Media streamer node handle which has the @a src_pad_name pad
1139 * @param[in] src_pad_name The name of the source pad of the @a node1
1140 * @param[in] node2 Media streamer node handle which has the @a sink_pad_name pad
1141 * @param[in] sink_pad_name The name of the sink pad of the @a node2
1142 * @return @c 0 on success,
1143 * otherwise a negative error value
1144 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1145 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1146 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1147 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1148 * @pre Create node handles by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1149 * And add the nodes into streamer by calling media_streamer_node_add().
1150 * @see media_streamer_node_create()
1151 * @see media_streamer_node_create_src()
1152 * @see media_streamer_node_create_sink()
1153 * @see media_streamer_node_add()
1155 int media_streamer_node_link(media_streamer_node_h node1, const char *src_pad_name,
1156 media_streamer_node_h node2, const char *sink_pad_name);
1159 * @brief Sets media format for pad of media streamer node.
1161 * @param[in] node Media streamer node handle
1162 * @param[in] pad_name Pad name
1163 * @param[in] fmt Media format handle
1164 * @return @c 0 on success,
1165 * otherwise a negative error value
1166 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1167 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1168 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1169 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1170 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1171 * @pre Get pad name by calling media_streamer_node_get_pad_name().
1172 * @see #media_format_h
1174 int media_streamer_node_set_pad_format(media_streamer_node_h node, const char *pad_name, media_format_h fmt);
1177 * @brief Gets media format for pad of media streamer node.
1179 * @param[in] node Media streamer node handle
1180 * @param[in] pad_name Pad name
1181 * @param[out] fmt Media format handle
1182 * @return @c 0 on success,
1183 * otherwise a negative error value
1184 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1185 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1186 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1187 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1188 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1189 * @pre Get pad name by calling media_streamer_node_get_pad_name().
1190 * @see #media_format_h
1192 int media_streamer_node_get_pad_format(media_streamer_node_h node, const char *pad_name, media_format_h *fmt);
1195 * @brief Gets name of node pads.
1197 * @remarks After using the src_pad_name and sink_pad_name, it has to be freed.
1198 * src_pad_name or sink_pad_name can be null according to the node type.
1199 * In case of source type node, sink_pad_name will be null.
1200 * In case of sink type node, src_pad_name will be null.
1201 * @param[in] node Media streamer node handle
1202 * @param[out] src_pad_name Array of source pad name
1203 * @param[out] src_pad_num The number of source pads
1204 * @param[out] sink_pad_name Array of sink pad name
1205 * @param[out] sink_pad_num The number of sink pads
1206 * @return @c 0 on success,
1207 * otherwise a negative error value
1208 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1209 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1210 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1211 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1212 * @see media_streamer_node_create()
1213 * @see media_streamer_node_create_src()
1214 * @see media_streamer_node_create_sink()
1216 int media_streamer_node_get_pad_name(media_streamer_node_h node, char ***src_pad_name,
1217 int *src_pad_num, char ***sink_pad_name, int *sink_pad_num);
1220 * @brief Sets parameters of node.
1221 * @details Many parameters can be set at one time all together by using bundle.
1223 * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
1224 * The externalstorage privilege(%http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
1225 * @param[in] node Media streamer node handle
1226 * @param[in] param_list Key value array of media streamer node parameters
1227 * @return @c 0 on success,
1228 * otherwise a negative error value
1229 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1230 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1231 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1232 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1233 * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
1234 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1235 * @pre Get param list to set by calling media_streamer_node_get_params().
1236 * @see media_streamer_node_create()
1237 * @see media_streamer_node_create_src()
1238 * @see media_streamer_node_create_sink()
1239 * @see media_streamer_node_get_params()
1241 int media_streamer_node_set_params(media_streamer_node_h node, bundle *param_list);
1243 * @brief Gets node parameter list.
1245 * @remarks After using param_list, it has to be freed by calling bundle_free() in bundle.h
1246 * Refer to the "Parameter information of node" in this file to get info.
1247 * @param[in] node Media streamer node handle
1248 * @param[out] param_list Key value array of media streamer node parameters
1249 * @return @c 0 on success,
1250 * otherwise a negative error value
1251 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1252 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1253 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1254 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1255 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1256 * @post Set params which are needed to set by calling media_streamer_node_set_params() or media_streamer_node_set_param().
1257 * @see media_streamer_node_create()
1258 * @see media_streamer_node_create_src()
1259 * @see media_streamer_node_create_sink()
1260 * @see media_streamer_node_set_params()
1261 * @see media_streamer_node_set_param()
1263 int media_streamer_node_get_params(media_streamer_node_h node, bundle **param_list);
1266 * @brief Sets single parameter of node.
1267 * @details Sets parameter one by one without creating param bundle.
1269 * @remarks The mediastorage privilege(%http://tizen.org/privilege/mediastorage) should be added if any video/audio files are written in the internal storage devices.
1270 * The externalstorage privilege(%http://tizen.org/privilege/externalstorage) should be added if any video/audio files are written in the external storage devices.
1271 * @param[in] node Media streamer node handle
1272 * @param[in] param_name Param name of node
1273 * @param[in] param_value Param value of node
1274 * @return @c 0 on success,
1275 * otherwise a negative error value
1276 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1277 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1278 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1279 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1280 * @retval #MEDIA_STREAMER_ERROR_PERMISSION_DENIED Permission denied
1281 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1282 * @pre Get param list to set by calling media_streamer_node_get_params().
1283 * @see media_streamer_node_create()
1284 * @see media_streamer_node_create_src()
1285 * @see media_streamer_node_create_sink()
1286 * @see media_streamer_node_get_params()
1287 * @see media_streamer_node_get_param()
1289 int media_streamer_node_set_param(media_streamer_node_h node,
1290 const char *param_name, const char *param_value);
1293 * @brief Gets value of parameter.
1294 * @details Gets parameter one by one without creating param bundle.
1296 * @param[in] node Media streamer node handle
1297 * @param[in] param_name Param name of node
1298 * @param[out] param_value Param value of node
1299 * @return @c 0 on success,
1300 * otherwise a negative error value
1301 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1302 * @retval #MEDIA_STREAMER_ERROR_INVALID_STATE Invalid state
1303 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1304 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1305 * @pre Create a node handle by calling media_streamer_node_create(), media_streamer_node_create_src(), or media_streamer_node_create_sink().
1306 * @pre Get param list to know the param name by calling media_streamer_node_get_params().
1307 * @see media_streamer_node_create()
1308 * @see media_streamer_node_create_src()
1309 * @see media_streamer_node_create_sink()
1310 * @see media_streamer_node_get_params()
1311 * @see media_streamer_node_set_param()
1313 int media_streamer_node_get_param(media_streamer_node_h node,
1314 const char *param_name, char **param_value);
1317 * @brief Sets a callback function to be invoked when a source pad of @ node is ready to give decoded data.
1318 * @remarks The available type of @a node for this function is #MEDIA_STREAMER_NODE_TYPE_WEBRTC.
1320 * @param[in] node Media streamer node handle
1321 * @param[in] callback The decoded ready callback function to register
1322 * @param[in] user_data The user data to be passed to the callback function
1323 * @return @c 0 on success,
1324 * otherwise a negative error value
1325 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1326 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1327 * @retval #MEDIA_STREAMER_ERROR_INVALID_OPERATION Invalid operation
1328 * @pre Create a media streamer node handle by calling media_streamer_node_create().
1329 * @post media_streamer_node_decoded_ready_cb() will be invoked.
1330 * @see media_streamer_node_unset_decoded_ready_cb()
1331 * @see media_streamer_node_decoded_ready_cb()
1333 int media_streamer_node_set_decoded_ready_cb(media_streamer_node_h node, media_streamer_node_decoded_ready_cb callback, void *user_data);
1336 * @brief Unsets the decoded ready callback function.
1338 * @param[in] node Media streamer node handle
1339 * @return @c 0 on success,
1340 * otherwise a negative error value
1341 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1342 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1343 * @see media_streamer_node_set_decoded_ready_cb()
1345 int media_streamer_node_unset_decoded_ready_cb(media_streamer_node_h node);
1348 * @brief Sets a callback function to be invoked when WebRTC node needs to send the message to the remote peer of WebRTC connection.
1349 * @details This function can be called only for #MEDIA_STREAMER_NODE_TYPE_WEBRTC type.
1351 * @param[in] webrtc Media streamer WebRTC node handle
1352 * @param[in] callback The WebRTC message callback function to register
1353 * @param[in] user_data The user data to be passed to the callback function
1354 * @return @c 0 on success,
1355 * otherwise a negative error value
1356 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1357 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1358 * @pre Create a media streamer WebRTC node handle by calling media_streamer_node_create().
1359 * @post media_streamer_webrtc_message_cb() will be invoked.
1360 * @see media_streamer_webrtc_node_unset_message_cb()
1361 * @see media_streamer_webrtc_message_cb()
1363 int media_streamer_webrtc_node_set_message_cb(media_streamer_node_h webrtc, media_streamer_webrtc_message_cb callback, void *user_data);
1366 * @brief Unsets the webrtc message callback function.
1368 * @param[in] src Media streamer WebRTC node handle
1369 * @return @c 0 on success,
1370 * otherwise a negative error value
1371 * @retval #MEDIA_STREAMER_ERROR_NONE Successful
1372 * @retval #MEDIA_STREAMER_ERROR_INVALID_PARAMETER Invalid parameter
1373 * @see media_streamer_webrtc_node_set_message_cb()
1375 int media_streamer_webrtc_node_unset_message_cb(media_streamer_node_h webrtc);
1385 #endif /* __TIZEN_MEDIA_STREAMER_H__ */