#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
/**
* @file FMediaAudioEqualizer.h
* @brief This is the header file for the %AudioEqualizer class.
+ *
* This header file contains the declarations of the %AudioEqualizer class.
*/
* @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.
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
*
* @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.
* @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.
* @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.
* @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.
*
* @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.
* @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.
* @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.
*
* @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.
*
* @since 2.0
*
- * @return The audio sampling rate in hertz (Hz)
+ * @return The audio sampling rate in Hertz (Hz)
*/
int GetSampleRate(void) const;
*
* @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);
* @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()
* @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);
* @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()
* @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);
* 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()
* @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;
* @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;
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
* @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.
* @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.
*/
*
* @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.