Apply the checked header files.
authorEonseokLee <eonseok.lee@samsung.com>
Mon, 25 Mar 2013 12:20:11 +0000 (21:20 +0900)
committerEonseokLee <eonseok.lee@samsung.com>
Mon, 25 Mar 2013 12:20:11 +0000 (21:20 +0900)
Change-Id: I72143f122c7385288661588eb8bece0a054e1e17
Signed-off-by: EonseokLee <eonseok.lee@samsung.com>
inc/FMedia.h
inc/FMediaAudioEqualizer.h
inc/FMediaAudioIn.h
inc/FMediaAudioOut.h
inc/FMediaAudioStreamInfo.h
inc/FMediaIPlayerEventListener.h
inc/FMediaPlayer.h
inc/FMediaPlayerTypes.h
inc/FMediaTone.h

index 334a16c..9ece578 100755 (executable)
 #define _FMEDIA_H_
 
 // Include
-#include <FMediaAudioDecoder.h>
+#include "FMediaAudioDecoder.h"
 
-#include <FMediaAudioEncoder.h>
+#include "FMediaAudioEncoder.h"
 
-#include <FMediaAudioEqualizer.h>
+#include "FMediaAudioEqualizer.h"
 
-#include <FMediaAudioFrame.h>
+#include "FMediaAudioFrame.h"
 
-#include <FMediaAudioIn.h>
+#include "FMediaAudioIn.h"
 
-#include <FMediaAudioOut.h>
+#include "FMediaAudioOut.h"
 
-#include <FMediaAudioRecorder.h>
+#include "FMediaAudioRecorder.h"
 
-#include <FMediaAudioRouteInfo.h>
+#include "FMediaAudioRouteInfo.h"
 
-#include <FMediaAudioRouteManager.h>
+#include "FMediaAudioRouteManager.h"
 
-#include <FMediaCapability.h>
+#include "FMediaCapability.h"
 
-#include <FMediaCamera.h>
+#include "FMediaCamera.h"
 
-#include <FMediaGifDecoder.h>
+#include "FMediaGifDecoder.h"
 
-#include <FMediaIAudioStreamFilter.h>
+#include "FMediaIAudioStreamFilter.h"
 
-#include <FMediaImage.h>
+#include "FMediaImage.h"
 
-#include <FMediaImageBuffer.h>
+#include "FMediaImageBuffer.h"
 
-#include <FMediaImageUtil.h>
+#include "FMediaImageUtil.h"
 
-#include <FMediaIVideoStreamFilter.h>
+#include "FMediaIVideoStreamFilter.h"
 
-#include <FMediaMediaStreamInfo.h>
+#include "FMediaMediaStreamInfo.h"
 
-#include <FMediaPlayer.h>
+#include "FMediaPlayer.h"
 
-#include <FMediaTonePlayer.h>
+#include "FMediaTonePlayer.h"
 
-#include <FMediaTypes.h>
+#include "FMediaTypes.h"
 
-#include <FMediaVideoDecoder.h>
+#include "FMediaVideoDecoder.h"
 
-#include <FMediaVideoEncoder.h>
+#include "FMediaVideoEncoder.h"
 
-#include <FMediaVideoFrame.h>
+#include "FMediaVideoFrame.h"
 
-#include <FMediaVideoFrameExtractor.h>
+#include "FMediaVideoFrameExtractor.h"
 
-#include <FMediaVideoRecorder.h>
+#include "FMediaVideoRecorder.h"
 
 /**
  * @namespace  Tizen::Media
index 8f80b02..83615c3 100644 (file)
@@ -18,6 +18,7 @@
 /**
  * @file   FMediaAudioEqualizer.h
  * @brief  This is the header file for the %AudioEqualizer class.
+ *
  * This header file contains the declarations of the %AudioEqualizer class.
  */
 
@@ -205,8 +206,8 @@ public:
        * @return                       An error code
        * @param[in]            index                                           Index of the frequency band @n
        *                                                                                               Index starts from 0.
-       * @param[out]   minValue                                The minimum level of the frequency band specified by index
-       * @param[out]   maxValue                                The maximum level of the frequency band specified by index
+       * @param[out]   minValue                                The minimum level of the frequency band specified by @c index
+       * @param[out]   maxValue                                The maximum level of the frequency band specified by @c index
        * @exception            E_SUCCESS                                       The method is successful.
        * @exception            E_INVALID_ARG                           The specified input parameter is invalid.
        * @exception            E_INVALID_OPERATION             The associated audio instance is no longer valid.
@@ -215,7 +216,7 @@ public:
        result GetBandLevelRange(int index, int& minValue, int& maxValue) const;
 
        /**
-       * Sets the level of the frequency band specified by index.
+       * Sets the level of the frequency band specified by @c index.
        *
        * @since                2.0
        *
@@ -240,20 +241,20 @@ public:
        * @param[in]            pLevels                                         The pointer of the level array which has settings of all the frequency bands
        * @exception            E_SUCCESS                                       The method is successful.
     * @exception               E_OUT_OF_RANGE          The level values do not lie within minimum and maximum range of frequency bands.
-    * @exception       E_INVALID_ARG                           The specified input parameter is invalid. List is either empty or does not have level settings for all frequeny bands.
+    * @exception       E_INVALID_ARG                           The specified input parameter is invalid. List is either empty or does not have level settings for all frequency bands.
        * @exception            E_INVALID_OPERATION             The associated audio instance is no longer valid.
        */
        result SetAllBandsLevel(const Tizen::Base::Collection::IListT<int>* pLevels);
 
        /**
-       * Gets the level of frequency band specified by index.
+       * Gets the level of frequency band specified by @c index.
        *
        * @since                2.0
        *
        * @return               An error code
        * @param[in]            index                                   Index of the frequency band @n
        *                                                                                               Index starts from 0.
-       * @param[out]   level                                           The level of the frequency band specified by index
+       * @param[out]   level                                           The level of the frequency band specified by @c index
        * @exception            E_SUCCESS                                       The method is successful.
        * @exception            E_INVALID_ARG                   The specified input parameter is invalid.
        * @exception            E_INVALID_OPERATION             The associated audio instance is no longer valid.
@@ -268,7 +269,7 @@ public:
        * @return                       An error code
        * @param[in]            index                                   Index of the frequency band @n
        *                                                                                       Index starts from 0.
-       * @param[out]   frequency                               The center frequency in Hz of the frequency band specified by index
+       * @param[out]   frequency                               The center frequency in Hz of the frequency band specified by @c index
        * @exception            E_SUCCESS                               The method is successful.
        * @exception            E_INVALID_ARG                   The specified input parameter is invalid.
        * @exception            E_INVALID_OPERATION             The associated audio instance is no longer valid.
index b28c9f5..9d0bc9f 100644 (file)
@@ -212,7 +212,7 @@ public:
        *       @param[in]      audioInputDevice                                                An audio input device
        *       @param[in]      audioSampleType                                         The type of audio sample
        *       @param[in]      audioChannelType                                                The audio channel type
-       *       @param[in]      audioSampleRate                                         The audio sample rate in hertz (Hz)
+       *       @param[in]      audioSampleRate                                         The audio sample rate in Hertz (Hz)
        *       @exception      E_SUCCESS                                                               The method is successful.
        *       @exception      E_INVALID_STATE                                         This instance is in an invalid state for this method.
        *       @exception      E_SYSTEM                                                                A system error has occurred.
@@ -231,7 +231,7 @@ public:
        *       @return         An error code
        *       @param[in]      audioSampleType                                         The type of audio sample
        *       @param[in]      audioChannelType                                                The audio channel type
-       *       @param[in]      audioSampleRate                                         The audio sample rate in hertz (Hz)
+       *       @param[in]      audioSampleRate                                         The audio sample rate in Hertz (Hz)
        *       @exception      E_SUCCESS                                                                       The method is successful.
        *  @exception  E_DEVICE_FAILED                                          The device failed with unknown reason.
        *       @exception      E_INVALID_ARG                                                   A specified input parameter is invalid.
@@ -391,7 +391,7 @@ public:
        *
        *   @since              2.0
        *
-       *       @return         The sample rate in hertz (Hz)
+       *       @return         The sample rate in Hertz (Hz)
        *       @exception      E_SUCCESS                                               The method is successful.
        *       @exception      E_SYSTEM                                                        A system error has occurred.
        *       @remarks        The specific error code can be accessed using the GetLastResult() method.
index 272b8e1..9e70e4a 100644 (file)
@@ -201,7 +201,7 @@ public:
        * @return               An error code
        * @param[in]    audioSampleType                                 The type of the audio sample
        * @param[in]    audioChannelType                                        The type of the audio channel
-       * @param[in]    audioSampleRate                                 The audio sample rate in hertz (Hz)
+       * @param[in]    audioSampleRate                                 The audio sample rate in Hertz (Hz)
        * @exception    E_SUCCESS                                                                       The method is successful.
        * @exception    E_INVALID_STATE                                 This instance is in an invalid state for this method.
        * @exception    E_SYSTEM                                                                                A system error has occurred.
@@ -220,7 +220,7 @@ public:
        * @param[in]    audioStreamType                                 The type of the audio stream
        * @param[in]    audioSampleType                                 The type of the audio sample
        * @param[in]    audioChannelType                                        The type of the audio channel
-       * @param[in]    audioSampleRate                                 The audio sample rate in hertz (Hz)
+       * @param[in]    audioSampleRate                                 The audio sample rate in Hertz (Hz)
        * @exception    E_SUCCESS                                                               The method is successful.
        * @exception    E_INVALID_STATE                                 This instance is in an invalid state for this method.
        * @exception   E_DEVICE_FAILED                          The device failed with unknown reason.
@@ -378,7 +378,7 @@ public:
        *
        * @since                2.0
        *
-       * @return               The sample rate in hertz (Hz)
+       * @return               The sample rate in Hertz (Hz)
        * @exception    E_SUCCESS                                               The method is successful.
        * @exception    E_SYSTEM                                                        A system error has occurred.
        * @remarks              The specific error code can be accessed using the GetLastResult() method.
index 42a9c84..cb8d27a 100644 (file)
@@ -77,7 +77,7 @@ public:
        *
        * @since                2.0
        *
-       * @return                        The audio sampling rate in hertz (Hz)
+       * @return                        The audio sampling rate in Hertz (Hz)
        */
        int GetSampleRate(void) const;
 
@@ -136,7 +136,7 @@ private:
        *
        * @param [in]   codecType       The value of encoding type @n
        * @param [in]   bitrate         The audio bit rate in bits per second (bps) @n
-       * @param [in]   sampleRate      The audio sample rate in hertz (Hz) @n
+       * @param [in]   sampleRate      The audio sample rate in Hertz (Hz) @n
        * @param [in]   channel         The audio channel type @n
        */
        AudioStreamInfo(CodecType codecType, int bitrate, int sampleRate, AudioChannelType channel);
index acd6c0e..b190716 100644 (file)
@@ -67,12 +67,12 @@ public:
        *       @exception       E_SYSTEM                                                       A system error has occurred.
        *       @exception       E_CONNECTION_FAILED                            The network connection has failed.
        *       @exception       E_FILE_NOT_FOUND                  The file cannot be found or accessed.
-       *       @exception       E_UNSUPPORTED_FORMAT                           The given content format is not supported.
-       *       @exception       E_UNSUPPORTED_CODEC                                    The specified codec is not supported.
+       *   @exception   E_UNSUPPORTED_FORMAT                           The specified format is not supported.
+       *   @exception   E_UNSUPPORTED_CODEC                            The specified codec is not supported.
        *       @exception       E_OUT_OF_MEMORY                                        The memory is insufficient.
-       *       @exception      E_RIGHT_EXPIRED                                 The right is expired.
-       *       @exception      E_RIGHT_NO_LICENSE                              The right does not exist.
-       *       @exception      E_RIGHT_FUTURE_USE                              The right is for future use.
+       *       @exception      E_RIGHT_EXPIRED                                 The content right has expired.
+       *       @exception      E_RIGHT_NO_LICENSE                              The content has no license.
+       *       @exception      E_RIGHT_FUTURE_USE                              The content right is for future use.
        *       @see            Player::OpenFile()
        *       @see            Player::OpenUrl()
        *       @see            Player::OpenBuffer()
index c8257aa..fbc4ae2 100755 (executable)
@@ -351,12 +351,12 @@ public:
        * @exception    E_INVALID_STATE                 This instance is in an invalid state for this method.
        * @exception    E_SYSTEM                                                                A system error has occurred.
        * @exception    E_FILE_NOT_FOUND                        The specified file cannot be found or accessed.
-       * @exception    E_INVALID_DATA                          The specified file contains invalid data.
+       * @exception    E_INVALID_DATA          The specified file contains invalid data.
        * @exception    E_OUT_OF_MEMORY                 The memory is insufficient.
        * @exception    E_UNSUPPORTED_FORMAT                            The given content format is not supported.
-       * @exception    E_RIGHT_EXPIRED                                 The right is expired.
-       * @exception    E_RIGHT_NO_LICENSE                              The right does not exist.
-       * @exception    E_RIGHT_FUTURE_USE                              The right is for future use.
+       * @exception    E_RIGHT_EXPIRED                                 The content right has expired.
+       * @exception    E_RIGHT_NO_LICENSE                              The content has no license.
+       * @exception    E_RIGHT_FUTURE_USE                              The content right is for future use.
        * @see                          Close()
        */
        result OpenFile(const Tizen::Base::String& mediaLocalPath, bool isAsync = false);
@@ -379,9 +379,9 @@ public:
        * @exception    E_SYSTEM                                                                                A system error has occurred.
        * @exception    E_FILE_NOT_FOUND                                        The remote file cannot be found or accessed.
        * @exception    E_UNSUPPORTED_FORMAT                            The given content format is not supported.
-       * @exception    E_RIGHT_EXPIRED                                 The right is expired.
-       * @exception    E_RIGHT_NO_LICENSE                              The right does not exist.
-       * @exception    E_RIGHT_FUTURE_USE                              The right is for future use.
+       * @exception    E_RIGHT_EXPIRED                                 The content right has expired.
+       * @exception    E_RIGHT_NO_LICENSE                              The content has no license.
+       * @exception    E_RIGHT_FUTURE_USE                              The content right is for future use.
        * @remarks      This method is not thread-safe when @c isAsync is @c false.
        * @remarks      Input URL should be encoded if there are non-alphanumeric characters in URL.
        * @see                  Close()
@@ -403,12 +403,12 @@ public:
        * @exception    E_INVALID_STATE         This instance is in an invalid state for this method.
        * @exception    E_SYSTEM                                                                        A system error has occurred.
        * @exception    E_OBJ_NOT_FOUND                         The specified media buffer cannot be found.
-       * @exception    E_INVALID_DATA                                  The specified buffer contains invalid data.
+       * @exception    E_INVALID_DATA                     The specified buffer contains invalid data.
        * @exception    E_OUT_OF_MEMORY                         The memory is insufficient.
        * @exception    E_UNSUPPORTED_FORMAT                            The given content format is not supported.
-       * @exception    E_RIGHT_EXPIRED                                 The right is expired.
-       * @exception    E_RIGHT_NO_LICENSE                              The right does not exist.
-       * @exception    E_RIGHT_FUTURE_USE                              The right is for future use.
+       * @exception    E_RIGHT_EXPIRED                                 The content right has expired.
+       * @exception    E_RIGHT_NO_LICENSE                              The content has no license.
+       * @exception    E_RIGHT_FUTURE_USE                              The content right is for future use.
        * @see                          Close()
        */
        result OpenBuffer(const Tizen::Base::ByteBuffer& mediaBuffer, bool isAsync = false);
@@ -535,7 +535,7 @@ public:
        *                                                               This method returns E_INVALID_STATE, if this method is called again before
        *                                                                       IPlayerEventListener::OnPlayerSeekCompleted() is called.
        * @exception    E_OUT_OF_RANGE                          The specified time is out of range.
-       * @exception    E_INVALID_DATA                          The media data is inappropriate for seeking.
+       * @exception    E_INVALID_DATA          The media data is inappropriate for seeking.
        * @exception    E_SYSTEM                                                                A system error has occurred.
        * @remarks              For video, this method delivers one video frame on the specified position through the video
        *                               event. Before calling this method, the %Player instance must be created with the Construct()
@@ -555,7 +555,7 @@ public:
        * @exception            E_INVALID_STATE         This instance is in an invalid state for this method.
        * @remarks              The specific error code can be accessed using the GetLastResult() method. @n
        *                               While playing live streaming, this operation returns @c 0.
-       * @remarks           This method is valid in @c PLAYER_STATE_OPENED @c PLAYER_STATE_PLAYING @c PLAYER_STATE_PAUSED @c PLAYER_STATE_STOPPED player states
+       * @remarks           This method is valid in the @c PLAYER_STATE_OPENED @c PLAYER_STATE_PLAYING @c PLAYER_STATE_PAUSED @c PLAYER_STATE_STOPPED states of this instance.
        * @see                  GetPosition()
        */
        long GetDuration(void) const;
@@ -658,7 +658,7 @@ public:
        * @exception    E_SYSTEM            A system error has occurred.
        * @remarks       This method returns a stream information of the media, which is currently being opened.
        *               The specific error code can be accessed using the GetLastResult() method.
-       *               This method is valid in @c PLAYER_STATE_OPENED @c PLAYER_STATE_PLAYING @c PLAYER_STATE_PAUSED @c PLAYER_STATE_STOPPED player states
+       *               This method is valid in the @c PLAYER_STATE_OPENED @c PLAYER_STATE_PLAYING @c PLAYER_STATE_PAUSED @c PLAYER_STATE_STOPPED states of this instance.
        */
        MediaStreamInfo* GetCurrentMediaStreamInfoN(void) const;
 
index 2f1b098..61a7e0e 100644 (file)
@@ -72,9 +72,9 @@ enum PlayerErrorReason
        PLAYER_ERROR_SERVER,                    /**< The server has failed */
        PLAYER_ERROR_OUT_OF_MEMORY,             /**< The memory is insufficient*/
        PLAYER_ERROR_DEVICE_FAILED,             /**< The player device has failed */
-       PLAYER_ERROR_RIGHT_EXPIRED,                /**< The right has expired */
-       PLAYER_ERROR_RIGHT_NO_LICENSE,                  /**< The content has no right */
-       PLAYER_ERROR_RIGHT_FUTURE_USE,                  /**< The right is for future use */
+       PLAYER_ERROR_RIGHT_EXPIRED,                /**< The content right has expired */
+       PLAYER_ERROR_RIGHT_NO_LICENSE,                  /**< The content has no license */
+       PLAYER_ERROR_RIGHT_FUTURE_USE,                  /**< The content right is for future use */
 };
 
 }} // Tizen::Media
index 20f1171..888eec4 100644 (file)
@@ -80,9 +80,9 @@ public:
        *     @since            2.0
        *
        *       @return         An error code
-       *       @param[in]      firstFrequency                                  The first frequency of the dual tone in hertz (Hz) @n
+       *       @param[in]      firstFrequency                                  The first frequency of the dual tone in Hertz (Hz) @n
        *                                               The range of this parameter is @c 0 Hz to @c 15000 Hz.
-       *       @param[in]      secondFrequency                                 The second frequency of the dual tone in hertz (Hz) @n
+       *       @param[in]      secondFrequency                                 The second frequency of the dual tone in Hertz (Hz) @n
        *                                               The range of this parameter is @c 0 Hz to @c 15000 Hz.
        *       @param[in]      duration                                                The duration of the tone in milliseconds @n
        *                                               The value of this parameter must be greater than @c 0.
@@ -119,8 +119,8 @@ public:
        *   @since              2.0
        *
        *       @return         An error code
-       *       @param[out]     firstFrequency                                  The first frequency of the dual tone in hertz (Hz)
-       *       @param[out]     secondFrequency                                 The second frequency of the dual tone in hertz (Hz)
+       *       @param[out]     firstFrequency                                  The first frequency of the dual tone in Hertz (Hz)
+       *       @param[out]     secondFrequency                                 The second frequency of the dual tone in Hertz (Hz)
        *       @exception      E_SUCCESS                                               The method is successful.
        *       @remarks The specified input parameters of this method are @c -1 when an exception occurs.
        */
@@ -143,9 +143,9 @@ public:
        *
        *   @since              2.0
        *
-       *   @param[in]       firstFrequency    The first frequency of the dual tone in hertz (Hz) @n
+       *   @param[in]       firstFrequency    The first frequency of the dual tone in Hertz (Hz) @n
        *                                          The range of this parameter is @c 0 Hz to @c 15000 Hz.
-       *   @param[in]       secondFrequency   The second frequency of the dual tone in hertz (Hz) @n
+       *   @param[in]       secondFrequency   The second frequency of the dual tone in Hertz (Hz) @n
        *                                      The range of this parameter is @c 0 Hz to @c 15000 Hz.
        *   @param[in]       duration          The duration of the tone in milliseconds @n
        *                                          The value of this parameter must be greater than @c 0.