Change set_stream_info API name for consistency with other pkgs

[platform/core/api/audio-io.git] / include / audio_io.h

diff --git a/include/audio_io.h b/include/audio_io.h
index 47e6e62..ef82ef6 100644 (file)
--- a/include/audio_io.h
+++ b/include/audio_io.h
@@ -104,6 +104,7 @@ typedef enum {
        AUDIO_IO_ERROR_INVALID_OPERATION   = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */
        AUDIO_IO_ERROR_PERMISSION_DENIED   = TIZEN_ERROR_PERMISSION_DENIED, /**< Device open error by security */
        AUDIO_IO_ERROR_NOT_SUPPORTED       = TIZEN_ERROR_NOT_SUPPORTED,     /**< Not supported */
+       AUDIO_IO_ERROR_DEVICE_POLICY_RESTRICTION = TIZEN_ERROR_DEVICE_POLICY_RESTRICTION, /**< Device policy restriction (Since 3.0) */
        AUDIO_IO_ERROR_DEVICE_NOT_OPENED   = TIZEN_ERROR_AUDIO_IO | 0x01,   /**< Device open error */
        AUDIO_IO_ERROR_DEVICE_NOT_CLOSED   = TIZEN_ERROR_AUDIO_IO | 0x02,   /**< Device close error */
        AUDIO_IO_ERROR_INVALID_BUFFER      = TIZEN_ERROR_AUDIO_IO | 0x03,   /**< Invalid buffer pointer */
@@ -209,7 +210,7 @@ typedef void (*audio_in_state_changed_cb)(audio_in_h handle, audio_io_state_e pr
  * @retval #AUDIO_IO_ERROR_NOT_SUPPORTED Not supported
  *
  * @post The state will be #AUDIO_IO_STATE_IDLE.\n
- *       audio_in_set_stream_info() is recommended to be called after this API.
+ *       audio_in_set_sound_stream_info() is recommended to be called after this API.
  * @see audio_in_destroy()
  */
 int audio_in_create(int sample_rate, audio_channel_e channel, audio_sample_type_e type, audio_in_h *input);
@@ -242,7 +243,7 @@ int audio_in_create(int sample_rate, audio_channel_e channel, audio_sample_type_
  *
  * @see audio_in_destroy()
  */
-int audio_in_create_loopback(int sample_rate, audio_channel_e channel, audio_sample_type_e type , audio_in_h* input);
+int audio_in_create_loopback(int sample_rate, audio_channel_e channel, audio_sample_type_e type , audio_in_h* input) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Releases the audio input handle and all its resources associated with an audio stream.
@@ -286,6 +287,9 @@ int audio_in_destroy(audio_in_h input);
  * @see sound_manager_create_stream_information()
  * @see sound_manager_destroy_stream_information()
  */
+int audio_in_set_sound_stream_info(audio_in_h input, sound_stream_info_h stream_info);
+
+/* Note : Will be removed after migration to audio_in_set_sound_stream_info */
 int audio_in_set_stream_info(audio_in_h input, sound_stream_info_h stream_info);
 
 /**
@@ -299,6 +303,7 @@ int audio_in_set_stream_info(audio_in_h input, sound_stream_info_h stream_info);
  * @retval #AUDIO_IO_ERROR_NONE Successful
  * @retval #AUDIO_IO_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #AUDIO_IO_ERROR_NOT_SUPPORTED Not supported
+ * @retval #AUDIO_IO_ERROR_DEVICE_POLICY_RESTRICTION Device policy restriction
  * @retval #AUDIO_IO_ERROR_INVALID_STATE Invalid state
  *
  * @post The state will be #AUDIO_IO_STATE_RUNNING.
@@ -482,7 +487,7 @@ int audio_in_get_sample_type(audio_in_h input, audio_sample_type_e *type);
  * @see audio_in_unset_interrupted_cb()
  * @see audio_io_interrupted_cb()
  */
-int audio_in_set_interrupted_cb(audio_in_h input, audio_io_interrupted_cb callback, void *user_data);
+int audio_in_set_interrupted_cb(audio_in_h input, audio_io_interrupted_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
  * @deprecated Deprecated since 3.0
@@ -500,7 +505,7 @@ int audio_in_set_interrupted_cb(audio_in_h input, audio_io_interrupted_cb callba
  *
  * @see audio_in_set_interrupted_cb()
  */
-int audio_in_unset_interrupted_cb(audio_in_h input);
+int audio_in_unset_interrupted_cb(audio_in_h input) TIZEN_DEPRECATED_API;
 
 /**
  * @deprecated Deprecated since 3.0
@@ -516,7 +521,7 @@ int audio_in_unset_interrupted_cb(audio_in_h input);
  * @retval #AUDIO_IO_ERROR_INVALID_OPERATION Invalid operation
  * @retval #AUDIO_IO_ERROR_NOT_SUPPORTED Not supported
  */
-int audio_in_ignore_session(audio_in_h input);
+int audio_in_ignore_session(audio_in_h input) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Sets an asynchronous(event) callback function to handle recording PCM (pulse-code modulation) data.
@@ -711,7 +716,7 @@ typedef void (*audio_out_state_changed_cb)(audio_out_h handle, audio_io_state_e
  *
  * @see audio_out_destroy()
  */
-int audio_out_create(int sample_rate, audio_channel_e channel, audio_sample_type_e type, sound_type_e sound_type, audio_out_h *output);
+int audio_out_create(int sample_rate, audio_channel_e channel, audio_sample_type_e type, sound_type_e sound_type, audio_out_h *output) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Creates an audio device instance and returns an output handle to play PCM (pulse-code modulation) data.
@@ -721,7 +726,7 @@ int audio_out_create(int sample_rate, audio_channel_e channel, audio_sample_type
  * @since_tizen 3.0
  *
  * @remarks @a output must be released by audio_out_destroy().
- *          It is recommended to call audio_out_set_stream_info() after this API.
+ *          It is recommended to call audio_out_set_sound_stream_info() after this API.
  *
  * @param[in] sample_rate The audio sample rate in 8000[Hz] ~ 48000[Hz]
  * @param[in] channel The audio channel type (mono or stereo)
@@ -736,7 +741,7 @@ int audio_out_create(int sample_rate, audio_channel_e channel, audio_sample_type
  * @retval #AUDIO_IO_ERROR_SOUND_POLICY Sound policy error
  *
  * @post The state will be #AUDIO_IO_STATE_IDLE.\n
- *       audio_out_set_stream_info() is recommended to be called after this API.
+ *       audio_out_set_sound_stream_info() is recommended to be called after this API.
  * @see audio_out_destroy()
  */
 int audio_out_create_new(int sample_rate, audio_channel_e channel, audio_sample_type_e type, audio_out_h *output);
@@ -783,6 +788,9 @@ int audio_out_destroy(audio_out_h output);
  * @see sound_manager_create_stream_information()
  * @see sound_manager_destroy_stream_information()
  */
+int audio_out_set_sound_stream_info(audio_out_h output, sound_stream_info_h stream_info);
+
+/* Note : Will be removed after migration to audio_out_set_sound_stream_info */
 int audio_out_set_stream_info(audio_out_h output, sound_stream_info_h stream_info);
 
 /**
@@ -1003,7 +1011,7 @@ int audio_out_get_sound_type(audio_out_h output, sound_type_e *type);
  * @see audio_out_unset_interrupted_cb()
  * @see audio_io_interrupted_cb()
  */
-int audio_out_set_interrupted_cb(audio_out_h output, audio_io_interrupted_cb callback, void *user_data);
+int audio_out_set_interrupted_cb(audio_out_h output, audio_io_interrupted_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
  * @deprecated Deprecated since 3.0
@@ -1020,7 +1028,7 @@ int audio_out_set_interrupted_cb(audio_out_h output, audio_io_interrupted_cb cal
  *
  * @see audio_out_set_interrupted_cb()
  */
-int audio_out_unset_interrupted_cb(audio_out_h output);
+int audio_out_unset_interrupted_cb(audio_out_h output) TIZEN_DEPRECATED_API;
 
 /**
  * @deprecated Deprecated since 3.0
@@ -1035,7 +1043,7 @@ int audio_out_unset_interrupted_cb(audio_out_h output);
  * @retval #AUDIO_IO_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #AUDIO_IO_ERROR_INVALID_OPERATION Invalid operation
  */
-int audio_out_ignore_session(audio_out_h output);
+int audio_out_ignore_session(audio_out_h output) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Sets an asynchronous(event) callback function to handle playing PCM (pulse-code modulation) data.