From: EonseokLee Date: Fri, 19 Apr 2013 02:36:11 +0000 (+0900) Subject: Apply the checked header files X-Git-Tag: accepted/tizen_2.1/20130425.034734~5 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f822bd59fed0df7bc5221a9fd740444797b98db7;p=framework%2Fosp%2Fmedia.git Apply the checked header files Change-Id: Ifc4d57b5e1c5e306bff7ab5d00b48793d5a555f0 Signed-off-by: EonseokLee --- diff --git a/inc/FMediaAudioEqualizer.h b/inc/FMediaAudioEqualizer.h index 83615c3..8e2a4e5 100644 --- a/inc/FMediaAudioEqualizer.h +++ b/inc/FMediaAudioEqualizer.h @@ -152,13 +152,11 @@ class _OSP_EXPORT_ AudioEqualizer { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to - * initialize this instance. - * @see Construct() */ AudioEqualizer(void); @@ -181,7 +179,7 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_UNSUPPORTED_OPERATION This device does not support the audio equalizer feature. - * @remarks If player is deleted, then this instance cannot be used properly. + * @remarks If @c player is deleted, then this instance cannot be used properly. */ result Construct(Player& player); diff --git a/inc/FMediaAudioIn.h b/inc/FMediaAudioIn.h index 9d0bc9f..5680f18 100644 --- a/inc/FMediaAudioIn.h +++ b/inc/FMediaAudioIn.h @@ -161,11 +161,11 @@ class _OSP_EXPORT_ AudioIn { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ AudioIn(void); @@ -307,7 +307,7 @@ public: /** * Resets using the audio input device without returning buffers to the caller. @n * All pending and current buffers are released immediately without any notifications. - * The state is changed to @c AUDIOIN_STATE_PREPARED. + * The state is changed to ::AUDIOIN_STATE_PREPARED. * * @since 2.0 * @@ -341,8 +341,9 @@ public: * @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. - * @remarks The return value is available after calling the Prepare() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The return value is available after calling the Prepare() method. + * - The specific error code can be accessed using the GetLastResult() method. */ int GetMaxBufferSize(void) const; @@ -357,8 +358,9 @@ public: * @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. - * @remarks The return value is available after calling the Prepare() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The return value is available after calling the Prepare() method. + * - The specific error code can be accessed using the GetLastResult() method. */ int GetMinBufferSize(void) const; diff --git a/inc/FMediaAudioManagerTypes.h b/inc/FMediaAudioManagerTypes.h index db1a6ca..c7e3d4f 100644 --- a/inc/FMediaAudioManagerTypes.h +++ b/inc/FMediaAudioManagerTypes.h @@ -55,7 +55,7 @@ enum OutputAudioDevice OUTPUT_AUDIO_DEVICE_NONE, /**< No output audio device */ OUTPUT_AUDIO_DEVICE_SPEAKER, /**< The speaker */ OUTPUT_AUDIO_DEVICE_RECEIVER, /**< The receiver */ - OUTPUT_AUDIO_DEVICE_WIRED_ACCESSORY, /**< The wired accessory such as earjack, headphone or headset*/ + OUTPUT_AUDIO_DEVICE_WIRED_ACCESSORY, /**< The wired accessory such as ear jack, headphone, or headset*/ OUTPUT_AUDIO_DEVICE_BT_SCO, /**< The bluetooth(SCO) */ OUTPUT_AUDIO_DEVICE_BT_A2DP, /**< The bluetooth(A2DP) */ OUTPUT_AUDIO_DEVICE_DOCK, /**DOCK device*/ diff --git a/inc/FMediaAudioOut.h b/inc/FMediaAudioOut.h index 9e70e4a..37b5536 100644 --- a/inc/FMediaAudioOut.h +++ b/inc/FMediaAudioOut.h @@ -163,7 +163,6 @@ public: * * @since 2.0 * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. */ AudioOut(void); @@ -294,7 +293,7 @@ public: /** * Resets the audio output device. @n * All pending and current data buffers in the queue are removed immediately without any notification. The - * state is changed to @c AUDIOOUT_STATE_PREPARED. + * state is changed to ::AUDIOOUT_STATE_PREPARED. * * @since 2.0 * @@ -328,8 +327,9 @@ public: * @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. - * @remarks The return value is available after calling the Prepare() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The return value is available after calling the Prepare() method. + * - The specific error code can be accessed using the GetLastResult() method. */ int GetMaxBufferSize(void) const; @@ -344,8 +344,9 @@ public: * @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. - * @remarks The return value is available after calling the Prepare() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The return value is available after calling the Prepare() method. + * - The specific error code can be accessed using the GetLastResult() method. */ int GetMinBufferSize(void) const; @@ -411,8 +412,9 @@ public: * This return value ranges from @c 0 to @c 100. * @exception E_SUCCESS The method is successful. * @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. - * @remarks This method must be called after calling the Prepare() method. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - This method must be called after calling the Prepare() method. * @see SetVolume() */ int GetVolume(void) const; diff --git a/inc/FMediaAudioRouteManager.h b/inc/FMediaAudioRouteManager.h index 7a69b40..679cb43 100755 --- a/inc/FMediaAudioRouteManager.h +++ b/inc/FMediaAudioRouteManager.h @@ -216,8 +216,9 @@ public: * @return An active audio stream type * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks @c AUDIO_STREAM_TYPE_NO_SOUND is returned when no sound is playing. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - @c AUDIO_STREAM_TYPE_NO_SOUND is returned when no sound is playing. */ AudioStreamType GetActiveAudioStreamType(void) const; @@ -234,8 +235,9 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient to make the list. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The item type of returned list is AudioRouteInfo. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The item type of returned list is AudioRouteInfo. */ Tizen::Base::Collection::IList* GetAvailableAudioRouteListN(void) const; @@ -285,8 +287,9 @@ public: * @return The active audio route * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks @c INPUT_AUDIO_DEVICE_NONE and @c OUTPUT_AUDIO_DEVICE_NONE are set in AudioRouteInfo if this method fails. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - ::INPUT_AUDIO_DEVICE_NONE and ::OUTPUT_AUDIO_DEVICE_NONE are set in AudioRouteInfo if this method fails. */ AudioRouteInfo GetActiveAudioRoute(void) const; diff --git a/inc/FMediaIAudioInEventListener.h b/inc/FMediaIAudioInEventListener.h index 22f357a..ff9517a 100644 --- a/inc/FMediaIAudioInEventListener.h +++ b/inc/FMediaIAudioInEventListener.h @@ -85,9 +85,11 @@ public: * Called when an audio recording focus is changed to another application. * * @since 2.0 - * @remarks After the audio focus is being changed, the recording is stopped and the state of this instance is changed to @c AUDIOIN_STATE_STOPPED. - * @remarks User interaction with the device is required for an application in @c AUDIOIN_STATE_STOPPED state to resume recording. This is to avoid the occurrence of a race condition among applications that try to resume without user interaction. - * @remarks An application cannot start recording again even in the state of AUDIOIN_STATE_STOPPED due to other applications which have a higher priority. + * @remarks + * - After the audio focus is being changed, the recording is stopped and the state of this instance is changed to ::AUDIOIN_STATE_STOPPED. + * - User interaction with the device is required for an application in @c AUDIOIN_STATE_STOPPED state to resume recording. + * This is to avoid the occurrence of a race condition among applications that try to resume without user interaction. + * - An application cannot start recording again even in the state of @c AUDIOIN_STATE_STOPPED due to other applications which have a higher priority. */ virtual void OnAudioInAudioFocusChanged(void) {} diff --git a/inc/FMediaIAudioOutEventListener.h b/inc/FMediaIAudioOutEventListener.h index 09a26a9..f3d41c9 100644 --- a/inc/FMediaIAudioOutEventListener.h +++ b/inc/FMediaIAudioOutEventListener.h @@ -87,9 +87,11 @@ public: * @since 2.0 * * @param[in] src An instance of AudioOut that fires the event - * @remarks After the audio focus is being changed, the playback is stopped and the state of this instance is changed to @c AUDIOOUT_STATE_STOPPED. - * @remarks User interaction with the device is required for an application in @c AUDIOOUT_STATE_STOPPED state to resume playing. This is to avoid the occurrence of a race condition among applications that try to start without user interaction. - * @remarks An application cannot start playback again even in the state of AUDIOOUT_STATE_STOPPED due to other applications which have a higher priority. + * @remarks + * - After the audio focus is being changed, the playback is stopped and the state of this instance is changed to ::AUDIOOUT_STATE_STOPPED. + * - User interaction with the device is required for an application in @c AUDIOOUT_STATE_STOPPED state to resume playing. + * This is to avoid the occurrence of a race condition among applications that try to start without user interaction. + * - An application cannot start playback again even in the state of @c AUDIOOUT_STATE_STOPPED due to other applications which have a higher priority. */ virtual void OnAudioOutAudioFocusChanged(Tizen::Media::AudioOut& src) {} protected: diff --git a/inc/FMediaIPlayerEventListener.h b/inc/FMediaIPlayerEventListener.h index b190716..d0ff521 100644 --- a/inc/FMediaIPlayerEventListener.h +++ b/inc/FMediaIPlayerEventListener.h @@ -116,9 +116,10 @@ public: * @since 2.0 * * @param[in] r A player error reason of type ::PlayerErrorReason - * @remarks While playing streaming media, the player might throw an error like ::PLAYER_ERROR_CONNECTION_LOST, - * ::PLAYER_ERROR_STREAMING_TIMEOUT, ::PLAYER_ERROR_TRANSPORT, or ::PLAYER_ERROR_SERVER. @n - * If the content includes invalid data, ::PLAYER_ERROR_INVALID_DATA may occur. + * @remarks + * - While playing streaming media, the player might throw an error like ::PLAYER_ERROR_CONNECTION_LOST, + * ::PLAYER_ERROR_STREAMING_TIMEOUT, ::PLAYER_ERROR_TRANSPORT, or ::PLAYER_ERROR_SERVER. + * - If the content includes invalid data, ::PLAYER_ERROR_INVALID_DATA may occur. * @see PlayerErrorReason */ virtual void OnPlayerErrorOccurred(Tizen::Media::PlayerErrorReason r) = 0; @@ -141,9 +142,11 @@ public: * Called when an audio playback focus is changed to another application. * * @since 2.0 - * @remarks After the audio focus is being changed, the playback is paused or stopped and the state of this instance is changed to @c PLAYER_STATE_PAUSED or @c PLAYER_STATE_CLOSED. - * @remarks User interaction with the device is required for an application in @c PLAYER_STATE_PAUSED state to resume playing. This is to avoid the occurrence of a race condition among applications that try to play without user interaction. - * @remarks An application can not play again even in the state of PLAYER_STATE_PAUSED due to the application which has a higher priority. + * @remarks + * - After the audio focus is being changed, the playback is paused or stopped and the state of this instance is changed to ::PLAYER_STATE_PAUSED or ::PLAYER_STATE_CLOSED. + * - User interaction with the device is required for an application in @c PLAYER_STATE_PAUSED state to resume playing. + * This is to avoid the occurrence of a race condition among applications that try to play without user interaction. + * - An application can not play again even in the state of @c PLAYER_STATE_PAUSED due to the application which has a higher priority. */ virtual void OnPlayerAudioFocusChanged(void) {} protected: diff --git a/inc/FMediaITonePlayerEventListener.h b/inc/FMediaITonePlayerEventListener.h index e74c26f..334474d 100644 --- a/inc/FMediaITonePlayerEventListener.h +++ b/inc/FMediaITonePlayerEventListener.h @@ -98,9 +98,11 @@ public: * @since 2.0 * * @param[in] src An instance of TonePlayer that fires the event - * @remarks After the audio focus is being changed, the playback is paused and the state of this instance is changed to @c TONE_PLAYER_STATE_PAUSED. - * @remarks User interaction with the device is required for an application in @c TONE_PLAYER_STATE_PAUSED state to resume playing. This is to avoid the occurrence of a race condition among applications that try to play without user interaction. - * @remarks An application cannot start playback again even in the state of TONE_PLAYER_STATE_PAUSED due to other applications which have a higher priority. + * @remarks + * - After the audio focus is being changed, the playback is paused and the state of this instance is changed to ::TONE_PLAYER_STATE_PAUSED. + * - User interaction with the device is required for an application in @c TONE_PLAYER_STATE_PAUSED state to resume playing. + * This is to avoid the occurrence of a race condition among applications that try to play without user interaction. + * - An application cannot start playback again even in the state of @c TONE_PLAYER_STATE_PAUSED due to other applications which have a higher priority. */ virtual void OnTonePlayerAudioFocusChanged(Tizen::Media::TonePlayer& src) {} diff --git a/inc/FMediaPlayer.h b/inc/FMediaPlayer.h index 255c0bf..28e0a6f 100755 --- a/inc/FMediaPlayer.h +++ b/inc/FMediaPlayer.h @@ -295,8 +295,6 @@ public: * * @since 2.0 * - * @remarks After creating an instance of this class, the Construct() method must be called explicitly to - * initialize this instance. */ Player(void); @@ -307,7 +305,6 @@ public: * * @since 2.0 * - * @see Construct() */ virtual ~Player(void); @@ -384,9 +381,10 @@ public: * @exception E_RIGHT_NO_LICENSE The content has no license. * @exception E_RIGHT_FUTURE_USE The content right is for future use. * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1 - * @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() + * @remarks + * - This method is not thread-safe when @c isAsync is @c false. + * - Input URL should be encoded if there are non-alphanumeric characters in URL. + * @see Close() */ result OpenUrl(const Tizen::Base::Utility::Uri& mediaUri, bool isAsync = false); @@ -447,10 +445,10 @@ public: * @exception E_UNSUPPORTED_CODEC The specified codec is not supported. * @exception E_SYSTEM A system error has occurred. @n * If playback has been paused, it resumes from the last position. @n - * E_SYSTEM is returned when unsupported format or codec media data are received during streaming. @n - * E_SYSTEM is returned when the unsupport resolution is set for rendering . + * @c E_SYSTEM is returned when unsupported format or codec media data are received during streaming. @n + * @c E_SYSTEM is returned when the unsupport resolution is set for rendering . * @remarks When this method is called after the %Player instance is created with the Construct() method that accepts the IPlayVideoEventListener - * interface as a parameter, it delivers every video frame of a video content continuously until the state is changed to @c PLAYER_STATE_ENDOFCLIP, + * interface as a parameter, it delivers every video frame of a video content continuously until the state is changed to ::PLAYER_STATE_ENDOFCLIP, * or the Stop() or Pause() method is called . * @see Stop() * @see Pause() @@ -515,8 +513,8 @@ public: * @exception E_SUCCESS The method is successful. * @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. - * - This method returns -1 when the method failed. + * - The specific error code can be accessed using the GetLastResult() method. + * - This method returns @c -1 when the method fails. * @see SeekTo() */ long GetPosition(void) const; @@ -525,7 +523,7 @@ public: * Seeks the current playback position of the audio or video content to the specified time. @n * The %SeekTo() method works asynchronously. @n * Note that a method that works asynchronously must implement a listener. @n - * This method only works for the @c PLAYER_STATE_PLAYING, @c PLAYER_STATE_PAUSED, and @c PLAYER_STATE_OPENED states of the player. @n + * This method only works for the ::PLAYER_STATE_PLAYING, ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_OPENED states of the player. @n * This method changes the playback position as well as the time value. @n * In video, it may not change position accurately. * @@ -536,8 +534,8 @@ public: * @c 0 indicates the starting position. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance is in an invalid state for this method. @n - * While playing live streaming, this operation returns E_INVALID_STATE. @n - * This method returns E_INVALID_STATE, if this method is called again before + * While playing live streaming, this operation returns @c E_INVALID_STATE. @n + * This method returns @c 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. @@ -558,11 +556,11 @@ public: * @return The running time of the media source in milliseconds * @exception E_SUCCESS The method is successful. * @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 the @c PLAYER_STATE_OPENED @c PLAYER_STATE_PLAYING @c PLAYER_STATE_PAUSED @c PLAYER_STATE_STOPPED states of this instance. - * - This method returns -1 when the method failed. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - While playing live streaming, this operation returns @c 0. + * - This method is valid in the ::PLAYER_STATE_OPENED, ::PLAYER_STATE_PLAYING, ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_STOPPED states of this instance. + * - This method returns @c -1 when the method fails. * @see GetPosition() */ long GetDuration(void) const; @@ -663,9 +661,10 @@ public: * @exception E_INVALID_STATE This instance is in an invalid state for this method. * @exception E_INVALID_CONTENT The content is inappropriate to compose media stream information. * @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 the @c PLAYER_STATE_OPENED @c PLAYER_STATE_PLAYING @c PLAYER_STATE_PAUSED @c PLAYER_STATE_STOPPED states of this instance. + * @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 the ::PLAYER_STATE_OPENED, ::PLAYER_STATE_PLAYING, ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_STOPPED states of this instance. */ MediaStreamInfo* GetCurrentMediaStreamInfoN(void) const; @@ -681,8 +680,10 @@ public: * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_SYSTEM A system error has occurred. @n * E_SYSTEM is returned when the unsupport resolution is set for rendering . - * @remarks This method works for the @c PLAYER_STATE_OPENED, @c PLAYER_STATE_ENDOFCLIP, @c PLAYER_STATE_STOPPED, @c PLAYER_STATE_PAUSED, and @c PLAYER_STATE_PLAYING states of the player. - * @remarks This method throws @c E_INVALID_STATE after the player instance is constructed with IPlayerVideoEventListener. + * @remarks + * - This method works for the ::PLAYER_STATE_OPENED, ::PLAYER_STATE_ENDOFCLIP, ::PLAYER_STATE_STOPPED, + * ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_PLAYING states of the player. + * - This method throws @c E_INVALID_STATE after the player instance is constructed with IPlayerVideoEventListener. */ result SetRenderingBuffer(const Tizen::Graphics::BufferInfo& bufferInfo); @@ -697,7 +698,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @exception E_RESOURCE_UNAVAILABLE The player's resources are unavailable. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks This method constructs the %Player instance to render the video content into the buffer of the video event listener. */ result Construct(IPlayerEventListener& listener, IPlayerVideoEventListener& videoListener); @@ -705,14 +706,15 @@ public: /** * Captures the video frame. @n * The %CaptureVideo() method delivers one video frame of a video content by using the IPlayVideoEventListener interface only once in the %Player instance. @n - * This method works only for the @c PLAYER_STATE_OPENED state of the %Player instance, and the state of the %Player instance is changed to @c PLAYER_STATE_PAUSED from @c PLAYER_STATE_OPENED after calling this method. + * This method works only for the ::PLAYER_STATE_OPENED state of the %Player instance, and the state of the %Player instance is changed to + * ::PLAYER_STATE_PAUSED from @c PLAYER_STATE_OPENED after calling this method. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance is in an invalid state for this method. @n - * This method throws E_INVALID_STATE if the %Player instance is + * This method throws @c E_INVALID_STATE if the %Player instance is * constructed without IPlayerVideoEventListener. * @exception E_INVALID_OPERATION This method is invalid for the current media content. * @exception E_SYSTEM A system error has occurred. @@ -730,8 +732,9 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_INVALID_STATE This instance is in an invalid state for this method. - * @remarks This method works for the @c PLAYER_STATE_INITIALIZED or @c PLAYER_STATE_CLOSED states of the %Player instance. - * In other states of %Player instance, this method returns @c E_SUCCESS, but the audio stream type is not changed properly. + * @remarks + * - This method works for the ::PLAYER_STATE_INITIALIZED or ::PLAYER_STATE_CLOSED states of the %Player instance. + * - In other states of %Player instance, this method returns @c E_SUCCESS, but the audio stream type is not changed properly. */ result SetAudioStreamType(AudioStreamType type); @@ -775,9 +778,10 @@ public: * @exception E_UNSUPPORTED_PROTOCOL The protocol is not supported. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The download will start when Play() is called. - * @remarks If the specified file name already exists, then the old file will be overwritten with the new one. - * @remarks See Programming Guide for the detail information of supported HTTP header fields. + * @remarks + * - The download will start when Play() is called. + * - If the specified file name already exists, then the old file will be overwritten with the new one. + * - See Programming Guide for the detail information of supported HTTP header fields. * @see Close() */ result OpenUrlAsync(const Tizen::Base::String& url, const Tizen::Base::String& filePath, IPlayerProgressiveDownloadListener& listener, const Tizen::Base::Collection::IMap* pHeader = null); @@ -789,8 +793,9 @@ public: * @since 2.0 * * @param[in] percent The progress period interval as a percentage value - * @remark If the server does not provide the information about the content size, progress event will occur randomly. - * @remarks If the percentage value is not set, @c 10 will be set as a default value. + * @remarks + * - If the server does not provide the information about the content size, progress event will occur randomly. + * - If the percentage value is not set, @c 10 will be set as a default value. * @see IPlayerProgressiveDownloadListener::OnPlayerProgressiveDownloadInProgress() */ void SetProgressiveDownloadIntervalByPercent(int percent); @@ -817,13 +822,13 @@ public: * * @return The current position in percent * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The method works for HTTP streaming playback only. + * @exception E_INVALID_OPERATION The operation cannot be processed further as the media is not in the HTTP streaming playback format. * @exception E_INVALID_STATE This instance is in an invalid state for this method. * @remarks - * - This method works only for the @c PLAYER_STATE_PLAYING or PLAYER_STATE_PAUSED states of the %Player instance. + * - This method works only for the ::PLAYER_STATE_PLAYING or ::PLAYER_STATE_PAUSED states of the %Player instance. * - This method is not supported in HTTP Live Streaming. * - The specific error code can be accessed using GetLastResult() method. - * - This method returns -1 when the method failed. + * - This method returns @c -1 when the method fails. */ int GetHttpStreamingDownloadProgress(void) const; diff --git a/inc/FMediaTone.h b/inc/FMediaTone.h index 888eec4..a15b509 100644 --- a/inc/FMediaTone.h +++ b/inc/FMediaTone.h @@ -51,11 +51,11 @@ class _OSP_EXPORT_ Tone { public: /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 * - * @remarks After creating an instance of this class, one of the Construct() methods must be called explicitly to initialize this instance. */ Tone(void); @@ -137,8 +137,6 @@ public: long GetDuration(void) const; /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. @n - * * Initializes this instance of %Tone with the values of the specified tone. * * @since 2.0 @@ -154,7 +152,6 @@ public: Tone(int firstFrequency, int secondFrequency, long duration); /** - * The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. @n * Initializes this instance of %Tone with the values of the specified DTMF preset tone. * * @since 2.0 diff --git a/inc/FMediaTonePlayer.h b/inc/FMediaTonePlayer.h index d9e4ccd..4a1a4cd 100755 --- a/inc/FMediaTonePlayer.h +++ b/inc/FMediaTonePlayer.h @@ -152,12 +152,12 @@ class _OSP_EXPORT_ TonePlayer { public: /** - * This is the default constructor for this class. + * This is the default constructor for this class. @n + * The object is not fully constructed after this constructor is called. @n + * For full construction, the Construct() method must be called right after calling this constructor. * * @since 2.0 * - * @remarks After creating an instance of this class, the Construct() method must be - * called explicitly to initialize this instance */ TonePlayer(void);