* @file FMedia.h
* @brief This is the header file for the %Media namespace.
*
- * This header file contains the declarations and descriptions of the %Tizen::Media namespace.
+ * This header file contains the declarations and descriptions of the %Media namespace.
*/
#ifndef _FMEDIA_H_
* @remarks @b Header @b %file: @b \#include @b <FMedia.h> @n
* @b Library : @b osp-media, @b osp-image
*
- * The %Media namespace defines interfaces and classes that
- * lets the application to integrate with the audio, video, and image processing functions easily, including:
+ * The %Media namespace defines classes and interfaces that
+ * let an application integrate with audio, video, and image processing functions easily, including:
* - Encoding and decoding images and videos
- * - Playing audio and video from media files stored on a device or streaming over the network
+ * - Playing audios and videos from media files stored on a device or streaming over the network
* - Getting meta-data from audio/video stream data
- * - Recording audio and video
+ * - Recording audios and videos
* - Using the camera to display a live preview and capture a still image
* - Using codec to encode and decode the audio/video data
* - Playing the tone(s)
* @image html media_using_the_apis_classdiagram.png
*
*/
-/**
-* @namespace Tizen::Media
-* @brief This namespace contains classes and interfaces for media processing services.
-*
-*/
+
namespace Tizen
{
namespace Media
/**
* @class AudioDecoder
- * @brief This class decodes a compressed audio stream to a raw audio data.
+ * @brief This class decodes a compressed audio stream into raw audio data.
*
* @since 2.0
*
- * @remarks
- * Source data of AAC and AMR decoder must be raw compressed data without header.
+ * @remarks The source data of the AAC and AMR decoders must be raw compressed data without a header.
*
- * The %AudioDecoder class decodes a compressed audio stream to a raw audio data.
- * The audio decoding formats, such as CODEC_MP3, CODEC_AAC, and CODEC_AMR_NB, are supported.
+ * The %AudioDecoder class decodes a compressed audio stream into raw audio data.
+ * Audio decoding formats, such as ::CODEC_MP3, ::CODEC_AAC, and ::CODEC_AMR_NB, are supported.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_audio.htm">Encoding and Decoding Audio</a>.
*
- * The following example demonstrates how to use the %AudioDecoder class in MP3 decoding.
+ * The following example demonstrates how to use the %AudioDecoder class for MP3 decoding.
*
*
* @code
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_audio.htm#decoding_audio">optional parameters</a>
* @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_CODEC The specified decoder is not supported.
- * @exception E_OUT_OF_RANGE A specified input parameter has a value that is out of range.
+ * @exception E_OUT_OF_RANGE A specified input parameter has a value that is out of the valid range.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
* @remarks The key type of the specified option is Tizen::Base::Integer, and the value type varies depending on the key type.
result Construct(CodecType type, const Tizen::Base::Collection::HashMap* pOption = null);
/**
- *
* Probes whether the audio data can be decoded.
*
* @since 2.0
* @param[out] channelType The channel type of the decoded audio sample
* @param[out] sampleRate The sample rate of the decoded audio sample
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified source buffer is invalid.
+ * @exception E_INVALID_ARG The specified @c srcBuf is invalid.
* @exception E_UNSUPPORTED_FORMAT The input data is not in a supported format.
* @exception E_OUT_OF_MEMORY The memory is insufficient to decode the sample.
* @exception E_SYSTEM A system error has occurred.
result Probe(const Tizen::Base::ByteBuffer& srcBuf, AudioSampleType& sampleType, AudioChannelType& channelType, int& sampleRate);
/**
- *
- * Decodes the audio data from the source buffer and stores the decoded data into a destination buffer. @n
+ * Decodes the audio data from the source buffer and stores the decoded data into the destination buffer. @n
* The %AudioDecoder class reads and decodes the audio data from the source buffer
- * and it also writes the decoded audio data into the destination buffer. @n
+ * and writes the decoded audio data into the destination buffer. @n
* The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
*
* @since 2.0
* @param[in] srcBuf The source buffer that stores the compressed audio data
* @param[out] dstBuf The destination buffer that stores the decoded audio data
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified source or destination buffer is invalid.
+ * @exception E_INVALID_ARG The specified @c srcBuf or @c dstBuf is invalid.
* @exception E_UNSUPPORTED_FORMAT The input data is not in a supported format.
- * @exception E_OUT_OF_MEMORY The specified destination buffer is insufficient to store the decoded data.
+ * @exception E_OUT_OF_MEMORY The specified @c dstBuf is insufficient to store the decoded data.
* @exception E_SYSTEM A system error has occurred.
*/
result Decode(Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& dstBuf);
* @exception E_OBJ_NOT_FOUND The specified @c key is not found.
* @exception E_INVALID_ARG The specified @c key is not supported.
* @exception E_SYSTEM A system error has occurred.
- * @remarks The property whose value type is enum can be obtained using this method.
*/
result GetValue(MediaPropertyType key, int& value) const;
*
* @since 2.0
*
- * @return A list of supported properties, @n
- * else @c null if no property is supported or if an exception occurs
+ * @return The list of supported properties, @n
+ * else @c null if no property is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_SYSTEM A system error has occurred.
bool IsPropertySupported(MediaPropertyType key) const;
/**
- * Gets a list of the supported codecs.
+ * Gets the list of supported codecs.
*
* @since 2.0
*
- * @return A list of the codecs supported by the %AudioDecoder class, @n
+ * @return The list of the codecs supported by %AudioDecoder, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @file FMediaAudioEncoder.h
* @brief This is the header file for the %AudioEncoder class.
*
- * This header file contains the declarations of the %Tizen::Media::AudioEncoder class.
+ * This header file contains the declarations of the %AudioEncoder class.
*/
#ifndef _FMEDIA_AUDIO_ENCODER_H_
/**
* @class AudioEncoder
- * @brief This class encodes raw audio data into compressed audio stream.
+ * @brief This class encodes raw audio data into a compressed audio stream.
*
* @since 2.0
*
- * The %AudioEncoder class encodes raw audio data into compressed audio stream.
- * It supports the audio encoding formats such as CODE_AAC and CODEC_AMR_NB. @n
+ * The %AudioEncoder class encodes raw audio data into a compressed audio stream.
+ * It supports the audio encoding formats such as ::CODEC_AAC and ::CODEC_AMR_NB.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_audio.htm">Encoding and Decoding Audio</a>. @n
*
{
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.
- *
- * @since 2.0
- *
- */
+ * 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
+ *
+ */
AudioEncoder(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
virtual ~AudioEncoder(void);
/**
- * Initializes this instance of %AudioEncoder with the specified parameters.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] type The codec type
-
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_audio.htm#encoding_audio">optional parameters</a>
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_CODEC The specified encoder is not supported.
- * @exception E_OUT_OF_RANGE A specified input parameter has a value that is out of range.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The key type of the specified option is Tizen::Base::Integer, and the value type varies depending on the key type.
- */
+ * Initializes this instance of %AudioEncoder with the specified parameters.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] type The codec type
+
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_audio.htm#encoding_audio">optional parameters</a>
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_CODEC The specified encoder is not supported.
+ * @exception E_OUT_OF_RANGE A specified input parameter has a value that is out of the valid range.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The key type of the specified option is Tizen::Base::Integer, and the value type varies depending on the key type.
+ */
result Construct(CodecType type, const Tizen::Base::Collection::HashMap* pOption = null);
public:
- /**
- * Encodes the audio data from the source buffer and stores the encoded data into the destination buffer. @n
- * The %AudioEncoder class reads the audio data from the source buffer
- * and it writes the encoded audio data into the destination buffer.
- * The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
- * If there is no space in the destination buffer, the encoder returns @c E_INVALID_ARG.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] srcBuf The source buffer that stores the uncompressed audio data
- * @param[out] dstBuf The destination buffer that stores the encoded audio data
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified source or destination buffer is invalid.
- * @exception E_OUT_OF_MEMORY The specified destination buffer is not sufficient to store the decoded data.
- * @exception E_SYSTEM A system error has occurred.
- */
+ /**
+ * Encodes the audio data from the source buffer and stores the encoded data into the destination buffer. @n
+ * The %AudioEncoder class reads the audio data from the source buffer
+ * and writes the encoded audio data into the destination buffer.
+ * The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
+ * If there is no space in the destination buffer, the encoder returns @c E_INVALID_ARG.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] srcBuf The source buffer that stores the uncompressed audio data
+ * @param[out] dstBuf The destination buffer that stores the encoded audio data
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c srcBuf or @c dstBuf is invalid.
+ * @exception E_OUT_OF_MEMORY The specified @c dstBuf is not sufficient to store the decoded data.
+ * @exception E_SYSTEM A system error has occurred.
+ */
result Encode(Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& dstBuf);
- /**
- * Resets the internal state of the audio encoder to process a new audio stream.
- *
- * @since 2.0
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- */
+ /**
+ * Resets the internal state of the audio encoder to process a new audio stream.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ */
result Reset(void);
- /**
- * Gets a list of the supported codecs.
+ /**
+ * Gets the list of supported codecs.
*
* @since 2.0
*
- * @return A list of the codecs supported by the %AudioEncoder class, @n
+ * @return The list of the codecs supported by %AudioEncoder, @n
* else @c null if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
namespace Tizen { namespace Media
{
/**
- * @class AudioEqualizer
- * @brief This class is used to apply audio equalizer settings.
+ * @class AudioEqualizer
+ * @brief This class provides methods to apply audio equalizer settings.
*
* @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
- * @remarks The functionality includes querying and setting the levels of the different frequency bands.
+ * @remarks The functionality includes querying and setting the levels of the different frequency bands.
+ *
+ * The %AudioEqualizer class provides methods to apply audio equalizer settings.
*
* The following example demonstrates how to use the %AudioEqualizer class.
*
*
* #include <FBase.h>
* #include <FMedia.h>
+ * #include <FApp.h>
*
* using namespace Tizen::Base;
* using namespace Tizen::Media;
: public Tizen::Base::Object
{
public:
- /**
+ /**
* 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.
*
*/
AudioEqualizer(void);
- /**
+ /**
* This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
*/
virtual ~AudioEqualizer(void);
- /**
+ /**
* Initializes this instance of %AudioEqualizer with the given Player.
*
* @since 2.0
*
* @return An error code
- * @param[in] player The player instance that the equalizer will be applied
+ * @param[in] player The player instance to which the equalizer is applied
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_INVALID_ARG The specified input parameter is invalid.
*/
result Construct(Player& player);
- /**
- * Gets the count of bands that equalizer supports.
+ /**
+ * Gets the count of bands that the equalizer supports.
*
* @since 2.0
*
* @return The count of bands, @n
- * else @c -1 if it fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
+ * else @c -1 if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetBandCount(void) const;
- /**
+ /**
* Gets the level range of the frequency band.
*
* @since 2.0
*
- * @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 @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.
+ * @return An error code
+ * @param[in] index The index of the frequency band @n
+ * The index starts from @c 0.
+ * @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 A specified input parameter is invalid.
+ * @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
* @see GetBandCount()
*/
result GetBandLevelRange(int index, int& minValue, int& maxValue) const;
- /**
+ /**
* Sets the level of the 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[in] level The level to which the frequency band should be set
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The level value does not lie within minimum and maximum range of frequency band.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @param[in] index The index of the frequency band @n
+ * The index starts from @c 0.
+ * @param[in] level The level to which the frequency band is set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c level does not lie within the minimum and maximum range of the frequency band.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
* @see GetBandCount()
*/
result SetBandLevel(int index, int level);
- /**
- * Sets the level of all the frequency bands
+ /**
+ * Sets the level of all the frequency bands.
*
* @since 2.0
*
* @return An error code
- * @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 frequency bands.
+ * @param[in] pLevels A pointer to the level array which has the 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 the minimum and maximum range of the frequency bands.
+ * @exception E_INVALID_ARG Either of the following conditions has occurred:
+ * - The specified input parameter is invalid.
+ * - The list is empty.
+ * - The list does not have the level settings for all the 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 @c index.
+ /**
+ * Gets the level of the 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 @c index
+ * @param[in] index The index of the frequency band @n
+ * The index starts from @c 0.
+ * @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.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
*/
result GetBandLevel(int index, int& level) const;
- /**
- * Gets the center frequency of the frequency band specified by index.
+ /**
+ * Gets the center frequency of the 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] 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.
+ * @param[in] index The index of the frequency band @n
+ * The index starts from @c 0.
+ * @param[out] frequency The center frequency of the frequency band in Hz specified by @c index
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
*/
result GetBandCenterFrequency(int index, int& frequency) const;
- /**
- * Clears the equalizer effect and resets all bands to the default values.
+ /**
+ * Clears the equalizer effect and resets all the bands to the default value.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_OPERATION The associated audio instance is no longer valid.
*/
result ResetAllToDefault(void);
//
/**
- * @file FMediaAudioFrame.h
- * @brief This is the header file for the %AudioFrame class.
+ * @file FMediaAudioFrame.h
+ * @brief This is the header file for the %AudioFrame class.
*
* This header file contains the declarations of the %AudioFrame class.
*/
/**
* @class AudioFrame
- * @brief This class has the audio frame data.
+ * @brief This class represents the audio frame data.
*
* @since 2.1
*
* @final This class is not intended for extension.
*
- * The %AudioFrame class has the audio frame data.
+ * The %AudioFrame class represents the audio frame data.
* The frame has several plane components. @n
* This object is delivered to the application by IAudioStreamFilter::ProcessAudioStream() when the audio file is streaming.
*
{
public:
- /**
- *
- * Gets the plane count that a frame data has.
- *
- *
- * @return The plane count
- *
- */
+ /**
+ * Gets the plane count of the frame data.
+ *
+ *
+ * @return The plane count
+ *
+ */
int GetPlaneCount(void) const;
- /**
- *
- * Gets the type of an audio channel.
- *
- *
- * @return The audio channel
- *
- */
+ /**
+ * Gets the audio channel type.
+ *
+ *
+ * @return The audio channel type
+ *
+ */
AudioChannelType GetChannelType(void) const;
- /**
- *
- * Gets the audio sample type.
- *
- *
- * @return The audio sample type
- *
- */
+ /**
+ * Gets the audio sample type.
+ *
+ *
+ * @return The audio sample type
+ *
+ */
AudioSampleType GetSampleType(void) const;
- /**
- *
- * Gets the audio sampling rate.
- *
- *
- * @return The audio sampling rate in Hertz (Hz)
- *
- */
+ /**
+ * Gets the audio sampling rate.
+ *
+ *
+ * @return The audio sampling rate in Hertz (Hz)
+ *
+ */
int GetSamplingRate(void) const;
- /**
- *
- * Gets the plane data at the specified @c index from a frame.
- *
- *
- * @return The plane data, @n
- * else @c null if an error has occurred
- * @param[in] index The index at which the value is read
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c index is out of range.
- * @remarks
- * - The @c index should be less than the plane count.
- * - The buffer in Tizen::Base::ByteBuffer is shared with the %AudioFrame instance.
- * - The specific error code can be accessed using the GetLastResult() method.
- */
+ /**
+ * Gets the plane data at the specified @c index from the frame.
+ *
+ *
+ * @return The plane data, @n
+ * else @c null if an error occurs
+ * @param[in] index The index at which the value is read
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid range.
+ * @remarks
+ * - The @c index should be less than the plane count.
+ * - The buffer in Tizen::Base::ByteBuffer is shared with the %AudioFrame instance.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ */
Tizen::Base::ByteBuffer* GetPlaneData(int index) const;
private:
//
/**
- * @file FMediaAudioIn.h
- * @brief This is the header file for the %AudioIn class.
+ * @file FMediaAudioIn.h
+ * @brief This is the header file for the %AudioIn class.
*
* This header file contains the declarations of the %AudioIn class.
*/
{
/**
* @class AudioIn
- * @brief This class records directly from an audio device.
+ * @brief This class records directly from an audio device.
*
* @since 2.0
*
* The %AudioIn class records directly from an audio device by providing methods for capturing PCM data from an audio input device.
* An application can capture audio data with the help of an event listener after preparing the %AudioIn class
- * with proper channel count, sample type, and sampling rate.
+ * with a proper channel count, sample type, and sampling rate.
* To minimize the overhead of the %AudioIn class,
- * it is recommended that you use optimal channel type, sample type, and sampling rate.
- * These can be retrieved with GetOptimizedChannelType(), GetOptimizedSampleType()
+ * it is recommended to use the optimal channel type, sample type, and sampling rate.
+ * These can be retrieved using GetOptimizedChannelType(), GetOptimizedSampleType()
* and GetOptimizedSampleRate().
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/recording_pcm_audio.htm">Recording PCM Audio</a>.
: public Tizen::Base::Object
{
public:
- /**
- * 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
- *
- */
+ /**
+ * 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
+ *
+ */
AudioIn(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- * All allocated resources are deallocated with this method. @n
- * This method must be called in the same thread as the Construct() method.
- *
- * @since 2.0
- *
- * @see Construct()
- */
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object(). @n
+ * All the allocated resources are deallocated with this method. @n
+ * This method must be called in the same thread as the Construct() method.
+ *
+ * @since 2.0
+ *
+ */
virtual ~AudioIn(void);
- /**
+ /**
* Initializes this instance of %AudioIn with the specified IAudioInEventListener. @n
* The %Construct() method creates an instance of %AudioIn in the subsystem.
*
* @exception E_SUCCESS The method is successful.
* @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
* @exception E_UNSUPPORTED_OPERATION This operation is not supported.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks Only one instance of %AudioIn is operational at a given time.
*/
result Construct(IAudioInEventListener& listener);
- /**
- * @if OSPDEPREC
+ /**
+ * @if OSPDEPREC
* Prepares the specified audio input device with the application-defined settings. @n
* When the caller finishes using the audio input device, the resources must be released by calling the Unprepare() method.
*
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because AudioInputDevice is no longer used in %AudioIn class. @n
- * Instead of using this method, use Prepare(AudioSampleType audioSampleType, AudioChannelType audioChannelType, int audioSampleRate).
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because AudioInputDevice is no longer used in the %AudioIn class. @n
+ * Instead of using this method, use Prepare(AudioSampleType audioSampleType, AudioChannelType audioChannelType, int audioSampleRate).
*
* @since 2.0
*
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/audiorecorder
+ *
* @return An error code
- * @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)
- * @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.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_FORMAT The specified audio sample type is not supported.
- * @endif
+ * @param[in] audioInputDevice The audio input device
+ * @param[in] audioSampleType The audio sample type
+ * @param[in] audioChannelType The audio channel type
+ * @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.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c audioSampleType is not supported.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @endif
*/
result Prepare(AudioInputDevice audioInputDevice, AudioSampleType audioSampleType, AudioChannelType audioChannelType, int audioSampleRate);
- /**
+ /**
* Prepares the specified audio input device with the application-defined settings. @n
* When the caller finishes using the audio input device, the resources must be released by calling the Unprepare() method.
*
* @since 2.0
*
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/audiorecorder
+ *
* @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)
- * @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.
- * @exception E_UNSUPPORTED_FORMAT The specified audio sample type is not supported.
+ * @param[in] audioSampleType The audio sample type
+ * @param[in] audioChannelType The audio channel type
+ * @param[in] audioSampleRate The audio sample rate in Hertz (Hz)
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_FAILED The device has failed due to an unknown reason.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c audioSampleType is not supported.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result Prepare(AudioSampleType audioSampleType, AudioChannelType audioChannelType, int audioSampleRate);
- /**
- * Stops the usage of the input device and releases the allocated resources during the execution of the Prepare() method. @n
+ /**
+ * Stops the usage of the input device and releases the allocated resources during the execution of the Prepare(AudioSampleType, AudioChannelType, int) method. @n
* Resources allocated during %Prepare() are released.
*
* @since 2.0
*
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/audiorecorder
+ *
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result Unprepare(void);
- /**
+ /**
* Adds an input buffer to the specified audio input device. @n
* When the buffer is filled, the %AudioIn class returns the buffer to the caller
* by invoking IAudioInEventListener::OnAudioInBufferIsFilled().
*
* @since 2.0
*
- * @return An error code
- * @param[in] pByteBuffer A pointer to the buffer
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The input parameter is invalid.
+ * @return An error code
+ * @param[in] pByteBuffer A pointer to the buffer
+ * @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.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks The data size of @c pByteBuffer must be the same as every call of this method.
+ * @remarks The data size of @c pByteBuffer must be same as every call of this method.
* @see Start()
- * @see IAudioInEventListener::OnAudioInBufferIsFilled()
*/
result AddBuffer(const Tizen::Base::ByteBuffer* pByteBuffer);
- /**
+ /**
* Starts reading the audio data from an audio input device and fills the data into the buffer.
*
* @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/audiorecorder
+ *
+ * @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.
- * @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks Several buffers must be added to the queue with AddBuffer() before calling this method.
* @see Stop()
* @see IAudioInEventListener::OnAudioInBufferIsFilled()
*/
result Start(void);
- /**
- * Stops using the audio input device. @n
- * All pending and current buffers that are filled with audio data
- * at the time of calling the %Stop() method, are returned to the listener.
+ /**
+ * Stops the audio input device. @n
+ * All the pending and current buffers that are filled with audio data
+ * at the time of calling the %Stop() method, are returned to the listener.
* Use Start() to start capturing audio input data again.
*
* @since 2.0
*
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/audiorecorder
+ *
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see IAudioInEventListener::OnAudioInBufferIsFilled()
*/
result Stop(void);
- /**
- * Resets using the audio input device without returning buffers to the caller. @n
- * All pending and current buffers are released immediately without any notifications.
+ /**
+ * Resets the audio input device without returning buffers to the caller. @n
+ * All the pending and current buffers are released immediately without any notification.
* The state is changed to ::AUDIOIN_STATE_PREPARED.
*
* @since 2.0
*
- * @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/audiorecorder
+ *
+ * @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.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result Reset(void);
- /**
+ /**
* Gets the current state of this instance.
*
* @since 2.0
*
- * @return The state of this instance
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @return The current state of this instance
+ * @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.
*/
AudioInState GetState(void) const;
- /**
+ /**
* Gets the maximum size of the buffer that can be used with AddBuffer(). @n
- * This maximum value is set by Prepare() and reset to @c 0 by Unprepare().
+ * This maximum value is set by Prepare(AudioSampleType, AudioChannelType, int) and reset to @c 0 by Unprepare().
*
* @since 2.0
*
- * @return The maximum size of the buffer in bytes, @n
+ * @return The maximum size of the buffer in bytes, @n
* else @c -1 if an error occurs
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks
- * - The return value is available after calling the Prepare() method.
+ * - 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;
- /**
+ /**
* Gets the minimum size of the buffer that can be used with AddBuffer(). @n
- * This minimum value is set by Prepare() and reset to @c 0 by Unprepare().
+ * This minimum value is set by Prepare(AudioSampleType, AudioChannelType, int) and reset to @c 0 by Unprepare().
*
* @since 2.0
*
- * @return The minimum size of the buffer in bytes, @n
+ * @return The minimum size of the buffer in bytes, @n
* else @c -1 if an error occurs
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks
- * - The return value is available after calling the Prepare() method.
+ * - 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;
- /**
+ /**
* Gets the optimized sample type of the audio input device.
*
* @since 2.0
*
- * @return The audio encoding type
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @return The audio encoding type
+ * @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.
*/
AudioSampleType GetOptimizedSampleType(void) const;
- /**
+ /**
* Gets the optimized channel type of the audio input device.
*
* @since 2.0
*
* @return The audio channel type
* @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
AudioChannelType GetOptimizedChannelType(void) const;
- /**
+ /**
* Gets the optimized sample rate of the audio input device.
*
* @since 2.0
*
* @return The sample rate in Hertz (Hz)
* @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks The specific error code can be accessed using the GetLastResult() method.
*/
int GetOptimizedSampleRate(void) const;
//
/**
-* @file FMediaAudioManagerTypes.h
-* @brief This is the header file for the types of audio manager classes.
-*
-* This header files contains all the common things required for audio manager classes and its associated classes.
-*
-*/
+ * @file FMediaAudioManagerTypes.h
+ * @brief This is the header file for the types of audio manager classes.
+ *
+ * This header files contains all the common things required for audio manager classes and their associated classes.
+ *
+ */
#ifndef _FMEDIA_AUDIO_MANAGER_TYPES_H_
#define _FMEDIA_AUDIO_MANAGER_TYPES_H_
*/
enum InputAudioDevice
{
- INPUT_AUDIO_DEVICE_NONE, /**< No input audio device */
- INPUT_AUDIO_DEVICE_MIC, /**< The microphone */
- INPUT_AUDIO_DEVICE_WIRED_ACCESSORY, /**< The wired accessory such as headset*/
+ INPUT_AUDIO_DEVICE_NONE, /**< No input audio device */
+ INPUT_AUDIO_DEVICE_MIC, /**< The microphone */
+ INPUT_AUDIO_DEVICE_WIRED_ACCESSORY, /**< The wired accessory such as a headset */
INPUT_AUDIO_DEVICE_BT_SCO, /**< The bluetooth(SCO) */
};
*/
enum OutputAudioDevice
{
- OUTPUT_AUDIO_DEVICE_NONE, /**< No output audio device */
- OUTPUT_AUDIO_DEVICE_SPEAKER, /**< The speaker */
+ 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 ear jack, headphone, or headset*/
+ OUTPUT_AUDIO_DEVICE_WIRED_ACCESSORY, /**< The wired accessory such as a 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*/
- OUTPUT_AUDIO_DEVICE_HDMI, /** HDMI device*/
- OUTPUT_AUDIO_DEVICE_WFD, /** WiFi-Direct device*/
- OUTPUT_AUDIO_DEVICE_USB_AUDIO, /** USB audio device*/
+ OUTPUT_AUDIO_DEVICE_BT_A2DP, /**< The bluetooth(A2DP) */
+ OUTPUT_AUDIO_DEVICE_DOCK, /**< DOCK device */
+ OUTPUT_AUDIO_DEVICE_HDMI, /**< HDMI device */
+ OUTPUT_AUDIO_DEVICE_WFD, /**< WiFi-Direct device */
+ OUTPUT_AUDIO_DEVICE_USB_AUDIO, /**< USB audio device */
};
/**
*/
enum AudioStreamType
{
- AUDIO_STREAM_TYPE_NO_SOUND, /**< Device does not set any audio stream types */
- AUDIO_STREAM_TYPE_SYSTEM, /**< System audio */
- AUDIO_STREAM_TYPE_NOTIFICATION, /**< Notification audio */
- AUDIO_STREAM_TYPE_ALARM, /**< Alarm type audio */
- AUDIO_STREAM_TYPE_RINGTONE, /**< Ringtone type audio */
- AUDIO_STREAM_TYPE_MEDIA, /**< Media type audio */
- AUDIO_STREAM_TYPE_CALL /**< Call type audio */
+ AUDIO_STREAM_TYPE_NO_SOUND, /**< No audio stream type */
+ AUDIO_STREAM_TYPE_SYSTEM, /**< System audio */
+ AUDIO_STREAM_TYPE_NOTIFICATION, /**< Notification audio */
+ AUDIO_STREAM_TYPE_ALARM, /**< Alarm type audio */
+ AUDIO_STREAM_TYPE_RINGTONE, /**< Ringtone type audio */
+ AUDIO_STREAM_TYPE_MEDIA, /**< Media type audio */
+ AUDIO_STREAM_TYPE_CALL /**< Call type audio */
};
}} //Tizen::Media
//
/**
- * @file FMediaAudioOut.h
- * @brief This is the header file for the %AudioOut class.
+ * @file FMediaAudioOut.h
+ * @brief This is the header file for the %AudioOut class.
*
* This header file contains the declarations of the %AudioOut class.
*/
*
* @since 2.0
*
- * @remarks
- * The maximum number of %AudioOut instances is limited by Media::MediaCapability class.
- * However, the maximum count is a system wide count and it can be practically applied depending on the CPU model, CPU speed, number of CPU cores, CPU load from other applications, and the available memory.
- * Thus, the exact count can be smaller than the maximum count, in which case the %Prepare() methods will fail.
+ * @remarks The maximum number of %AudioOut instances is limited by Media::MediaCapability class.
+ * However, the maximum count is a system wide count and it can be practically applied depending on the CPU model, CPU speed, number of CPU cores, CPU load from other applications, and the available memory.
+ * Thus, the exact count can be smaller than the maximum count, in which case the %Prepare() methods fail.
+ * Reasonable working AudioOut count is under 10.
*
* @see Prepare(AudioSampleType, AudioChannelType, int)
* @see Prepare(AudioStreamType, AudioSampleType, AudioChannelType, int)
: public Tizen::Base::Object
{
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.
- *
- * @since 2.0
- *
- */
+ /**
+ * 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
+ *
+ */
AudioOut(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- * All allocated resources are released by this method.
- * This method must be called in the same thread as the Construct() method.
- *
- * @since 2.0
- *
- * @see Construct()
- */
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object(). @n
+ * All the allocated resources are released by this method. @n
+ * This method must be called in the same thread as the Construct() method.
+ *
+ * @since 2.0
+ *
+ */
virtual ~AudioOut(void);
public:
- /**
+ /**
* Initializes this instance of %AudioOut with the specified listener.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener An instance of IAudioOutEventListener
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] listener An instance of IAudioOutEventListener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_RESOURCE_UNAVAILABLE The %AudioOut's resources are unavailable.
+ * @exception E_RESOURCE_UNAVAILABLE The %AudioOut resources are unavailable.
*/
result Construct(IAudioOutEventListener& listener);
- /**
+ /**
* Prepares an audio output device with the defined settings.
*
* @since 2.0
*
* @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)
- * @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.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_FORMAT The specified audio sample type is not supported.
- * @remarks This method returns E_IVALID_STATE when the device runs out of audio resources.
+ * @param[in] audioSampleType The audio sample type
+ * @param[in] audioChannelType The audio channel type
+ * @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.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c audioSampleType is not supported.
+ * @remarks This method returns @c E_IVALID_STATE when the device runs out of audio resources.
* @see Unprepare()
*/
result Prepare(AudioSampleType audioSampleType, AudioChannelType audioChannelType, int audioSampleRate);
- /**
- * Prepares an audio output device with the defined settings with the audio stream type.
+ /**
+ * Prepares an audio output device with the defined settings and the audio stream type.
*
* @since 2.0
*
* @return An error code
- * @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)
- * @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.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_FORMAT The specified audio sample type is not supported.
- * @remarks This method returns E_IVALID_STATE when the device runs out of audio resources.
+ * @param[in] audioStreamType The audio stream type
+ * @param[in] audioSampleType The audio sample type
+ * @param[in] audioChannelType The audio channel type
+ * @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 has failed due to an unknown reason.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c audioSampleType is not supported.
+ * @remarks This method returns @c E_IVALID_STATE when the device runs out of audio resources.
* @see Unprepare()
*/
result Prepare(AudioStreamType audioStreamType, AudioSampleType audioSampleType, AudioChannelType audioChannelType, int audioSampleRate);
- /**
+ /**
* Closes the audio output device.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
- * @see Prepare()
+ * @exception E_SYSTEM A system error has occurred.
+ * @see Prepare(AudioSampleType, AudioChannelType, int)
+ * @see Prepare(AudioStreamType, AudioSampleType, AudioChannelType, int)
*/
result Unprepare(void);
- /**
- * Writes into the data buffer containing the audio data to be played to this audio output device. @n
- * When the end of the buffer is reached, the application gets the notification through IAudioOutEventListener.
+ /**
+ * Writes into the data buffer containing the audio data to be played on this audio output device. @n
+ * When the end of the buffer is reached, the application gets a notification through IAudioOutEventListener.
*
* @since 2.0
*
* @return An error code
- * @param[in] userData A pointer of the buffer containing the PCM data block
- * @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.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_OVERFLOW The specified input instance has overflowed.
+ * @param[in] userData A pointer to the buffer that contains the PCM data block
+ * @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.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_OVERFLOW The specified input instance has overflowed.
* @see Start()
* @see IAudioOutEventListener::OnAudioOutBufferEndReached()
*/
result WriteBuffer(const Tizen::Base::ByteBuffer& userData);
- /**
+ /**
* Starts the specified audio output device.
*
* @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.
- * @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
+ * @exception E_SYSTEM A system error has occurred.
* @see Stop()
*/
result Start(void);
- /**
+ /**
* Stops or pauses the playing of the audio output device. @n
* The current position of the playback is stored internally and the playback will restart from this position
* when Start() is called again.
* @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.
- * @exception E_SYSTEM A system error has occurred.
+ * @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 Use Start() to resume the playback from the current playback position.
* @see IAudioOutEventListener::OnAudioOutBufferEndReached()
*/
result Stop(void);
- /**
+ /**
* Resets the audio output device. @n
- * All pending and current data buffers in the queue are removed immediately without any notification. The
+ * All the pending and current data buffers in the queue are removed immediately without any notification. The
* state is changed to ::AUDIOOUT_STATE_PREPARED.
*
* @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.
- * @exception E_SYSTEM A system error has occurred.
+ * @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.
*/
result Reset(void);
- /**
+ /**
* Gets the state of the current audio output device.
*
* @since 2.0
*
- * @return The state of current audio output
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @return The state of the current audio output
+ * @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.
*/
AudioOutState GetState(void) const;
- /**
- * Gets the maximum size of buffer that can be used with WriteBuffer(). @n
- * This maximum value is set by Prepare() and reset to @c 0 by Unprepare().
+ /**
+ * Gets the maximum size of the buffer that can be used with WriteBuffer(). @n
+ * This maximum value is set by %Prepare() and is reset to @c 0 by Unprepare().
*
* @since 2.0
*
- * @return The maximum size of buffer, @n
- * else @c -1 if an error occurs
- * @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 The maximum size of the buffer, @n
+ * else @c -1 if an error occurs
+ * @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.
- * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value is available after calling the %Prepare() method.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * @see Prepare(AudioSampleType, AudioChannelType, int)
+ * @see Prepare(AudioStreamType, AudioSampleType, AudioChannelType, int)
*/
int GetMaxBufferSize(void) const;
- /**
- * Gets the minimum size of buffer that can be used with WriteBuffer(). @n
- * This minimum value is set by Prepare() and reset to @c 0 by Unprepare().
+ /**
+ * Gets the minimum size of the buffer that can be used with WriteBuffer(). @n
+ * This minimum value is set by %Prepare() and is reset to @c 0 by Unprepare().
*
* @since 2.0
*
- * @return The minimum size of buffer, @n
+ * @return The minimum size of the buffer, @n
* else @c -1 if an error occurs
- * @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.
+ * @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.
+ * - The return value is available after calling the %Prepare() method.
* - The specific error code can be accessed using the GetLastResult() method.
+ * @see Prepare(AudioSampleType, AudioChannelType, int)
+ * @see Prepare(AudioStreamType, AudioSampleType, AudioChannelType, int)
*/
int GetMinBufferSize(void) const;
- /**
+ /**
* Gets the optimized sample type of the audio output device.
*
* @since 2.0
*
* @return The audio encoding type
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @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.
*/
AudioSampleType GetOptimizedSampleType(void) const;
- /**
+ /**
* Gets the optimized channel type of the audio output device.
*
* @since 2.0
*
* @return The audio channel type
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @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.
*/
AudioChannelType GetOptimizedChannelType(void) const;
- /**
+ /**
* Gets the optimized sample rate of the audio output device.
*
* @since 2.0
*
* @return The sample rate in Hertz (Hz)
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @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.
*/
int GetOptimizedSampleRate(void) const;
- /**
+ /**
* Sets the volume level of the audio output device.
*
* @since 2.0
*
* @return An error code
- * @param[in] volume The new value for volume @n
- * The range of this parameter is from @c 0 to @c 100 and it is proportional to the current media sound volume level in setting.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified volume is out of range.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @remarks This method must be called after Prepare().
- * @see GetVolume()
+ * @param[in] volume The new value for the volume @n
+ * This parameter ranges from @c 0 to @c 100 and is proportional to the current media sound volume level in setting.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c volume is out of the valid range.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @remarks This method must be called after %Prepare().
+ * @see GetVolume()
+ * @see Prepare(AudioSampleType, AudioChannelType, int)
+ * @see Prepare(AudioStreamType, AudioSampleType, AudioChannelType, int)
*/
result SetVolume(int volume);
- /**
+ /**
* Gets the current volume level of this audio output.
*
* @since 2.0
* @return The current volume level, @n
* else @c -1 if an error occurs @n
* 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.
+ * @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 must be called after calling the Prepare() method.
- * @see SetVolume()
+ * - This method must be called after calling the %Prepare() method.
+ * @see SetVolume()
+ * @see Prepare(AudioSampleType, AudioChannelType, int)
+ * @see Prepare(AudioStreamType, AudioSampleType, AudioChannelType, int)
*/
int GetVolume(void) const;
//
/**
- * @file FMediaAudioRecorder.h
- * @brief This is the header file for the %AudioRecorder class.
+ * @file FMediaAudioRecorder.h
+ * @brief This is the header file for the %AudioRecorder class.
*
* This header file contains the declarations of the %AudioRecorder class.
*/
/**
* @class AudioRecorder
- * @brief This class records the audio data into a file.
+ * @brief This class records audio data into a file.
*
* @since 2.0
*
- * The %AudioRecorder class records the audio data from an input device source to the storage device. The
- * selection of the input device source depends upon the current device status. For example, if a headset device is
+ * The %AudioRecorder class records audio data from an input device source into a storage device. The
+ * selection of the input device source depends on the current device status. For example, if a headset device is
* connected, it is selected as an input source. The audio recording format, the maximum recording time, and the
* maximum recording size can be set using the methods available in this class.
*
{
public:
- /**
- * 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
- *
- */
+ /**
+ * 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
+ *
+ */
AudioRecorder(void);
- /**
- * This is the destructor for this class. @n
- * All allocated resources are released by this method. This method must be called in the same thread in
- * which the Construct() method is called. @n This polymorphic destructor should be overridden if required.
- * This way, the destructors of the derived classes are called when the destructor of this interface is called.
- *
- * @since 2.0
- *
- */
+ /**
+ * This is the destructor for this class. @n
+ * All the allocated resources are released by this method. This method must be called in the same thread as
+ * the Construct() method is called. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ *
+ * @since 2.0
+ *
+ */
virtual ~AudioRecorder(void);
public:
- /**
+ /**
* Initializes this instance of %AudioRecorder with the specified listener.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener An instance of IAudioRecorderEventListener
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION This audio recorder usage is not supported.
- * @exception E_DEVICE_BUSY The recorder is under use by other application or already used in this application.
+ * @param[in] listener An instance of IAudioRecorderEventListener
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_OPERATION The usage of this audio recorder is not supported.
+ * @exception E_DEVICE_BUSY Either of the following conditions has occurred:
+ * - The recorder is being used by another application.
+ * - The recorder is already used in this application.
*/
result Construct(IAudioRecorderEventListener& listener);
- /**
+ /**
* Creates an audio file for the recording.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
* @compatibility This method has compatibility issues with OSP compatible applications. @n
* For more information, see @ref CompIoPathPage "here".
* @endif
*
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
*/
result CreateAudioFile(const Tizen::Base::String& destMediaPath, bool overwrite);
- /**
+ /**
* Closes a file.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
*/
result Close(void);
- /**
+ /**
* Records an audio file.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @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.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_DEVICE_BUSY The recorder is under use by other application.
+ * @exception E_DEVICE_BUSY The recorder is being used by another application.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see Stop()
- * @see Pause()
+ * @see Pause()
*/
result Record(void);
- /**
+ /**
* Stops a recording.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see Record()
- * @see Pause()
+ * @see Pause()
*/
result Stop(void);
- /**
+ /**
* Pauses a recording. @n
* To resume a recording after the %Pause() method is called, the Record() method must be called.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @see Stop()
+ * @see Stop()
*/
result Pause(void);
- /**
+ /**
* Cancels a recording operation without saving the data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - If this method is called, the state is changed to ::RECORDER_STATE_STOPPING.
- * - After IAudioRecorderEventListener::OnAudioRecorderCanceled() is called, the state is changed
- * to ::RECORDER_STATE_STOPPED.
+ * - If this method is called, the state is changed to ::RECORDER_STATE_STOPPING.
+ * - After IAudioRecorderEventListener::OnAudioRecorderCanceled() is called, the state is changed
+ * to ::RECORDER_STATE_STOPPED.
* @see Record()
- * @see Stop()
+ * @see Stop()
*/
result Cancel(void);
- /**
- * Gets the state of an audio recorder.
+ /**
+ * Gets the state of the audio recorder.
*
* @since 2.0
*
- * @return The current state of an audio recorder
- * @see Close()
- * @see Record()
- * @see Stop()
- * @see Pause()
+ * @return The current state of the audio recorder
+ * @see Close()
+ * @see Record()
+ * @see Stop()
+ * @see Pause()
*/
RecorderState GetState(void) const;
- /**
+ /**
* Gets the current recording time.
*
* @since 2.0
*
- * @return The value indicating the current recording time in milliseconds, @n
+ * @return The current recording time in milliseconds, @n
* else @c -1 if the recording has not started as yet
*/
long GetRecordingTime(void) const;
- /**
+ /**
* Gets the current recording size.
*
* @since 2.0
*
- * @return The value indicating the current recording size in bytes, @n
+ * @return The current recording size in bytes, @n
* else @c -1 if the recording has not started as yet
*/
long GetRecordingSize(void) const;
- /**
+ /**
* Sets the recording time limit for a file in milliseconds.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
- * @param[in] msTime The maximum recording time in milliseconds @n
- * The time must be greater than @c 0.
+ * @param[in] msTime The maximum recording time in milliseconds @n
+ * The time must be greater than @c 0.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified time is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c msTime is out of the valid range.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks The default time is @c 60 seconds.
*/
result SetMaxRecordingTime(long msTime);
- /**
+ /**
* Gets the recording time limit of a file in milliseconds.
*
* @since 2.0
*
- * @return A @c long value indicating the maximum recording time in milliseconds
+ * @return The maximum recording time in milliseconds
* @see SetMaxRecordingTime()
*/
long GetMaxRecordingTime(void) const;
- /**
+ /**
* @if OSPDEPREC
- * Sets the audio format of an audio recorder. @n
+ * Sets the audio format of the audio recorder. @n
* Initially, the default format is set using the internal configuration.
*
* @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of this method, use the SetFormat(CodecType audioCodec, MediaContainerType container) method
* that sets the audio codec and container together.
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
- * @param[in] format The audio format to set @n
- * ::AUDIORECORDING_FORMAT_DEFAULT sets the system's default recording format.
+ * @param[in] format The audio format to set @n
+ * ::AUDIORECORDING_FORMAT_DEFAULT sets the system's default recording format.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see GetFormat()
*/
result SetFormat(AudioRecordingFormat format);
- /**
+ /**
* @if OSPDEPREC
- * Gets the audio recording format of an audio recorder.
+ * Gets the audio recording format of the audio recorder.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. Instead of this method, use the GetFormat(CodecType& audioCodec,
- * MediaContainerType& container) const method that gets the audio codec and container together.
+ * MediaContainerType& container) constant method that gets the audio codec and container together.
* @since 2.0
*
* @return The audio recording format, @n
- * else default format if SetFormat() is not called before calling this method
+ * else the default format if SetFormat() is not called before calling this method
* @see SetFormat()
* @endif
*/
AudioRecordingFormat GetFormat(void) const;
- /**
- * Sets the audio codec and the container of an audio recorder. @n
- * Initially, the default codec and the container format are set using the internal configuration.
+ /**
+ * Sets the audio codec and container of the audio recorder. @n
+ * Initially, the default codec and container format are set using the internal configuration.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks If the specified container does not support the specified codec, @c E_UNSUPPORTED_FORMAT may be returned.
+ * @remarks If the specified container does not support the specified codec, @c E_UNSUPPORTED_FORMAT is returned.
* @see GetFormat( CodecType& audioCodec, MediaContainerType& container ) const
*/
result SetFormat(CodecType audioCodec, MediaContainerType container);
- /**
- * Gets the audio codec and container of an audio recorder.
+ /**
+ * Gets the audio codec and container of the audio recorder.
*
* @since 2.0
*
* @param[out] audioCodec The retrieved audio codec
* @param[out] container The retrieved container
* @exception E_SUCCESS The method is successful.
- * @remarks If SetFormat(CodecType audioCodec, MediaContainerType container) is not called before calling
- * this method, the default codec and container are retrieved. @n
- * This method always returns @c E_SUCCESS.
- * @see SetFormat( CodecType audioCodec, MediaContainerType container )
+ * @remarks
+ * - If SetFormat(CodecType audioCodec, MediaContainerType container) is not called before calling
+ * this method, the default codec and container are retrieved.
+ * - This method always returns @c E_SUCCESS.
*/
result GetFormat(CodecType& audioCodec, MediaContainerType& container) const;
- /**
- * Gets a list of the supported audio codecs. @n
- * Each list's item has a ::CodecType value.
+ /**
+ * Gets the list of supported audio codecs. @n
+ * Each list item has a ::CodecType value.
*
* @since 2.0
*
- * @return A list of supported audio codecs, @n
- * else @c null if no codec is supported or if an exception occurs
+ * @return The list of supported audio codecs, @n
+ * else @c null if no codec is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be released by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be released by the caller.
* @see SetFormat(CodecType audioCodec, MediaContainerType container)
- * @see GetFormat(CodecType& audioCodec, MediaContainerType& container) const
+ * @see GetFormat(CodecType& audioCodec, MediaContainerType& container) const
*/
Tizen::Base::Collection::IListT <CodecType>* GetSupportedCodecListN(void) const;
- /**
- * Gets a list of the supported containers. @n
- * Each list's item has a ::MediaContainerType value.
+ /**
+ * Gets the list of supported containers. @n
+ * Each list item has a ::MediaContainerType value.
*
* @since 2.0
*
- * @return A list of supported container list, @n
- * else @c null if no container is supported or if an exception occurs
+ * @return The list of supported containers, @n
+ * else @c null if no container is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be released by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be released by the caller.
* @see SetFormat(CodecType audioCodec, MediaContainerType container)
- * @see GetFormat(CodecType& audioCodec, MediaContainerType& container) const
+ * @see GetFormat(CodecType& audioCodec, MediaContainerType& container) const
*/
Tizen::Base::Collection::IListT <MediaContainerType>* GetSupportedContainerListN(void) const;
- /**
+ /**
* Sets the audio recording quality of the audio recorder.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
* @param[in] quality The audio recording quality of the audio recorder @n
- * The default value is ::RECORDING_QUALITY_MEDIUM.
+ * The default value is @c RECORDING_QUALITY_MEDIUM.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The specified @c quality is not supported.
*/
result SetQuality(RecordingQuality quality);
- /**
+ /**
* Gets the audio recording quality of the audio recorder.
*
* @since 2.0
*/
RecordingQuality GetQuality(void) const;
- /**
- * Sets the mute state of an audio recorder.
+ /**
+ * Sets the mute state of the audio recorder.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @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.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The audio recording continues even though the audio recorder is in the mute state.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The audio recording continues even if the audio recorder is in the mute state.
* @see IsMuted()
*/
result SetMute(bool mute);
- /**
- * Checks whether the mute state is enabled for an audio recorder.
+ /**
+ * Checks whether the mute state is enabled for the audio recorder.
*
* @since 2.0
*
*/
bool IsMuted(void) const;
- /**
+ /**
* Adds a stream filter to process the audio stream data while recording.
*
* @since 2.1
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
- * @param[in] filter An instance of IAudioStreamFilter
- * @exception E_SUCCESS The method is successful.
+ * @param[in] filter An instance of IAudioStreamFilter
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The filter already exists.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks IAudioStreamFilter::ProcessAudioStream() is called when the audio frame is ready.
+ * @remarks IAudioStreamFilter::ProcessAudioStream() is called when the audio frame is ready.
*/
result AddAudioStreamFilter(IAudioStreamFilter& filter);
- /**
+ /**
* Removes a stream filter to stop processing the audio stream data.
*
* @since 2.1
* @privilege %http://tizen.org/privilege/audiorecorder
*
* @return An error code
- * @param[in] filter An instance of IAudioStreamFilter
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The filter is not found.
+ * @param[in] filter An instance of IAudioStreamFilter
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The filter is not found.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result RemoveAudioStreamFilter(IAudioStreamFilter& filter);
* @file FMediaAudioRecorderTypes.h
* @brief This is the header file for the %AudioRecordingFormat enumeration.
*
- * This header file contains the descriptions for the %AudioRecordingFormat enumeration.
+ * This header file contains the descriptions of the %AudioRecordingFormat enumeration.
*/
#ifndef _FMEDIA_AUDIO_RECORDER_TYPES_H_
* Defines the formats for audio recording.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enum is deprecated because new methods do not use it. @n
+ * @deprecated This enum is deprecated because the new methods do not use it. @n
* Instead of using this enum, use ::MediaContainerType.
*
* @since 2.0
//
/**
-* @file FMediaAudioRouteInfo.h
-* @brief This is the header file for the %AudioRouteInfo class.
-*
-* This header files contains the declarations of the %AudioRouteInfo class and its associated classes.
-*
-*/
+ * @file FMediaAudioRouteInfo.h
+ * @brief This is the header file for the %AudioRouteInfo class.
+ *
+ * This header file contains the declarations of the %AudioRouteInfo class and its associated classes.
+ *
+ */
#ifndef _FMEDIA_AUDIO_ROUTE_INFO_H_
#define _FMEDIA_AUDIO_ROUTE_INFO_H_
namespace Tizen { namespace Media
{
/**
- * @class AudioRouteInfo
+ * @class AudioRouteInfo
* @brief This class contains audio route information.
*
- * @since 2.0
+ * @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
- * @remarks Audio routing can be done using this class instances as input/output audio devices.
+ * @remarks Audio routing can be done using the instances of this class as input/output audio devices.
*
* The %AudioRouteInfo class contains audio route information.
*/
:public Tizen::Base::Object
{
public:
- /**
- * Initializes this instance of %AudioRouteInfo with the specified audio devices.
+ /**
+ * Initializes this instance of %AudioRouteInfo with the specified audio devices.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] in The input audio device
- * @param[in] out The output audio device
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient to perform the operation.
+ * @param[in] in The input audio device
+ * @param[in] out The output audio device
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient to perform the operation.
*
*/
AudioRouteInfo(InputAudioDevice in, OutputAudioDevice out);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
*
- * @since 2.0
+ * @since 2.0
*
*/
virtual ~AudioRouteInfo(void);
- /**
- * Sets the input audio device.
+ /**
+ * Sets the input audio device.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] in The input audio device
+ * @param[in] in The input audio device
*/
void SetInputAudioDevice(InputAudioDevice in);
- /**
- * Sets the output audio device.
+ /**
+ * Sets the output audio device.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] out The output audio device
+ * @param[in] out The output audio device
*/
void SetOutputAudioDevice(OutputAudioDevice out);
- /**
- * Gets the input audio device.
+ /**
+ * Gets the input audio device.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The input audio device
+ * @return The input audio device
*/
InputAudioDevice GetInputAudioDevice(void) const;
- /**
- * Gets the output audio device.
+ /**
+ * Gets the output audio device.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The output audio device
+ * @return The output audio device
*/
OutputAudioDevice GetOutputAudioDevice(void) const;
- /**
+ /**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @return The copy of this instance
- * @param[in] rhs An instance of %AudioRouteInfo
+ * @return A copy of this instance
+ * @param[in] rhs An instance of %AudioRouteInfo to copy
*/
AudioRouteInfo(const AudioRouteInfo& rhs);
- /**
- * Copying of objects using this copy assignment operator is allowed.
+ /**
+ * Copying of objects using this copy assignment operator is allowed.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The instance of %AudioRouteInfo
- * @param[in] rhs An instance of %AudioRouteInfo
+ * @return An instance of %AudioRouteInfo
+ * @param[in] rhs An instance of %AudioRouteInfo to copy
*/
AudioRouteInfo& operator =(const AudioRouteInfo& rhs);
- /**
- * Compares the specified instance of %AudioRouteInfo with the calling instance.
+ /**
+ * Compares the specified instance of %AudioRouteInfo with the current instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the object is the same, @n
- * else @c false
- * @param[in] obj The object to compare with the current instance
+ * @return @c true if the objects are the same, @n
+ * else @c false
+ * @param[in] obj The object to compare with the current instance
*/
virtual bool Equals(const Object& obj) const;
- /**
- * Gets the hash code for the %AudioRouteInfo instance.
+ /**
+ * Gets the hash code of the %AudioRouteInfo instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The hash code
+ * @return The hash code
*/
virtual int GetHashCode(void) const;
//
/**
- * @file FMediaAudioRouteManager.h
- * @brief This is the header file for the %AudioRouteManager class.
+ * @file FMediaAudioRouteManager.h
+ * @brief This is the header file for the %AudioRouteManager class.
*
* This header file contains the declarations of the %AudioRouteManager class.
*/
namespace Tizen { namespace Media
{
/**
- * @class AudioRouteManager
+ * @class AudioRouteManager
* @brief This class is used to manage audio routing.
*
- * @since 2.0
+ * @since 2.0
*
- * @final This class is not intended for extension.
+ * @final This class is not intended for extension.
*
- * @remarks Only one instance of the class works at a time.
+ * @remarks Only one instance of the class works at a time.
+ *
+ * The %AudioRouteManager class is used to manage audio routing.
*
* The following example demonstrates how to use the %AudioRouteManager class.
*
:public Tizen::Base::Object
{
public:
- /**
- * Gets the audio route manager instance pointer.
+ /**
+ * Gets a pointer to the %AudioRouteManager instance.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @return A pointer to the audio route manager instance, @n
- * else @c null if it fails
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient to perform the operation.
- * @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.
+ * @return A pointer to the %AudioRouteManager instance, @n
+ * else @c null if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient to perform the operation.
+ * @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.
*/
static AudioRouteManager* GetInstance(void);
- /**
- * Sets audio route event listener.
+ /**
+ * Sets the audio route event listener.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @return An error code
- * @param[in] pListener The audio route event listener @n
- * To unset the listener, pass a @c null value to the listener parameter.
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @return An error code
+ * @param[in] pListener The audio route event listener @n
+ * To unset the listener, pass a @c null value to the listener parameter.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result SetAudioRouteEventListener(IAudioRouteEventListener* pListener);
- /**
- * Gets the name of the active bluetooth A2DP device.
+ /**
+ * Gets the name of the active bluetooth A2DP device.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @return The name of active bluetooth A2DP device
- * @exception E_SUCCESS The method is successful.
- * @exception E_DEVICE_UNAVAILABLE A2DP device is not connected or available.
- * @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.
+ * @return The name of the active bluetooth A2DP device
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_DEVICE_UNAVAILABLE The A2DP device is either not connected or unavailable.
+ * @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.
*/
Tizen::Base::String GetActiveBluetoothA2dpName(void) const;
- /**
- * Gets the active audio stream type
+ /**
+ * Gets the active audio stream type.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @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.
- * - @c AUDIO_STREAM_TYPE_NO_SOUND is returned when an error has occurred in this method.
+ * @return The active audio stream type, @n
+ * else @c AUDIO_STREAM_TYPE_NO_SOUND if it fails
+ * @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.
*/
AudioStreamType GetActiveAudioStreamType(void) const;
- /**
- * Gets available audio routes.
+ /**
+ * Gets the available audio routes.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @return The list of available audio routes, @n
- * else @c null if it fails
- * @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.
- * - The item type of returned list is AudioRouteInfo.
+ * @return The list of available audio routes, @n
+ * else @c null if it fails
+ * @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.
+ * - The item type of the returned list is AudioRouteInfo.
*/
Tizen::Base::Collection::IList* GetAvailableAudioRouteListN(void) const;
- /**
- * Checks the specified @c route availability.
+ /**
+ * Checks the specified route's availability.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @return @c true if the audio route is available, @n
- * else @c false
- * @param[in] route An instance of AudioRouteInfo
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @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.
+ * @return @c true if the audio route is available, @n
+ * else @c false
+ * @param[in] route An instance of AudioRouteInfo
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @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.
*/
bool IsAudioRouteAvailable(const AudioRouteInfo& route) const;
- /**
- * Sets the active audio route.
+ /**
+ * Sets the active audio route.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @return An error code
- * @param[in] route An instance of AudioRouteInfo to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_DEVICE_UNAVAILABLE The audio route is not available.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @return An error code
+ * @param[in] route An instance of AudioRouteInfo to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_DEVICE_UNAVAILABLE The audio route is not available.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result SetActiveAudioRoute(const AudioRouteInfo& route);
- /**
- * Gets the active audio route.
+ /**
+ * Gets the active audio route.
*
- * @since 2.0
+ * @since 2.0
*
- * @privlevel partner
- * @privilege %http://tizen.org/privilege/audiomanager.route
+ * @privlevel partner
+ * @privilege %http://tizen.org/privilege/audiomanager.route
*
- * @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.
- * - ::INPUT_AUDIO_DEVICE_NONE and ::OUTPUT_AUDIO_DEVICE_NONE are set in AudioRouteInfo if this method fails.
+ * @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.
+ * - ::INPUT_AUDIO_DEVICE_NONE and ::OUTPUT_AUDIO_DEVICE_NONE are set in AudioRouteInfo if this method fails.
*/
AudioRouteInfo GetActiveAudioRoute(void) const;
//
/**
- * @file FMediaAudioStreamInfo.h
- * @brief This is the header file for the %AudioStreamInfo class.
+ * @file FMediaAudioStreamInfo.h
+ * @brief This is the header file for the %AudioStreamInfo class.
*
* This header file contains the declarations of the %AudioStreamInfo class.
*/
: public Tizen::Base::Object
{
public:
- /**
+ /**
* This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
virtual ~AudioStreamInfo(void);
public:
- /**
+ /**
* Gets the encoding type of an audio stream.
*
* @since 2.0
*/
CodecType GetCodecType(void) const;
- /**
+ /**
* Gets the bit rate of an audio.
*
* @since 2.0
*
- * @return The audio bit rate in bits per second (bps)
+ * @return The audio bit rate in bits per second (bps)
*/
int GetBitRate(void) const;
- /**
+ /**
* Gets the sampling rate of an audio.
*
* @since 2.0
*
- * @return The audio sampling rate in Hertz (Hz)
+ * @return The audio sampling rate in Hertz (Hz)
*/
int GetSampleRate(void) const;
- /**
- * Gets the audio channel of an audio.
+ /**
+ * Gets the audio channel type of an audio.
*
* @since 2.0
*
- * @return The audio channel type
+ * @return The audio channel type
*/
AudioChannelType GetChannelType(void) const;
- /**
+ /**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @return The copy of this instance
- * @param[in] rhs An instance of %AudioStreamInfo
+ * @return A copy of this instance
+ * @param[in] rhs An instance of %AudioStreamInfo to copy
*/
AudioStreamInfo(const AudioStreamInfo & rhs);
- /**
+ /**
* Copying of objects using this copy assignment operator is allowed.
*
* @since 2.0
*
- * @return The reference of this instance
- * @param[in] rhs An instance of %AudioStreamInfo
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %AudioStreamInfo to copy
*/
AudioStreamInfo & operator =(const AudioStreamInfo & rhs);
- /**
- * Compares the specified instance of Tizen::Base::Object with the calling instance of %AudioStreamInfo.
+ /**
+ * Compares the specified instance of Tizen::Base::Object with the current instance of %AudioStreamInfo.
*
* @since 2.0
*
- * @return @c true if the value of the specified instance equals the value of the current instance, @n
- * else @c false
- * @param[in] rhs The object to compare with the current instance
+ * @return @c true if the value of the specified instance equals the value of the current instance, @n
+ * else @c false
+ * @param[in] rhs The object to compare with the current instance
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
- /**
+ /**
* Gets the hash value of the current instance.
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
*/
virtual int GetHashCode(void) const;
//
/**
-* @file FMediaAudioTypes.h
-* @brief This is the header file for the common types of AudioIn and AudioOut.
-*
-* This header file contains the declarations of the enumerations of the Audio In/Out classes.
-*/
+ * @file FMediaAudioTypes.h
+ * @brief This is the header file for the common types of %AudioIn and %AudioOut.
+ *
+ * This header file contains the declarations of the enumerations of the Audio In/Out classes.
+ */
#ifndef _FMEDIA_AUDIO_TYPES_H_
#define _FMEDIA_AUDIO_TYPES_H_
*/
enum AudioChannelType
{
- AUDIO_CHANNEL_TYPE_NONE, /**< The audio channel type is none */
+ AUDIO_CHANNEL_TYPE_NONE, /**< No audio channel type */
AUDIO_CHANNEL_TYPE_MONO, /**< The audio channel type is mono */
AUDIO_CHANNEL_TYPE_STEREO, /**< The audio channel type is stereo */
};
*/
enum AudioSampleType
{
- AUDIO_TYPE_NONE, /**< The audio encoding type is none */
+ AUDIO_TYPE_NONE, /**< No audio encoding type */
AUDIO_TYPE_PCM_U8, /**< The 8-bit samples are unsigned */
AUDIO_TYPE_PCM_S8, /**< The 8-bit samples are signed */
AUDIO_TYPE_PCM_U16_LE, /**< The 16-bit little-endian samples are unsigned */
{
AUDIOOUT_STATE_INITIALIZED, /**< The device is initialized */
AUDIOOUT_STATE_PREPARED, /**< The device is prepared */
- AUDIOOUT_STATE_PLAYING, /**< The device is playing data */
+ AUDIOOUT_STATE_PLAYING, /**< The device is playing the data */
AUDIOOUT_STATE_STOPPED, /**< The device is stopped */
AUDIOOUT_STATE_UNPREPARED, /**< The device is uninitialized */
AUDIOOUT_STATE_ERROR, /**< An error has occurred */
//
/**
- * @file FMediaCamera.h
- * @brief This is the header file for the %Camera class.
+ * @file FMediaCamera.h
+ * @brief This is the header file for the %Camera class.
*
* This header file contains the declarations of the %Camera class.
*/
*
*
* The %Camera class controls the camera device.
- * The supported properties are device-dependent. The list of the properties available can be retrieved using the methods of %Camera and MediaCapability classes.
+ * The supported properties are device-dependent. The list of available properties can be retrieved using the methods of the %Camera and MediaCapability classes.
* All the other methods, except SetAutoFocus(), StartPreview(), and Capture() work synchronously.
- * The previewed or captured data are passed through ICameraEventListener. @n
+ * The previewed or captured data is passed through ICameraEventListener. @n
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/capturing_still_images.htm">Capturing Still Images</a>.
*
: public Tizen::Base::Object
{
public:
- /**
+ /**
* 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.
*/
Camera(void);
- /**
+ /**
* This is the destructor for this class. @n
- * All allocated resources are deallocated by this method. This method must be called in the same thread
- * where the Construct() method is called.@n This polymorphic destructor should be overridden if required.
+ * All the allocated resources are deallocated by this method. This method must be called in the same thread
+ * where the Construct() method is called.@n
+ * This polymorphic destructor should be overridden if required. @n
* This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~Camera(void);
- /**
+ /**
* Initializes this instance of %Camera with the specified parameters. @n
* The %Construct() method creates an instance of %Camera in the subsystem. Only one instance is created at a given time.
*
* @since 2.0
*
- * @feature %http://tizen.org/feature/camera.back or %http://tizen.org/feature/camera.front
+ * @feature %http://tizen.org/feature/camera.back or %http://tizen.org/feature/camera.front
* @return An error code
* @param[in] listener An instance of ICameraEventListener
* @param[in] camSel The %Camera to power on
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_DEVICE_BUSY The camera is under use by other application or already used in this application.
+ * @exception E_DEVICE_BUSY Either of the following conditions has occured:
+ * - The camera is being used by another application.
+ * - The camera is already used in this application.
* @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, int& value)
- * with ::CAMERA_COUNT key.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, int& value)
+ * using ::CAMERA_COUNT as the key.
*/
result Construct(ICameraEventListener& listener, CameraSelection camSel = CAMERA_PRIMARY);
- /**
+ /**
* Powers the camera on.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @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.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks Reserved configurations are set in this method.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks Reserved configurations are set in this method.
* @see PowerOff()
*/
result PowerOn(void);
- /**
+ /**
* Powers the camera off.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @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.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @see PowerOn()
*/
result PowerOff(void);
- /**
+ /**
* Checks whether the camera is powered on.
*
* @since 2.0
*/
bool IsPoweredOn(void) const;
- /**
+ /**
* Starts displaying the preview image on the camera device. @n
- * If the value of @c pBufferInfo is @c null, no preview image is displayed. In this case, the application can
- * draw the preview image with the data passed on by the ICameraEventListener::OnCameraPreviewed() method.
+ * If the value of @c pBufferInfo is @c null, no preview image is displayed. In this case, the application
+ * draws the preview image with the data passed by the ICameraEventListener::OnCameraPreviewed() method.
*
* If the value of @c previewedData is @c true, the previewed image data is passed to the
- * ICameraEventListener::OnCameraPreviewed() method periodically based on the frame-rate, otherwise the
+ * %ICameraEventListener::OnCameraPreviewed() method periodically based on the frame-rate, otherwise the
* callback is not invoked. The default value of @c previewedData is @c false.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] pBufferInfo The buffer information for the camera preview display
* @param[in] previewedData Set to @c true if the previewed data is delivered to the callback method, @n
* else @c false
* @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @remarks
* - The overlay region retrieved by the buffer information must be the topmost window when this method is called.
* - The ICameraEventListener::OnCameraPreviewed() method can be delayed or dropped depending on
* the system's performance.
* - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_PREVIEW or ::CAMERA_SECONDARY_SUPPORT_PREVIEW keys.
+ * using ::CAMERA_PRIMARY_SUPPORT_PREVIEW or ::CAMERA_SECONDARY_SUPPORT_PREVIEW as the key.
* @see StopPreview()
- * @see ICameraEventListener::OnCameraPreviewed()
*/
result StartPreview(const Tizen::Graphics::BufferInfo* pBufferInfo, bool previewedData = false);
- /**
+ /**
* Stops displaying the preview image on the camera device.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @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.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see StartPreview()
*/
result StopPreview(void);
- /**
+ /**
* Captures the current image data from the camera sensor. @n
* After capturing the image, the camera's state changes to ::CAMERA_STATE_CAPTURED. @n
* The camera's preview must be restarted by calling the StartPreview() method. @n
* The captured image is passed through ICameraEventListener::OnCameraCaptured().
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @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.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_CAPTURE or ::CAMERA_SECONDARY_SUPPORT_CAPTURE keys.
- * -In a zero-shutter-lag camera, the state changes to ::CAMERA_STATE_PREVIEW after capturing.
- * -The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
- * @see ICameraEventListener::OnCameraCaptured()
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * using ::CAMERA_PRIMARY_SUPPORT_CAPTURE or ::CAMERA_SECONDARY_SUPPORT_CAPTURE as the key.
+ * - In a zero-shutter-lag camera, the state changes to ::CAMERA_STATE_PREVIEW after capturing.
+ * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) using
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG or ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG as the key.
*/
result Capture(void);
- /**
+ /**
* Gets the state of the camera in CameraState.
*
* @since 2.0
*
* @return The current state of the camera
- * @see StopPreview()
- * @see SetAutoFocus()
- * @see Capture()
+ * @see StopPreview()
+ * @see SetAutoFocus()
+ * @see Capture()
*/
CameraState GetState(void) const;
- /**
+ /**
* Sets the brightness level of the camera input data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] brightness The brightness level to set @n
- * The range of this parameter is from @c 0 to @c 9.
+ * This parameter ranges from @c 0 to @c 9.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified @c brightness is out of range.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_OUT_OF_RANGE The specified @c brightness is out of the valid range.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
* - The default brightness level is @c 5.
* - The device's supported range for the brightness level is from @c 0 to @c 9.
* - This method works correctly when PowerOn() is executed. @n
- * For more information on the relationship between this method and the PowerOn() method, and the
+ * For more information on the relationship between this method and the PowerOn() method, and the
* state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_BRIGHTNESS or ::CAMERA_SECONDARY_SUPPORT_BRIGHTNESS keys.
+ * using ::CAMERA_PRIMARY_SUPPORT_BRIGHTNESS or ::CAMERA_SECONDARY_SUPPORT_BRIGHTNESS as the key.
* @see GetBrightness()
*/
result SetBrightness(int brightness);
- /**
+ /**
* Gets the brightness level of the camera input data.
*
* @since 2.0
*
* @return The current brightness level @n
- * The returned value ranges from @c 0 to @c 9.
- * @remarks The device's supported range for the brightness level is from @c 0 to @c 9.
- * @see SetBrightness()
+ * The returned value ranges from @c 0 to @c 9.
+ * @remarks The device's supported range for the brightness level is from @c 0 to @c 9.
+ * @see SetBrightness()
*/
int GetBrightness(void) const;
- /**
+ /**
* Sets the contrast level of the %Camera input data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] contrast The contrast level to set @n
- * The range of this parameter is from @c 0 to @c 9.
+ * This parameter ranges from @c 0 to @c 9.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified contrast is out of range.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_OUT_OF_RANGE The specified @c contrast is out of the valid range.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
* For more information on the relationship between this method and the PowerOn() method, and the
* state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_CONTRAST or ::CAMERA_SECONDARY_SUPPORT_CONTRAST keys.
- * @see GetContrast()
+ * using ::CAMERA_PRIMARY_SUPPORT_CONTRAST or ::CAMERA_SECONDARY_SUPPORT_CONTRAST as the key.
+ * @see GetContrast()
*/
result SetContrast(int contrast);
- /**
+ /**
* Gets the contrast level of the camera input data.
*
* @since 2.0
*/
int GetContrast(void) const;
- /**
+ /**
* Zooms in the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @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.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_ZOOM or ::CAMERA_SECONDARY_SUPPORT_ZOOM keys.
- * - If Camera supports only ::CAMERA_ZOOM_TYPE_SMART, the zoom ratio can differ according
- * to the preview, capture, and recording resolutions.
- * - The supported zoom types can be obtained by using the
- * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * using ::CAMERA_PRIMARY_SUPPORT_ZOOM or ::CAMERA_SECONDARY_SUPPORT_ZOOM as the key.
+ * - If %Camera supports only ::CAMERA_ZOOM_TYPE_SMART, the zoom ratio can differ according
+ * to the preview, capture, and recording resolutions.
+ * - The supported zoom types can be obtained by using the
+ * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see ZoomOut()
* @see GetZoomLevel()
* @see GetMaxZoomLevel()
*/
result ZoomIn(void);
- /**
+ /**
* Zooms out the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @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.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_ZOOM or ::CAMERA_SECONDARY_SUPPORT_ZOOM keys.
- * - If CameraZoomType supports only ::CAMERA_ZOOM_TYPE_SMART, zoom ratio can differ according to
- * the preview, capture, and recording resolutions.
- * - The supported zoom types can be obtained by using the
- * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * using ::CAMERA_PRIMARY_SUPPORT_ZOOM or ::CAMERA_SECONDARY_SUPPORT_ZOOM as the key.
+ * - If CameraZoomType supports only ::CAMERA_ZOOM_TYPE_SMART, the zoom ratio can differ according to
+ * the preview, capture, and recording resolutions.
+ * - The supported zoom types can be obtained by using the
+ * MediaCapability::GetValueN(CAMERA_PRIMARY_ZOOM_TYPE) method.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see ZoomIn()
* @see GetZoomLevel()
* @see GetMaxZoomLevel()
*/
result ZoomOut(void);
- /**
+ /**
* Gets the zoom level of the camera.
*
* @since 2.0
* @return The current zoom level
* @remarks The zoom level is different for each camera device.
* @see ZoomIn()
- * @see ZoomOut()
+ * @see ZoomOut()
* @see GetMaxZoomLevel()
*/
int GetZoomLevel(void) const;
- /**
+ /**
* Gets the maximum zoom level supported by this %Camera.
*
- * @since 2.0
+ * @since 2.0
*
* @return The maximum zoom level
* @remarks The zoom level is different for each camera device.
* @see ZoomIn()
- * @see ZoomOut()
- * @see GetZoomLevel()
+ * @see ZoomOut()
+ * @see GetZoomLevel()
*/
int GetMaxZoomLevel(void) const;
- /**
+ /**
* Sets the current resolution of the preview.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] resolution The preview resolution @n
* It must be one of the listed dimensions that are extracted using GetSupportedPreviewResolutionListN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The position or size is out of range.
+ * @exception E_OUT_OF_RANGE Either the position or the size is out of the valid range.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - This method works in the ::CAMERA_STATE_INITIALIZED state. @n@n
+ * - This method works in the ::CAMERA_STATE_INITIALIZED state.
* - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
- * @see GetPreviewResolution()
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * @see GetPreviewResolution()
*/
result SetPreviewResolution(const Tizen::Graphics::Dimension& resolution);
- /**
+ /**
* Gets the current resolution of the preview.
*
* @since 2.0
*/
Tizen::Graphics::Dimension GetPreviewResolution(void) const;
- /**
+ /**
* Gets the supported preview resolution list of the %Camera class. @n
* Each item in the returned list contains a pointer of Tizen::Graphics::Dimension value.
*
* @since 2.0
*
- * @return A list of dimensions that represent the preview resolutions supported by the %Camera class, @n
+ * @return The list of dimensions that represent the preview resolutions supported by %Camera, @n
* else @c null if no preview resolution is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value and each item in the list must be deleted by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
* @see SetPreviewResolution()
- * @see GetPreviewResolution()
+ * @see GetPreviewResolution()
*/
Tizen::Base::Collection::IList* GetSupportedPreviewResolutionListN(void) const;
- /**
+ /**
* Sets the capturing resolution of the camera. @n
* Initially, the default resolution is set using the internal configuration.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] resolution The display resolution @n
* @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.
- * @exception E_OUT_OF_RANGE The specified resolution is out of range.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_OUT_OF_RANGE The specified @c resolution is out of the valid range.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
- * - In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
- * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
+ * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG or ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG as the key.
* @see GetCaptureResolution()
*/
result SetCaptureResolution(const Tizen::Graphics::Dimension& resolution);
- /**
+ /**
* Gets the resolution for capturing the data of the camera.
*
* @since 2.0
*/
Tizen::Graphics::Dimension GetCaptureResolution(void) const;
- /**
- * Gets a list of the capturing resolutions supported by the %Camera class. @n
+ /**
+ * Gets the list of capturing resolutions supported by %Camera. @n
* Each item of the list has a pointer of the Tizen::Graphics::Dimension value.
*
* @since 2.0
*
- * @return A list of the capture resolutions supported by the %Camera class @n
+ * @return The list of capture resolutions supported by %Camera @n
* else @c null if no capture resolution is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value and each item in the list must be deleted by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
* @see SetCaptureResolution()
- * @see GetCaptureResolution()
+ * @see GetCaptureResolution()
*/
Tizen::Base::Collection::IList* GetSupportedCaptureResolutionListN(void) const;
- /**
+ /**
* Sets the effect for the input data of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] effect The effect for the input data of the camera
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c effect is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
* - This method works correctly when PowerOn() is executed. @n
* For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm
- ">here</a>.
+ * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_EFFECT or @c CAMERA_SECONDARY_EFFECT keys.
- * @see GetEffect()
+ * using ::CAMERA_PRIMARY_EFFECT or ::CAMERA_SECONDARY_EFFECT as the key.
+ * @see GetEffect()
*/
result SetEffect(CameraEffect effect);
- /**
+ /**
* Gets the effect for the input data of the camera.
*
* @since 2.0
*/
CameraEffect GetEffect(void) const;
- /**
+ /**
* @if OSPDEPREC
* Sets the camera's flash.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the SetFlashMode() method.
+ * Instead of using this method, use the SetFlashMode() method.
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera.back.flash or %http://tizen.org/feature/camera.front.flash
+ * @feature %http://tizen.org/feature/camera.back.flash or
+ * %http://tizen.org/feature/camera.front.flash
*
* @return An error code
* @param[in] flashOn Set to @c true to switch on the flash light, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * -The flash is switched on when the camera captures a picture. If the value of @c flashOn is
- * set to @c true, this method returns @c E_UNSUPPORTED_OPERATION in the Emulator. @n
- * SetFlash(true) works same as SetFlashMode(CAMERA_FLASH_MODE_ON) and SetFlash(false) works same as SetFlashMode(CAMERA_FLASH_MODE_OFF).
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_FLASH or ::CAMERA_SECONDARY_SUPPORT_FLASH keys.
- * -In a zero-shutter-lag camera, only the default preview format applies this feature.
+ * - The flash is switched on when the camera captures a picture. If the value of @c flashOn is
+ * set to @c true, this method returns @c E_UNSUPPORTED_OPERATION in the Emulator. @n
+ * - SetFlash(true) works same as SetFlashMode(CAMERA_FLASH_MODE_ON) and SetFlash(false) works same as SetFlashMode(CAMERA_FLASH_MODE_OFF).
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * using ::CAMERA_PRIMARY_SUPPORT_FLASH or ::CAMERA_SECONDARY_SUPPORT_FLASH as the key.
+ * - In a zero-shutter-lag camera, only the default preview format applies this feature.
* @see IsFlashOn()
- * @see SetFlashMode()
- * @see CameraFlashMode
+ * @see SetFlashMode()
+ * @see CameraFlashMode
*
* @endif
*/
return SetFlashMode(flashMode);
}
- /**
+ /**
* @if OSPDEPREC
* Checks whether the camera's flash is switched on.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the GetFlashMode() method.
+ * Instead of using this method, use the GetFlashMode() method.
* @since 2.0
*
* @return @c true if the flash light is on, @n
* else @c false
* @remarks This method works same as return (GetFlashMode()!=CAMERA_FLASH_MODE_OFF).
* @see SetFlash()
- * @see GetFlashMode()
- * @see CameraFlashMode
+ * @see GetFlashMode()
+ * @see CameraFlashMode
* @endif
*/
bool IsFlashOn(void) const
return (GetFlashMode() != CAMERA_FLASH_MODE_OFF);
}
- /**
+ /**
* Sets the camera's flash mode.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera.back.flash or %http://tizen.org/feature/camera.front.flash
+ * @feature %http://tizen.org/feature/camera.back.flash or
+ * %http://tizen.org/feature/camera.front.flash
*
* @return An error code
- * @param[in] flashMode flash mode to switch on the flash light.
+ * @param[in] flashMode The flash mode to switch on the flash light.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_INVALID_ARG The specified flash mode is invalid.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_INVALID_ARG The specified @c flashMode is invalid.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c flashMode is not supported.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - Normally the flash splashes before the camera captures a picture. @n
- * @c CAMERA_FLASH_MODE_CONTINUOUS keeps the flash turned on after the method is called until @c CAMERA_FLASH_MODE_OFF is set.
- * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_FLASH_MODE or @c CAMERA_SECONDARY_FLASH_MODE keys.
- * - In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
- * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+ * - Normally the flash splashes before the camera captures a picture.
+ * - @c CAMERA_FLASH_MODE_CONTINUOUS keeps the flash turned on after the method is called until @c CAMERA_FLASH_MODE_OFF is set.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * using @c CAMERA_PRIMARY_FLASH_MODE or @c CAMERA_SECONDARY_FLASH_MODE as the key.
+ * - In a zero-shutter-lag camera, the default preview format applies this feature correctly. The other preview formats are not guaranteed.
+ * - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG or ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG as the key.
* @see GetFlashMode()
*/
result SetFlashMode(CameraFlashMode flashMode);
- /**
+ /**
* Gets the flash mode of the camera.
*
* @since 2.0
*
* @return The flash mode of the camera
- * @remarks If the %Camera doesn't support the flash mode, this method always returns @c CAMERA_FLASH_MODE_OFF.
+ * @remarks If the %Camera does not support the flash mode, this method always returns @c CAMERA_FLASH_MODE_OFF.
* @see SetFlashMode()
*/
CameraFlashMode GetFlashMode(void) const;
- /**
+ /**
* Sets the exposure level of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] exposure The camera exposure level @n
- * The range of this parameter is from @c 0 to @c 9.
+ * This parameter ranges from @c 0 to @c 9.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified exposure level is out of range.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_OUT_OF_RANGE The specified exposure level is out of the valid range.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - The default exposure level is @c 5.
- * - The supported range for exposure level is from @c 0 to @c 9.
- * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
- * - This method works correctly when PowerOn() is executed. @n
- * For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_EXPOSURE or ::CAMERA_SECONDARY_SUPPORT_EXPOSURE keys.
+ * - The default exposure level is @c 5.
+ * - The supported range for the exposure level is from @c 0 to @c 9.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
+ * using ::CAMERA_PRIMARY_SUPPORT_EXPOSURE or ::CAMERA_SECONDARY_SUPPORT_EXPOSURE as the key.
* @see GetExposure()
*/
result SetExposure(int exposure);
- /**
+ /**
* Gets the exposure level of the camera.
*
* @since 2.0
*
- * @return An integer value representing the exposure level of the camera @n
+ * @return The exposure level of the camera @n
* The returned value ranges from @c 0 to @c 9.
- * @remarks The supported range for exposure level is from @c 0 to @c 9.
+ * @remarks The supported range for the exposure level is from @c 0 to @c 9.
* @see SetExposure()
*/
int GetExposure(void) const;
- /**
+ /**
* Sets the white balance level of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] whiteBalance The camera white balance level
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c whiteBalance is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - The default white balance is @c CAMERA_WHITE_BALANCE_AUTO.
- * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
- * - This method works correctly when PowerOn() is executed. @n
- * For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_WHITE_BALANCE or @c CAMERA_SECONDARY_WHITE_BALANCE keys.
+ * - The default white balance is @c CAMERA_WHITE_BALANCE_AUTO.
+ * - This method returns @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * using ::CAMERA_PRIMARY_WHITE_BALANCE or ::CAMERA_SECONDARY_WHITE_BALANCE as the key.
* @see GetWhiteBalance()
*/
result SetWhiteBalance(CameraWhiteBalance whiteBalance);
- /**
+ /**
* Gets the white balance level of the camera.
*
* @since 2.0
*/
CameraWhiteBalance GetWhiteBalance(void) const;
- /**
+ /**
* Sets the capturing quality of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] quality The camera's quality level
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The specified @c quality is not supported.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - The default quality is @c CAMERA_QUALITY_NORMAL.
- * - This method works correctly when PowerOn() is executed. @n
- * For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - The default quality is @c CAMERA_QUALITY_NORMAL.
+ * - This method works correctly when PowerOn() is executed. @n
+ * For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see GetQuality()
*/
result SetQuality(CameraQuality quality);
- /**
+ /**
* Gets the capturing quality of the camera.
*
* @since 2.0
*/
CameraQuality GetQuality(void) const;
- /**
+ /**
* Sets the focus mode of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
- * @param[in] focusMode focus mode
+ * @param[in] focusMode The focus mode
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_INVALID_ARG The specified focus mode is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @exception E_UNSUPPORTED_TYPE The specified @c focusMode is not supported.
+ * @exception E_INVALID_ARG The specified @c focusMode is invalid.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_TYPE The specified @c focusMode is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - @c CAMERA_FOCUS_MODE_NONE always throws @c E_INVALID_ARG.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_FOCUS_MODE or @c CAMERA_SECONDARY_FOCUS_MODE keys.
- *
- * @see GetFocusMode()
+ * - @c CAMERA_FOCUS_MODE_NONE always throws @c E_INVALID_ARG.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * using ::CAMERA_PRIMARY_FOCUS_MODE or ::CAMERA_SECONDARY_FOCUS_MODE as the key.
+ * @see GetFocusMode()
*/
result SetFocusMode(CameraFocusMode focusMode);
- /**
+ /**
* Gets the focus mode of the camera.
*
* @since 2.0
*
* @return The %Camera focus mode
- * @remarks If the %Camera does not support the focus mode, this method always returns @c CAMERA_FOCUS_MODE_NONE.
- * @see SetFocusMode()
+ * @remarks If the %Camera does not support the focus mode, this method always returns @c CAMERA_FOCUS_MODE_NONE.
+ * @see SetFocusMode()
*/
CameraFocusMode GetFocusMode(void) const;
- /**
+ /**
* Sets the auto focus point list.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
- * @param[in] pointList The auto focus point list which consists of Tizen::Graphics::Point pointers
+ * @param[in] pointList The auto focus point list which consists of Tizen::Graphics::Point pointers
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
* @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE This method is not supported for the current focus mode.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - This method works fine when the current focus mode is ::CAMERA_FOCUS_MODE_NORMAL or ::CAMERA_FOCUS_MODE_MACRO.
- * - If the input parameter has a empty list, the focus area is changed to the center.
+ * - This method works fine when the current focus mode is ::CAMERA_FOCUS_MODE_NORMAL or ::CAMERA_FOCUS_MODE_MACRO.
+ * - If the input parameter has an empty list, the focus area is changed to the center.
* @see GetAutoFocusPointN()
*/
result SetAutoFocusPoint(const Tizen::Base::Collection::IList& pointList);
- /**
+ /**
* Gets the auto focus point list. @n
* Each item of the list has a pointer of the Tizen::Graphics::Point value.
*
* @since 2.0
*
* @return The %Camera auto focus point list @n
- * A list of points that represent the auto focus point, @n
- * else @c null if no auto focus point is set or if an exception occurs.
+ * The list of points that represent the auto focus point, @n
+ * else @c null if no auto focus point is set or an exception occurs.
* @exception E_SUCCESS The method is successful.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value and each item in the list must be deleted by the caller.
- * @see SetAutoFocusPoint()
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value and each item in the list must be deleted by the caller.
+ * @see SetAutoFocusPoint()
*/
Tizen::Base::Collection::IList* GetAutoFocusPointN(void) const;
- /**
+ /**
* Sets the auto focus mode of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] callback Set to @c true to enable auto focus callback, @n
* else @c false
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
* - If @c callback is set to @c false, the ICameraEventListener::OnCameraAutoFocused() method is not called.
- * - This method throws @c E_UNSUPPORTED_OPERATION in the emulator.
+ * - This method throws @c E_UNSUPPORTED_OPERATION in the Emulator.
* - For more information on the relationship between this method and the PowerOn() method, and the
* state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValue(const Tizen::Base::String& key, bool& value)
- * with ::CAMERA_PRIMARY_SUPPORT_FOCUS or ::CAMERA_SECONDARY_SUPPORT_FOCUS keys.
+ * using ::CAMERA_PRIMARY_SUPPORT_FOCUS or ::CAMERA_SECONDARY_SUPPORT_FOCUS as the key.
*/
result SetAutoFocus(bool callback);
- /**
+ /**
* Sets the capturing format of the camera. @n
* Initially, the default format is set using the internal configuration.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] format The camera's capture format @n
* @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.
- * @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c format is not supported.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks This method works correctly when PowerOn() is executed.
*/
result SetCaptureFormat(Tizen::Graphics::PixelFormat format);
- /**
+ /**
* Gets the capturing format of the camera.
*
* @since 2.0
*
* @return The capturing format of the camera
* @see SetCaptureFormat()
- * @see GetSupportedCaptureFormatListN()
+ * @see GetSupportedCaptureFormatListN()
*/
Tizen::Graphics::PixelFormat GetCaptureFormat(void) const;
- /**
- * Gets the supported capturing format list for the %Camera class. @n
+ /**
+ * Gets the supported capturing format list for %Camera. @n
* Each list item has a Tizen::Graphics::PixelFormat value.
*
* @since 2.0
*
- * @return A list of the formats supported by the %Camera class, @n
+ * @return The list of the formats supported by %Camera, @n
* else @c null if no capture format is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted.
* @see SetCaptureFormat()
- * @see GetCaptureFormat()
+ * @see GetCaptureFormat()
*/
Tizen::Base::Collection::IListT <Tizen::Graphics::PixelFormat>* GetSupportedCaptureFormatListN(void) const;
- /**
+ /**
* Sets the preview format of the camera. @n
* Initially, the default format is set using the internal configuration.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] format The camera's preview format @n
* @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.
- * @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c format is not supported.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - This method works in ::CAMERA_STATE_INITIALIZED state.
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - This method works in the ::CAMERA_STATE_INITIALIZED state.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see GetPreviewFormat()
- * @see GetSupportedPreviewFormatListN()
+ * @see GetSupportedPreviewFormatListN()
*/
result SetPreviewFormat(Tizen::Graphics::PixelFormat format);
- /**
+ /**
* Gets the preview format of the camera.
*
* @since 2.0
*
* @return The preview format of the camera
* @see SetPreviewFormat()
- * @see GetSupportedPreviewFormatListN()
+ * @see GetSupportedPreviewFormatListN()
*/
Tizen::Graphics::PixelFormat GetPreviewFormat(void) const;
- /**
- * Gets the supported preview format list for the %Camera class. @n
+ /**
+ * Gets the supported preview format list for %Camera. @n
* Each list item has a Tizen::Graphics::PixelFormat value.
*
* @since 2.0
*
- * @return A list of the preview format supported by the %Camera class, @n
+ * @return The list of the preview formats supported by %Camera, @n
* else @c null if no preview format is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted.
* @see SetPreviewFormat()
- * @see GetPreviewFormat()
+ * @see GetPreviewFormat()
*/
Tizen::Base::Collection::IListT <Tizen::Graphics::PixelFormat>* GetSupportedPreviewFormatListN(void) const;
- /**
+ /**
* Sets the ISO level of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] isoLevel The camera's ISO level @n
* The default ISO level is set from the internal configuration.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified ISO level is out of range.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_OUT_OF_RANGE The specified @c isoLevel is out of the valid range.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c isoLevel is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - In some devices this method works in the ::CAMERA_STATE_PREVIEW state.
- * - This method throws @c E_UNSUPPORTED_OPERATION in the Emulator.
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
- * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_ISO_LEVEL or @c CAMERA_SECONDARY_ISO_LEVEL keys.
+ * - In some devices this method works in the ::CAMERA_STATE_PREVIEW state.
+ * - This method throws @c E_UNSUPPORTED_OPERATION in the Emulator.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
+ * using ::CAMERA_PRIMARY_ISO_LEVEL or ::CAMERA_SECONDARY_ISO_LEVEL as the key.
* @see GetIsoLevel()
*/
result SetIsoLevel(CameraIsoLevel isoLevel);
- /**
+ /**
* Gets the ISO level of the camera.
*
* @since 2.0
*/
CameraIsoLevel GetIsoLevel(void) const;
- /**
+ /**
* Sets the preview frame rate of the camera. @n
* Initially, the default frame rate is set using the internal configuration.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] fps The frame rate per second @n
* It must be one of the fps extracted using GetSupportedPreviewFrameRateListN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified @c fps is out of range on this device.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_OUT_OF_RANGE The specified @c fps is out of the valid range for this device.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - This method works in ::CAMERA_STATE_INITIALIZED state.
- * - For more information on the relationship between this method and the PowerOn() method, and the
- * state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
+ * - This method works in the ::CAMERA_STATE_INITIALIZED state.
+ * - For more information on the relationship between this method and the PowerOn() method, and the
+ *
state transition caused by this method, see <a href="../org.tizen.native.appprogramming/html/guide/media/launching_camera.htm">here</a>.
* @see GetPreviewFrameRate()
*/
result SetPreviewFrameRate(int fps);
- /**
+ /**
* Gets the frame rate of the camera.
*
* @since 2.0
*
* @return The frame rate of the camera @n
- * If the frame rate is not set using SetPreviewFrameRate(), the system-dependent default frame rate is returned.
+ * If the frame rate is not set using SetPreviewFrameRate(), the system-dependent default frame rate is returned.
* @see GetSupportedPreviewFrameRateListN()
*/
int GetPreviewFrameRate(void) const;
- /**
- * Gets the supported preview frame rate list for the %Camera class. @n
+ /**
+ * Gets the supported preview frame rate list for %Camera. @n
* Each list item has an integer value.
*
* @since 2.0
*
- * @return A list of the preview frame rate supported by the %Camera class, @n
+ * @return The list of preview frame rates supported by %Camera, @n
* else @c null if no frame rate is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted by the caller.
- * - This method returns fps list that can be supported by all resolutions.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted by the caller.
+ * - This method returns the fps list that is supported by all the resolutions.
* @see SetPreviewFrameRate()
- * @see GetPreviewFrameRate()
- * @see FRAME_RATE_AUTO
+ * @see GetPreviewFrameRate()
+ * @see FRAME_RATE_AUTO
* @see GetSupportedPreviewFrameRateListN(const Tizen::Graphics::Dimension& dim) const
*/
Tizen::Base::Collection::IListT <int>* GetSupportedPreviewFrameRateListN(void) const;
- /**
- * Gets the supported preview frame rate list of the input resolution of the %Camera class. @n
+ /**
+ * Gets the supported preview frame rate list that contains the input resolution of %Camera. @n
* Each item of the list has an integer value.
*
* @since 2.0
*
- * @return A list of the preview frame rate of the input preview resolution, @n
- * else @c null if no frame rate is supported or if an exception occurs
+ * @return The list of supported preview frame rates containing the input preview resolution, @n
+ * else @c null if no frame rate is supported or an exception occurs
* @param[in] dim The preview resolution of the camera
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG The specified input resolution is invalid.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted by the caller.
* @see SetPreviewFrameRate()
- * @see GetPreviewFrameRate()
+ * @see GetPreviewFrameRate()
* @see GetSupportedPreviewFrameRateListN(void) const
*/
Tizen::Base::Collection::IListT <int>* GetSupportedPreviewFrameRateListN(const Tizen::Graphics::Dimension& dim) const;
- /**
+ /**
* Sets the orientation value in the Exchangeable Image File Format (EXIF) field of the captured data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
- * @param[in] orientation The orientation value to set in EXIF
+ * @param[in] orientation The orientation value to set in EXIF @n
+ * The default value is @c CAMERA_EXIF_ORIENTATION_TOP_LEFT.
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_OUT_OF_RANGE The specified inout parameter is out of the valid range.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @remarks
- * - The default value of orientation is @c CAMERA_EXIF_ORIENTATION_TOP_LEFT.
- * - This method works correctly when PowerOn() is executed. The orientation value set by this method can be obtained using the
- * Tizen::Content::ImageData::GetOrientation() method after writing the captured data to a file.
+ * - This method works correctly when PowerOn() is executed.
+ * - The orientation value set by this method can be obtained using the
+ * Tizen::Content::ImageData::GetOrientation() method after writing the captured data to a file.
*/
result SetExifOrientation(CameraExifOrientation orientation);
- /**
- * Sets the GPS coordinates in the Exchangeable %Image File Format (EXIF) field for the captured data.
+ /**
+ * Sets the GPS coordinates in the Exchangeable %Image File Format (EXIF) field of the captured data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] latitude The latitude value to set in EXIF @n
* The valid range is [-90.0, 90.0].
* @param[in] longitude The longitude value to set in EXIF @n
- * The valid range is [-180.0, 180.0]
+ * The valid range is [-180.0, 180.0].
* @param[in] altitude The altitude value to set in EXIF
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_OUT_OF_RANGE A specified input parameter is out of the valid range.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @remarks
- * - This method sets the GPS coordinates and enables entering the coordinates into the Exchangeable Image File Format (EXIF).
- * -By default, the GPS coordinates are not entered in JPEG's EXIF.
- * - The GPS coordinates that are set using this method are entered in every call to the
- * Capture() method, until DisableExifGpsCoordinates() is called or this instance is destroyed.
- * - This method works correctly when PowerOn() is executed.
- * - The values set by this method can result in an error as compared to the values stored in the Exchangeable Image File Format (EXIF) field.
+ * - This method sets the GPS coordinates and enables entering the coordinates into the Exchangeable Image File Format (EXIF).
+ * - By default, the GPS coordinates are not entered in JPEG's EXIF.
+ * - The GPS coordinates that are set using this method are entered in every call to the
+ * Capture() method, until DisableExifGpsCoordinates() is called or this instance is destroyed.
+ * - This method works correctly when PowerOn() is executed.
+ * - The values set by this method can result in an error as compared to the values stored in the Exchangeable Image File Format (EXIF) field.
*/
result SetExifGpsCoordinates(double latitude, double longitude, float altitude);
- /**
- * Disables the insertion of the GPS coordinates in the Exchangeable %Image File Format (EXIF) field for the captured data.
+ /**
+ * Disables the insertion of the GPS coordinates in the Exchangeable %Image File Format (EXIF) field of the captured data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_SYSTEM A system error has occurred.
* @see SetExifGpsCoordinates()
*/
result DisableExifGpsCoordinates(void);
- /**
+ /**
* Sets the flip type for the previewed and captured data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] flip The camera flip type
* @exception E_SUCCESS The method is successful.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_INVALID_ARG The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_INVALID_ARG The specified input parameter is out of the valid range.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
* @exception E_UNSUPPORTED_TYPE The specified @c flip is not supported.
* @exception E_SYSTEM A system error has occurred.
* @remarks
* - This method works in the ::CAMERA_STATE_INITIALIZED state.
- * - Finally the last specified type is applied even with the several types applicable.
+ * - Finally the last specified type is applied with all the applicable types.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_FLIP or @c CAMERA_SECONDARY_FLIP keys.
- * - In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
+ * using ::CAMERA_PRIMARY_FLIP or ::CAMERA_SECONDARY_FLIP as the key.
+ * - In a zero-shutter-lag camera, the default preview format does not guarantee the correct application of this feature.
* - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG or ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG as the key.
* @see GetFlip()
*/
result SetFlip(CameraFlipType flip);
- /**
+ /**
* Gets the flip type for the previewed and captured data.
*
* @since 2.0
*
* @return The camera flip type
- * @see SetFlip()
+ * @see SetFlip()
*/
CameraFlipType GetFlip(void) const;
- /**
+ /**
* Sets the rotation for the previewed data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
- *
- * @return An error code
- * @param[in] rotation The camera rotation
- * @exception E_SUCCESS The method is successful.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_INVALID_ARG The input value is out of range.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @exception E_UNSUPPORTED_TYPE The specified @c rotation is not supported.
- * @exception E_SYSTEM A system error has occurred.
+ * @feature %http://tizen.org/feature/camera
+ *
+ * @return An error code
+ * @param[in] rotation The camera rotation
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_INVALID_ARG The specified input parameter is out of the valid range.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_TYPE The specified @c rotation is not supported.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks
* - This method works in the ::CAMERA_STATE_INITIALIZED state.
- * - The last specified type is applied even with the several types applicable.
+ * - The last specified type is applied with all the available types.
* - This method rotates the preview and recording data but not the captured image. @n
- * The captured image's orientation is always following the physical rotation.
+ * The captured image's orientation always follows the physical rotation.
* - When the preview is rotated, the preview callback data's width and height can be changed. @n
- * Thus the application must recognize these changes when it uses the preview data in ICameraEventListener::OnCameraPreviewed() callback.
- * - For the intended view of preview, Tizen::Ui::Controls::OverlayRegion::OVERLAY_REGION_TYPE_NORMAL must be selected when
+ * Thus the application must recognize these changes when it uses the preview data in the ICameraEventListener::OnCameraPreviewed() method's callback.
+ * - For the intended view of the preview, Tizen::Ui::Controls::OverlayRegion::OVERLAY_REGION_TYPE_NORMAL must be selected when
* Tizen::Ui::Controls::OverlayRegion is created.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_PREVIEW_ROTATION or @c CAMERA_SECONDARY_PREVIEW_ROTATION keys.
- * - In a zero-shutter-lag camera, the default preview format is not guaranteed to apply this feature correctly.
+ * using ::CAMERA_PRIMARY_PREVIEW_ROTATION or ::CAMERA_SECONDARY_PREVIEW_ROTATION as the key.
+ * - In a zero-shutter-lag camera, the default preview format does not guarantee the correct application of this feature.
* - The zero-shutter-lag capability can be checked using MediaCapability::GetValue(const Tizen::Base::String& key, bool& value) with
- * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG, ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG keys.
- * @see GetPreviewRotation()
+ * ::CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG or ::CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG as the key.
+ * @see GetPreviewRotation()
*
*/
result SetPreviewRotation(CameraRotation rotation);
- /**
- *
+ /**
* Gets the rotation for the previewed data.
*
* @since 2.0
*
- * @return The camera rotation
- * @see SetPreviewRotation()
+ * @return The camera rotation
+ * @see SetPreviewRotation()
*
*/
CameraRotation GetPreviewRotation(void) const;
- /**
+ /**
* Sets the metering mode of the camera.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
* @param[in] meteringMode The metering mode
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The camera is under use by other application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
* @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_INVALID_ARG The specified metering mode is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @exception E_UNSUPPORTED_TYPE The specified @c meteringMode is not supported.
+ * @exception E_INVALID_ARG The specified @c meteringMode is invalid.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_TYPE The specified @c meteringMode is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
* - @c CAMERA_METERING_MODE_NONE always throws @c E_INVALID_ARG.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_METERING_MODE or @c CAMERA_SECONDARY_METERING_MODE keys.
- * @see GetMeteringMode()
+ * with ::CAMERA_PRIMARY_METERING_MODE or ::CAMERA_SECONDARY_METERING_MODE as the key.
+ * @see GetMeteringMode()
*/
result SetMeteringMode(CameraMeteringMode meteringMode);
- /**
+ /**
* Gets the metering mode of the camera.
*
* @since 2.0
*
* @return The %Camera metering mode
- * @remarks If the %Camera does not support the metering mode, this method always returns @c CAMERA_METERING_MODE_NONE.
- * @see SetMeteringMode()
+ * @remarks If the %Camera does not support the metering mode, this method always returns @c CAMERA_METERING_MODE_NONE.
+ * @see SetMeteringMode()
*/
CameraMeteringMode GetMeteringMode(void) const;
- /**
+ /**
* Sets the scene mode of the camera.
*
* @since 2.1
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
- *
- * @return An error code
- * @param[in] sceneMode The scene mode
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The camera is under use by another application.
- * @exception E_DEVICE_UNAVAILABLE The camera becomes unavailable.
- * @exception E_DEVICE_FAILED The device operation has failed.
- * @exception E_INVALID_ARG The specified @c sceneMode is invalid.
- * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @exception E_UNSUPPORTED_TYPE The specified @c sceneMode is not supported.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @feature %http://tizen.org/feature/camera
+ *
+ * @return An error code
+ * @param[in] sceneMode The scene mode
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_DEVICE_BUSY The camera is being used by another application.
+ * @exception E_DEVICE_UNAVAILABLE The camera is unavailable.
+ * @exception E_DEVICE_FAILED The device operation has failed.
+ * @exception E_INVALID_ARG The specified @c sceneMode is invalid.
+ * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @exception E_UNSUPPORTED_TYPE The specified @c sceneMode is not supported.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - In a specific scene mode, camera's attributes such as brightness, metering mode, iso level, white balance, flash, and focus are changed
+ * - In a specific scene mode, the camera's attributes such as brightness, metering mode, iso level, white balance, flash, and focus are changed
* to the ones that are pre-defined by each scene mode.
* - In a specific scene mode, if an application sets any attribute that is related to the scene, the mode can be changed to @c CAMERA_SCENE_OFF. @n
- * Thus, it is recommended that the application check the current scene mode after setting the attributes. @n
- * In case that the scene mode is changed to @c CAMERA_SCENE_OFF, all the attributes set by the application are reloaded.
+ * Thus, it is recommended that the application checks the current scene mode after setting the attributes. @n
+ * In case the scene mode is changed to @c CAMERA_SCENE_OFF, all the attributes set by the application are reloaded.
* - Before calling this method, check whether the feature is supported by MediaCapability::GetValueN(const Tizen::Base::String& key)
- * with @c CAMERA_PRIMARY_SCENE_MODE or @c CAMERA_SECONDARY_SCENE_MODE keys.
+ * with ::CAMERA_PRIMARY_SCENE_MODE or ::CAMERA_SECONDARY_SCENE_MODE as the key.
*/
- result SetSceneMode(CameraSceneMode sceneMode);
+ result SetSceneMode(CameraSceneMode sceneMode);
- /**
- * Gets the scene mode of the camera.
- *
- * @since 2.1
- *
- * @return The %Camera scene mode
- */
- CameraSceneMode GetSceneMode(void) const;
+ /**
+ * Gets the scene mode of the camera.
+ *
+ * @since 2.1
+ *
+ * @return The %Camera scene mode
+ */
+ CameraSceneMode GetSceneMode(void) const;
- /**
+ /**
* Adds the stream filter to process the video stream data while previewing or recording.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
- * @param[in] filter An instance of IVideoStreamFilter
- * @exception E_SUCCESS The method is successful.
+ * @param[in] filter An instance of IVideoStreamFilter
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The filter already exists.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks IVideoStreamFilter::ProcessVideoStream() will be called when the video frame is ready.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks IVideoStreamFilter::ProcessVideoStream() is called when the video frame is ready.
*/
result AddVideoStreamFilter(Tizen::Media::IVideoStreamFilter& filter);
- /**
- * Removes the stream filter to stop receiving the video stream data.
+ /**
+ * Removes the stream filter to stop receiving video stream data.
*
* @since 2.1
* @privlevel public
* @privilege %http://tizen.org/privilege/camera
- * @feature %http://tizen.org/feature/camera
+ * @feature %http://tizen.org/feature/camera
*
* @return An error code
- * @param[in] filter An instance of IVideoStreamFilter
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The filter is not found.
+ * @param[in] filter An instance of IVideoStreamFilter
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The filter is not found.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. @n
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ *
For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
*/
result RemoveVideoStreamFilter(Tizen::Media::IVideoStreamFilter& filter);
- /**
- * This value can be used to set the preview frame rate by using the SetPreviewFrameRate() method. @n
- * If the preview frame rate is set using this value, the frame rate during the preview is automatically adjusted as per the light condition.
- *
- * @since 2.0
- */
+ /**
+ * This value can be used to set the preview frame rate by using the SetPreviewFrameRate() method. @n
+ * If the preview frame rate is set using this value, the frame rate during the preview is automatically adjusted as per the light condition.
+ *
+ * @since 2.0
+ */
static const int FRAME_RATE_AUTO = 0xFFFFFFFF;
private:
//
/**
- * @file FMediaCameraTypes.h
- * @brief This is the header file for the enumerations of the Camera class.
+ * @file FMediaCameraTypes.h
+ * @brief This is the header file for the enumerations of the %Camera class.
*
* This header file contains the definitions of the enumerations of the Camera class.
*/
enum CameraSelection
{
CAMERA_PRIMARY, /**< The primary camera */
- CAMERA_SECONDARY, /**< The secondary camera */
+ CAMERA_SECONDARY, /**< The secondary camera */
};
/**
*
* @since 2.0
*
- * @remarks The capturing quality of the camera cannot be set to CAMERA_QUALITY_MAX.
+ * @remarks The capturing quality of the camera cannot be set to @c CAMERA_QUALITY_MAX.
* @see Camera::GetQuality()
* @see Camera::SetQuality()
*/
/**
* @enum CameraErrorReason
*
- * Defines the reason for the camera error.
+ * Defines the reason for a camera error.
*
* @since 2.0
*/
CAMERA_ERROR_NONE, // The undefined error
CAMERA_ERROR_OUT_OF_MEMORY, /**< The insufficient memory error */
CAMERA_ERROR_DEVICE_FAILED, /**< The camera device failed error */
- CAMERA_ERROR_DEVICE_INTERRUPTED, /**< The camera device interrupted error */
+ CAMERA_ERROR_DEVICE_INTERRUPTED, /**< The camera device interrupted error */
};
enum CameraRotation
{
CAMERA_ROTATION_NONE = 0x01, /**< The camera's rotation: None */
- CAMERA_ROTATION_90, /**< The camera's rotation: 90 degree rotation */
- CAMERA_ROTATION_180, /**< The camera's rotation: 180 degree rotation */
- CAMERA_ROTATION_270, /**< The camera's rotation: 270 degree rotation */
+ CAMERA_ROTATION_90, /**< The camera's rotation: 90 degree rotation */
+ CAMERA_ROTATION_180, /**< The camera's rotation: 180 degree rotation */
+ CAMERA_ROTATION_270, /**< The camera's rotation: 270 degree rotation */
};
/**
*/
enum CameraExifOrientation
{
- CAMERA_EXIF_ORIENTATION_TOP_LEFT = 0x01, /**< The row #0 is top, column #0 is left */
- CAMERA_EXIF_ORIENTATION_TOP_RIGHT, /**< The row #0 is top, column #0 is right */
- CAMERA_EXIF_ORIENTATION_BOTTOM_RIGHT, /**< The row #0 is bottom, column #0 is right */
- CAMERA_EXIF_ORIENTATION_BOTTOM_LEFT, /**< The row #0 is bottom, column #0 is left */
- CAMERA_EXIF_ORIENTATION_LEFT_TOP, /**< The row #0 is left, column #0 is top */
- CAMERA_EXIF_ORIENTATION_RIGHT_TOP, /**< The row #0 is right, column #0 is top */
- CAMERA_EXIF_ORIENTATION_RIGHT_BOTTOM, /**< The row #0 is right, column #0 is bottom */
- CAMERA_EXIF_ORIENTATION_LEFT_BOTTOM, /**< The row #0 is left, column #0 is bottom */
+ CAMERA_EXIF_ORIENTATION_TOP_LEFT = 0x01, /**< The 0th row is on the top, the 0th column is to the left */
+ CAMERA_EXIF_ORIENTATION_TOP_RIGHT, /**< The 0th row is on the top, the 0th column is to the right */
+ CAMERA_EXIF_ORIENTATION_BOTTOM_RIGHT, /**< The 0th row is at the bottom, the 0th column is to the right */
+ CAMERA_EXIF_ORIENTATION_BOTTOM_LEFT, /**< The 0th row is at the bottom, the 0th column is to the left */
+ CAMERA_EXIF_ORIENTATION_LEFT_TOP, /**< The 0th row is to the left, the 0th column is on the top */
+ CAMERA_EXIF_ORIENTATION_RIGHT_TOP, /**< The 0th row is to the right, the 0th column is on the top */
+ CAMERA_EXIF_ORIENTATION_RIGHT_BOTTOM, /**< The 0th row is to the right, the 0th column is at the bottom */
+ CAMERA_EXIF_ORIENTATION_LEFT_BOTTOM, /**< The 0th row is to the left, the 0th column is at the bottom */
};
/**
*/
enum CameraFlipType
{
- CAMERA_FLIP_NONE, /**< The camera's flip type: None*/
- CAMERA_FLIP_HORIZONTAL, /**< The camera's flip type: Horizontal*/
- CAMERA_FLIP_VERTICAL, /**< The camera's flip type: Vertical*/
+ CAMERA_FLIP_NONE, /**< The camera's flip type: None */
+ CAMERA_FLIP_HORIZONTAL, /**< The camera's flip type: Horizontal */
+ CAMERA_FLIP_VERTICAL, /**< The camera's flip type: Vertical */
};
/**
* @enum CameraFocusMode
*
- * Defines the camera focus mode.
+ * Defines the camera's focus mode.
* @since 2.0
*/
enum CameraFocusMode
{
- CAMERA_FOCUS_MODE_NONE, /**< The camera's focus mode: None*/
- CAMERA_FOCUS_MODE_NORMAL, /**< The camera's focus mode: Normal*/
- CAMERA_FOCUS_MODE_MACRO, /**< The camera's focus mode: Macro*/
- CAMERA_FOCUS_MODE_CONTINUOUS_AUTO, /**< The camera's focus mode: Continuous auto*/
- CAMERA_FOCUS_MODE_INFINITE, /**< The camera's focus mode: Infinite*/
+ CAMERA_FOCUS_MODE_NONE, /**< The camera's focus mode: None */
+ CAMERA_FOCUS_MODE_NORMAL, /**< The camera's focus mode: Normal */
+ CAMERA_FOCUS_MODE_MACRO, /**< The camera's focus mode: Macro */
+ CAMERA_FOCUS_MODE_CONTINUOUS_AUTO, /**< The camera's focus mode: Continuous auto */
+ CAMERA_FOCUS_MODE_INFINITE, /**< The camera's focus mode: Infinite */
};
/**
* @enum CameraFlashMode
*
- * Defines the camera flash mode.
+ * Defines the camera's flash mode.
* @since 2.0
*/
enum CameraFlashMode
{
- CAMERA_FLASH_MODE_OFF, /**< Flash off */
- CAMERA_FLASH_MODE_ON, /**< Flash splashes before capturing*/
- CAMERA_FLASH_MODE_AUTO, /**< Flash splashes depending on intensity of light before capturing */
- CAMERA_FLASH_MODE_RED_EYE_REDUCTION, /**< Flash splashes multiple times before capturing for red eye reduction. */
- CAMERA_FLASH_MODE_CONTINUOUS, /**< Flash keeps turned on until turning off */
+ CAMERA_FLASH_MODE_OFF, /**< Flash off */
+ CAMERA_FLASH_MODE_ON, /**< Flash splashes before capturing */
+ CAMERA_FLASH_MODE_AUTO, /**< Flash splashes depending on the intensity of the light before capturing */
+ CAMERA_FLASH_MODE_RED_EYE_REDUCTION, /**< Flash splashes multiple times before capturing for red eye reduction */
+ CAMERA_FLASH_MODE_CONTINUOUS, /**< Flash is kept on until it is turned off */
};
/**
* @enum CameraMeteringMode
*
-* Defines the camera metering mode.
+* Defines the camera's metering mode.
* @since 2.0
*/
enum CameraMeteringMode
{
- CAMERA_METERING_MODE_NONE, /**< No metering mode */
- CAMERA_METERING_MODE_AVERAGE, /**< Average metering mode that uses information of entire scene */
- CAMERA_METERING_MODE_CENTER_WEIGHTED, /**< Center weighted average metering mode that uses information of central part of the scene */
- CAMERA_METERING_MODE_SPOT, /**< Spot metering mode that uses information of very small area of the scene */
+ CAMERA_METERING_MODE_NONE, /**< No metering mode */
+ CAMERA_METERING_MODE_AVERAGE, /**< Average metering mode that uses the information of the entire scene */
+ CAMERA_METERING_MODE_CENTER_WEIGHTED, /**< Center weighted average metering mode that uses the information of the central part of the scene */
+ CAMERA_METERING_MODE_SPOT, /**< Spot metering mode that uses the information of very small areas in the scene */
};
/**
* @enum CameraSceneMode
*
-* Defines the camera scene mode.
+* Defines the camera's scene mode.
* @since 2.1
*/
enum CameraSceneMode
{
- CAMERA_SCENE_OFF, /**< No specific scene @n Scene mode is off. */
- CAMERA_SCENE_PORTRAIT, /**< The camera scene mode: Potrait */
- CAMERA_SCENE_LANDSCAPE, /**< The camera scene mode: Landscape */
- CAMERA_SCENE_SPORTS, /**< The camera scene mode: Sports */
- CAMERA_SCENE_PARTY_INDOOR, /**< The camera scene mode: Indoor */
- CAMERA_SCENE_BEACH_SHOW, /**< The camera scene mode: Beach */
- CAMERA_SCENE_SUNSET, /**< The camera scene mode: Sunset */
- CAMERA_SCENE_DUSK_DAWN, /**< The camera scene mode: Dusk-Dawn */
- CAMERA_SCENE_AUTUMN_COLOR, /**< The camera scene mode: Autumn color*/
- CAMERA_SCENE_NIGHT, /**< The camera scene mode: Night */
- CAMERA_SCENE_FIREWORK, /**< The camera scene mode: Firework */
- CAMERA_SCENE_TEXT, /**< The camera scene mode: Text */
- CAMERA_SCENE_SHOW_WINDOW, /**< The camera scene mode: Show-window */
- CAMERA_SCENE_CANDLELIGHT, /**< The camera scene mode: Candle light */
- CAMERA_SCENE_BACKLIGHT /**< The camera scene mode: Backlight */
+ CAMERA_SCENE_OFF, /**< No specific scene @n The scene mode is off */
+ CAMERA_SCENE_PORTRAIT, /**< The camera's scene mode: Potrait */
+ CAMERA_SCENE_LANDSCAPE, /**< The camera's scene mode: Landscape */
+ CAMERA_SCENE_SPORTS, /**< The camera's scene mode: Sports */
+ CAMERA_SCENE_PARTY_INDOOR, /**< The camera's scene mode: Indoor */
+ CAMERA_SCENE_BEACH_SHOW, /**< The camera's scene mode: Beach */
+ CAMERA_SCENE_SUNSET, /**< The camera's scene mode: Sunset */
+ CAMERA_SCENE_DUSK_DAWN, /**< The camera's scene mode: Dusk-Dawn */
+ CAMERA_SCENE_AUTUMN_COLOR, /**< The camera's scene mode: Autumn color */
+ CAMERA_SCENE_NIGHT, /**< The camera's scene mode: Night */
+ CAMERA_SCENE_FIREWORK, /**< The camera's scene mode: Firework */
+ CAMERA_SCENE_TEXT, /**< The camera's scene mode: Text */
+ CAMERA_SCENE_SHOW_WINDOW, /**< The camera's scene mode: Show-window */
+ CAMERA_SCENE_CANDLELIGHT, /**< The camera's scene mode: Candlelight */
+ CAMERA_SCENE_BACKLIGHT /**< The camera's scene mode: Backlight */
};
//
/**
- * @file FMediaCapability.h
- * @brief This is the header file for the %MediaCapability class.
+ * @file FMediaCapability.h
+ * @brief This is the header file for the %MediaCapability class.
*
* This header file contains the declarations of the %MediaCapability class.
*/
/**
* @class MediaCapability
- * @brief This class provides capability information of the various classes in the %Media namespace.
+ * @brief This class provides the capability information of various classes in the %Media namespace.
*
* @since 2.0
*
*
- * The %MediaCapability class provides capability information of the various classes in the Media namespace.
+ * The %MediaCapability class provides the capability information of various classes in the Media namespace.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm">Media Capabilities</a>.
*
// Operations
public:
- /**
- * Gets the capability value.
+ /**
+ * Gets the capability value.
*
* @since 2.0
*
- * @return An error code on failure, @n
- * else E_SUCCESS
- *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
- * @param[out] value The retrieved capability information
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @return @c E_SUCCESS, @n
+ * else an error code if it fails
+ *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
+ * @param[out] value The retrieved capability information
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result GetValue(const Tizen::Base::String& key, bool& value);
- /**
- * Gets the capability value.
+ /**
+ * Gets the capability value.
*
* @since 2.0
*
- * @return An error code on failure, @n
- * else E_SUCCESS
- *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
- * @param[out] value The retrieved capability information
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @return @c E_SUCCESS, @n
+ * else an error code if it fails
+ *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
+ * @param[out] value The retrieved capability information
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result GetValue(const Tizen::Base::String& key, int& value);
- /**
- * Gets the capability value.
+ /**
+ * Gets the capability value.
*
* @since 2.0
*
- * @return An error code on failure, @n
- * else E_SUCCESS
- *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
- * @param[out] value The retrieved capability information
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @return An error code on failure, @n
+ * else @c E_SUCCESS
+ *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
+ * @param[out] value The retrieved capability information
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result GetValue(const Tizen::Base::String& key, long long& value);
- /**
- * Gets the capability value.
+ /**
+ * Gets the capability value.
*
* @since 2.0
*
- * @return An error code on failure, @n
- * else E_SUCCESS
- *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
- * @param[out] value The retrieved capability information
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @return @c E_SUCCESS, @n
+ * else an error code if it fails
+ *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
+ * @param[out] value The retrieved capability information
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result GetValue(const Tizen::Base::String& key, double& value);
- /**
- * Gets the capability value.
+ /**
+ * Gets the capability value.
*
* @since 2.0
*
- * @return An error code on failure, @n
- * else E_SUCCESS
- *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
- * @param[out] value The retrieved capability information
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
+ * @return @c E_SUCCESS, @n
+ * else an error code if it fails
+ *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
+ * @param[out] value The retrieved capability information
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
*/
static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value);
- /**
- * Gets the capability value.
+ /**
+ * Gets the capability value.
*
* @since 2.0
*
- * @return A pointer to Tizen::Base::Collection::IList on success, @n
- * else @c null
- *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks
+ * @return A pointer to Tizen::Base::Collection::IList, @n
+ * else @c null if it fails
+ *
@param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/media_capabilities.htm#media_capabilities">key name</a> of the media capability
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - If the type of a key is 'List, type', use GetValueN(). @n
* For example, 'List, String', 'List, Integer'.
/**
* @file FMediaCapabilityTypes.h
- * @brief This is the header file for the common data of the MediaCapability class.
+ * @brief This is the header file for the common data of the %MediaCapability class.
*
- * This header file contains the declarations of common data of the MediaCapability class.
+ * This header file contains the declarations of the common data of the MediaCapability class.
*/
#ifndef _FMEDIA_CAPABILITY_TYPES_H_
{
/**
-* The property key to check the list of the supported sample rates of AudioIn.
-*
-* @since 2.0
-*/
+ * The property key to check the list of supported sample rates of AudioIn.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const AUDIOIN_SAMPLE_RATE;
/**
-* The property key to check the list of the supported sample types of AudioIn.
-*
-* @since 2.0
-*/
+ * The property key to check the list of supported sample types of AudioIn.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const AUDIOIN_SAMPLE_TYPE;
/**
-* The property key to check the maximum instance count that AudioOut can construct.
-*
-* @since 2.0
-*/
+ * The property key to check the maximum instance count that AudioOut can construct.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const AUDIOOUT_COUNT_MAX;
/**
-* The property key to check the list of the supported sample rates of AudioOut.
-*
-* @since 2.0
-*/
+ * The property key to check the list of supported sample rates of AudioOut.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const AUDIOOUT_SAMPLE_RATE;
/**
-* The property key to check the list of the supported sample types of AudioOut.
-*
-* @since 2.0
-*/
+ * The property key to check the list of supported sample types of AudioOut.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const AUDIOOUT_SAMPLE_TYPE;
/**
-* The property key to check the list of audio formats that the audio recorder supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of audio formats that the audio recorder supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const AUDIORECORDER_FORMAT;
/**
-* The property key to check the count of cameras that are supported.
-*
-* @since 2.0
-*/
+ * The property key to check the count of the cameras that are supported.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_COUNT;
/**
-* The property key to check the list of capture formats that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of capture formats that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_CAPTURE_FORMAT;
/**
-* The property key to check the list of capture resolutions that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of capture resolutions that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_CAPTURE_RESOLUTION;
/**
-* The property key to check the physical direction of the primary camera.
-*
-* @since 2.0
-*/
+ * The property key to check the physical direction of the primary camera.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_DIRECTION;
/**
-* The property key to check the list of effects that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of effects that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_EFFECT;
/**
-* The property key to check the list of ISO levels that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of ISO levels that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_ISO_LEVEL;
/**
-* The property key to check the list of preview formats that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview formats that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_PREVIEW_FORMAT;
/**
-* The property key to check the list of preview frame rates that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview frame rates that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_PREVIEW_FRAMERATE;
/**
-* The property key to check the list of preview resolutions that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview resolutions that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_PREVIEW_RESOLUTION;
/**
-* The property key to check the list of recording resolutions that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of recording resolutions that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_RECORDING_RESOLUTION;
/**
-* The property key to check the physical rotation of the primary camera in the portrait mode.
-*
-* @since 2.0
-*/
+ * The property key to check the physical rotation of the primary camera in the portrait mode.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_ROTATION;
/**
-* The property key to check the ability of the primary camera to support brightness APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support brightness APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_BRIGHTNESS;
/**
-* The property key to check the ability of the primary camera to support capture APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support capture APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_CAPTURE;
/**
-* The property key to check the ability of the primary camera to support contrast APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support contrast APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_CONTRAST;
/**
-* The property key to check the ability of the primary camera to support exposure APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support exposure APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_EXPOSURE;
/**
-* The property key to check the ability of the primary camera to support flash APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support flash APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_FLASH;
/**
-* The property key to check the ability of the primary camera to support focus APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support focus APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_FOCUS;
/**
-* The property key to check the ability of the primary camera to support preview APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support preview APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_PREVIEW;
/**
-* The property key to check the ability of the primary camera to be used with the video recorder.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera used with the video recorder.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_RECORDING;
/**
-* The property key to check the ability of the primary camera to support zoom APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support zoom APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_ZOOM;
/**
-* The property key to check the ability of the primary camera to support zero-shutter-lag feature.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the primary camera to support the zero-shutter-lag feature.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SUPPORT_ZERO_SHUTTER_LAG;
/**
-* The property key to check the list of white balances that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of white balances that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_WHITE_BALANCE;
/**
-* The property key to check the list of zoom types that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of zoom types that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_ZOOM_TYPE;
/**
-* The property key to check the list of flip types that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of flip types that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_FLIP;
/**
-* The property key to check the list of preview rotations that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview rotations that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_PREVIEW_ROTATION;
/**
-* The property key to check the list of focus mode that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of focus modes that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_FOCUS_MODE;
/**
-* The property key to check the list of flash mode that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of flash modes that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_FLASH_MODE;
/**
-* The property key to check the default preview format of the primary camera.
-*
-* @since 2.0
-*/
+ * The property key to check the default preview format of the primary camera.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_DEFAULT_PREVIEW_FORMAT;
/**
-* The property key to check the list of metering mode that the primary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of metering modes that the primary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_METERING_MODE;
/**
-* The property key to check the list of scene mode that the primary camera supports.
-*
-* @since 2.1
-*/
+ * The property key to check the list of scene modes that the primary camera supports.
+ *
+ * @since 2.1
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_PRIMARY_SCENE_MODE;
/**
-* The property key to check the list of capture formats that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of capture formats that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_CAPTURE_FORMAT;
/**
-* The property key to check the list of capture resolutions that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of capture resolutions that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_CAPTURE_RESOLUTION;
/**
-* The property key to check the physical direction of the secondary camera.
-*
-* @since 2.0
-*/
+ * The property key to check the physical direction of the secondary camera.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_DIRECTION;
/**
-* The property key to check the list of effects that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of effects that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_EFFECT;
/**
-* The property key to check the list of ISO levels that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of ISO levels that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_ISO_LEVEL;
/**
-* The property key to check the list of preview formats that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview formats that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_PREVIEW_FORMAT;
/**
-* The property key to check the list of preview frame rates that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview frame rates that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_PREVIEW_FRAMERATE;
/**
-* The property key to check the list of preview resolutions that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview resolutions that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_PREVIEW_RESOLUTION;
/**
-* The property key to check the list of recording resolutions that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of recording resolutions that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_RECORDING_RESOLUTION;
/**
-* The property key to check the physical rotation of the secondary camera in the portrait mode.
-*
-* @since 2.0
-*/
+ * The property key to check the physical rotation of the secondary camera in the portrait mode.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_ROTATION;
/**
-* The property key to check the ability of the secondary camera to support brightness APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support brightness APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_BRIGHTNESS;
/**
-* The property key to check the ability of the secondary camera to support capture APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support capture APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_CAPTURE;
/**
-* The property key to check the ability of the secondary camera to support contrast APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support contrast APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_CONTRAST;
/**
-* The property key to check the ability of the secondary camera to support exposure APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support exposure APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_EXPOSURE;
/**
-* The property key to check the ability of the secondary camera to support flash APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support flash APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_FLASH;
/**
-* The property key to check the ability of the secondary camera to support focus APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support focus APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_FOCUS;
/**
-* The property key to check the ability of the secondary camera to support preview APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support preview APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_PREVIEW;
/**
-* The property key to check the ability of the secondary camera to be used with the video recorder.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera used with the video recorder.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_RECORDING;
/**
-* The property key to check the ability of the secondary camera to support zoom APIs.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support zoom APIs.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_ZOOM;
/**
-* The property key to check the ability of the secondary camera to support zero-shutter-lag feature.
-*
-* @since 2.0
-*/
+ * The property key to check the ability of the secondary camera to support the zero-shutter-lag feature.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SUPPORT_ZERO_SHUTTER_LAG;
/**
-* The property key to check the list of white balances that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of white balances that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_WHITE_BALANCE;
/**
-* The property key to check the list of zoom types that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of zoom types that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_ZOOM_TYPE;
/**
-* The property key to check the list of flip types that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of flip types that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_FLIP;
/**
-* The property key to check the list of preview rotations that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of preview rotations that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_PREVIEW_ROTATION;
/**
-* The property key to check the list of focus mode that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of focus modes that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_FOCUS_MODE;
/**
-* The property key to check the list of flash mode that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of flash modes that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_FLASH_MODE;
/**
-* The property key to check the default preview format of the secondary camera.
-*
-* @since 2.0
-*/
+ * The property key to check the default preview format of the secondary camera.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_DEFAULT_PREVIEW_FORMAT;
/**
-* The property key to check the list of metering mode that the secondary camera supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of metering modes that the secondary camera supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_METERING_MODE;
/**
-* The property key to check the list of scene mode that the secondary camera supports.
-*
-* @since 2.1
-*/
+ * The property key to check the list of scene modes that the secondary camera supports.
+ *
+ * @since 2.1
+ */
_OSP_EXPORT_ extern const wchar_t* const CAMERA_SECONDARY_SCENE_MODE;
/**
-* The property key to check the list of audio codecs that the player supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of audio codecs that the player supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const PLAYER_AUDIO_CODEC;
/**
-* The property key to check the maximum count of instances that the player can construct.
-*
-* @since 2.0
-*/
+ * The property key to check the maximum instance count that the player can construct.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const PLAYER_COUNT_MAX;
/**
-* The property key to check the list of streaming protocols that the player supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of streaming protocols that the player supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const PLAYER_PROTOCOL;
/**
-* The property key to check the list of video codecs that the player supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of video codecs that the player supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const PLAYER_VIDEO_CODEC;
/**
-* The property key to check the maximum height of the video that the player supports.
-*
-* @since 2.0
-*/
+ * The property key to check the maximum height of the video that the player supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const PLAYER_VIDEO_HEIGHT;
/**
-* The property key to check the maximum width of the video that the player supports.
-*
-* @since 2.0
-*/
+ * The property key to check the maximum width of the video that the player supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const PLAYER_VIDEO_WIDTH;
/**
-* The property key to check the list of audio codecs that the video recorder supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of audio codecs that the video recorder supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const VIDEORECORDER_AUDIO_CODEC;
/**
-* The property key to check the list of container formats that the video recorder supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of container formats that the video recorder supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const VIDEORECORDER_FORMAT;
/**
-* The property key to check the list of video codecs that the video recorder supports.
-*
-* @since 2.0
-*/
+ * The property key to check the list of video codecs that the video recorder supports.
+ *
+ * @since 2.0
+ */
_OSP_EXPORT_ extern const wchar_t* const VIDEORECORDER_VIDEO_CODEC;
}}// Tizen::Media
//
/**
- * @file FMediaIAudioInEventListener.h
- * @brief This is the header file for the %IAudioInEventListener interface.
+ * @file FMediaIAudioInEventListener.h
+ * @brief This is the header file for the %IAudioInEventListener interface.
*
* This header file contains the declarations of the %IAudioInEventListener interface.
*/
/**
* @interface IAudioInEventListener
- * @brief This interface represents a listener that receives the %AudioIn related events.
+ * @brief This interface represents a listener that receives the %AudioIn related events.
*
* @since 2.0
*
- * @remarks The OnAudioInInterrupted() method is called when an application is interrupted by another application, and the OnAudioInReleased() method is called at the end of this interruption.
- * The OnAudioInAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not be notified.
- * So, an application must accordingly handle both the events when audio switching occurs between various applications.
+ * @remarks The OnAudioInInterrupted() method is called when an application is interrupted by another application, and the OnAudioInReleased() method is called at the end of this interruption.
+ * The OnAudioInAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not notified.
+ * So, an application must handle both the events accordingly when audio switching occurs between various applications.
*
*
- * The %IAudioInEventListener interface provides various methods that are called during the operations of %AudioIn.
- * %AudioIn captures audio data from the device in asynchronous mode,
+ * The %IAudioInEventListener interface provides various methods that are called during the operations of AudioIn.
+ * %AudioIn captures audio data from a device in the asynchronous mode,
* and calls the listener's methods to pass the captured audio data.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/recording_pcm_audio.htm">Recording PCM Audio</a>.
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IAudioInEventListener(void) {}
- /**
- * Called when the device has filled up a buffer with PCM data completely.
+ /**
+ * Called when the device has filled up a buffer with PCM data completely.
*
* @since 2.0
*
- * @param[in] pData A pointer to the buffer containing the filled data @n
- * The data address is same as the address added by AudioIn::AddBuffer().
+ * @param[in] pData A pointer to the buffer that contains the filled data @n
+ * The data address is same as the address added by AudioIn::AddBuffer().
*/
virtual void OnAudioInBufferIsFilled(Tizen::Base::ByteBuffer* pData) = 0;
- /**
- * Called when an input device is interrupted by a task of higher priority than AudioIn.
- *
- * @since 2.0
- */
+ /**
+ * Called when an input device is interrupted by a task of higher priority than AudioIn.
+ *
+ * @since 2.0
+ */
virtual void OnAudioInInterrupted(void) = 0;
- /**
- * Called when an interrupted input device is released.
- *
- * @since 2.0
- */
+ /**
+ * Called when an interrupted input device is released.
+ *
+ * @since 2.0
+ */
virtual void OnAudioInReleased(void) = 0;
- /**
- * Called when an audio recording focus is changed to another application.
+ /**
+ * Called when the 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 ::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.
+ * @since 2.0
+ * @remarks
+ * - After the audio focus is 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 the ::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 ::AUDIOIN_STATE_STOPPED state due to other applications which have a higher priority.
*/
virtual void OnAudioInAudioFocusChanged(void) {}
//
/**
- * @file FMediaIAudioOutEventListener.h
- * @brief This is the header file for the %IAudioOutEventListener interface.
+ * @file FMediaIAudioOutEventListener.h
+ * @brief This is the header file for the %IAudioOutEventListener interface.
*
* This header file contains the declarations of the %IAudioOutEventListener interface.
*/
class AudioOut;
/**
* @interface IAudioOutEventListener
- * @brief This interface represents a listener that receives the %AudioOut related events.
+ * @brief This interface represents a listener that receives %AudioOut related events.
*
* @since 2.0
*
- * @remarks The OnAudioOutInterrupted() method is called when an application is interrupted by another application, and the OnAudioOutReleased() method is called at the end of this interruption.
- * The OnAudioOutAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not be notified.
- * So, an application must accordingly handle both the events when audio switching occurs between various applications.
+ * @remarks The OnAudioOutInterrupted() method is called when an application is interrupted by another application, and the OnAudioOutReleased() method is called at the end of this interruption.
+ * The OnAudioOutAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not notified.
+ * So, an application must handle both the events accordingly when audio switching occurs between various applications.
*
- * The %IAudioOutEventListener interface represents a listener that receives the AudioOut related events. The %AudioOut class works in asynchronous mode, and when the application plays audio data with the %AudioOut class,
+ * The %IAudioOutEventListener interface represents a listener that receives AudioOut related events.
+ * The %AudioOut class works in the asynchronous mode, and when an application plays audio data with %AudioOut,
* the caller must implement this interface to receive an event from %AudioOut.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/playing_pcm_audio.htm">Playing PCM Audio</a>.
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IAudioOutEventListener(void) {}
- /**
- * Called when the device has written a buffer completely.
+ /**
+ * Called when the device has written a buffer completely.
*
* @since 2.0
*
- * @param[in] src An instance of AudioOut that fires the event
+ * @param[in] src An instance of AudioOut that fires the event
*/
virtual void OnAudioOutBufferEndReached(Tizen::Media::AudioOut& src) = 0;
- /**
- * Called when the output device is interrupted by a task of higher priority than AudioOut.
- *
- * @since 2.0
- *
- * @param[in] src An instance of AudioOut that fires the event
- */
+ /**
+ * Called when the output device is interrupted by a task of higher priority than AudioOut.
+ *
+ * @since 2.0
+ *
+ * @param[in] src An instance of AudioOut that fires the event
+ */
virtual void OnAudioOutInterrupted(Tizen::Media::AudioOut& src) = 0;
- /**
- * Called when the interrupted output device is released.
- *
- * @since 2.0
- *
- * @param[in] src An instance of AudioOut that fires the event
- */
+ /**
+ * Called when an interrupted output device is released.
+ *
+ * @since 2.0
+ *
+ * @param[in] src An instance of AudioOut that fires the event
+ */
virtual void OnAudioOutReleased(Tizen::Media::AudioOut& src) = 0;
- /**
- * Called when an audio playback focus is changed to another application.
+ /**
+ * Called when the audio playback focus is changed to another application.
*
- * @since 2.0
+ * @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 ::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.
+ * @param[in] src An instance of AudioOut that fires the event
+ * @remarks
+ * - After the audio focus is 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 the ::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 ::AUDIOOUT_STATE_STOPPED state due to other applications which have a higher priority.
*/
virtual void OnAudioOutAudioFocusChanged(Tizen::Media::AudioOut& src) {}
protected:
//
/**
- * @file FMediaIAudioRecorderEventListener.h
- * @brief This is the header file for the %IAudioRecorderEventListener interface.
+ * @file FMediaIAudioRecorderEventListener.h
+ * @brief This is the header file for the %IAudioRecorderEventListener interface.
*
* This header file contains the declarations of the %IAudioRecorderEventListener interface.
*/
/**
* @interface IAudioRecorderEventListener
- * @brief This interface represents a listener that receives events associated with the %AudioRecorder class.
+ * @brief This interface represents a listener that receives events associated with %AudioRecorder.
*
* @since 2.0
*
- * The %IAudioRecorderEventListener interface represents a listener that receives events associated with the AudioRecorder class.
+ * The %IAudioRecorderEventListener interface represents a listener that receives events associated with AudioRecorder.
* %IAudioRecorderEventListener specifies the methods used to notify the status of the audio recorder.
* The audio recorder engine works asynchronously. Therefore, it is important to implement this listener to ensure that the recorder flows correctly.
- * When an operation of each method is completed, an event is generated and a method of this class is called.
+ * When the operation of each method is completed, an event is generated and a method of this class is called.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/recording_audio.htm">Recording Audio</a>.
*/
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IAudioRecorderEventListener(void) {}
- /**
- * Called when the AudioRecorder::Stop() method is completed.
+ /**
+ * Called when the AudioRecorder::Stop() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnAudioRecorderStopped(result r) = 0;
- /**
- * Called when the AudioRecorder::Cancel() method is completed.
+ /**
+ * Called when the AudioRecorder::Cancel() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnAudioRecorderCanceled(result r) = 0;
- /**
- * Called when the AudioRecorder::Pause() method is completed.
+ /**
+ * Called when the AudioRecorder::Pause() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnAudioRecorderPaused(result r) = 0;
- /**
- * Called when the AudioRecorder::Record() method is completed.
+ /**
+ * Called when the AudioRecorder::Record() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnAudioRecorderStarted(result r) = 0;
- /**
- * Called when AudioRecorder reaches the end of the pre-defined time.
+ /**
+ * Called when AudioRecorder reaches the end of the pre-defined time.
*
* @since 2.0
*
- * @param[in] endCondition The end condition of the recording
- * @see AudioRecorder::SetMaxRecordingTime()
+ * @param[in] endCondition The end condition of the recording
+ * @see AudioRecorder::SetMaxRecordingTime()
*
*/
virtual void OnAudioRecorderEndReached(RecordingEndCondition endCondition) = 0;
- /**
- * Called when the AudioRecorder::Close() method is completed.
+ /**
+ * Called when the AudioRecorder::Close() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnAudioRecorderClosed(result r) = 0;
- /**
- * Called when an error has occurred in AudioRecorder.
+ /**
+ * Called when an error has occurred in AudioRecorder.
*
* @since 2.0
*
- * @param[in] r An audio recorder error reason of type ::RecorderErrorReason
- * @remarks
+ * @param[in] r An audio recorder error reason of type ::RecorderErrorReason
+ * @remarks
* - ::RECORDER_ERROR_OUT_OF_STORAGE occurs when the recording size exceeds the maximum available capacity.
* - While recording especially to the external memory like MMC card, ::RECORDER_ERROR_STORAGE_FAILED can occur.
* ::RECORDER_ERROR_DEVICE_FAILED occurs when the recording device has a problem like damaged shape or hardware malfunction.
//
/**
-* @file FMediaIAudioRouteEventListener.h
-* @brief This is the header file for the %IAudioRouteEventListener interface.
-*
-* This header files contains the declarations of the %IAudioRouteEventListener interface and its associated classes.
-*
-*/
+ * @file FMediaIAudioRouteEventListener.h
+ * @brief This is the header file for the %IAudioRouteEventListener interface.
+ *
+ * This header file contains the declarations of the %IAudioRouteEventListener interface and its associated classes.
+ *
+ */
#ifndef _FMEDIA_IAUDIO_ROUTE_EVENT_LISTENER_H_
#define _FMEDIA_IAUDIO_ROUTE_EVENT_LISTENER_H_
{
/**
* @interface IAudioRouteEventListener
- * @brief This interface provides a listener that receives events associated with the active audio device or available audio devices.
+ * @brief This interface provides a listener that receives events associated with an active audio device or other available audio devices.
*
* @since 2.0
*
- * The %IAudioRouteEventListener interface specifies the methods used to notify the changes in active audio device or in available audio devices.
- * There are many audio devices in the device. Thus If the application wants to know the currently active audio device or available audio devices,
- * it has to listen to this interface.
+ * The %IAudioRouteEventListener interface specifies the methods used to notify the changes in an active audio device or other available audio devices.
+ * There are many audio devices in a device. Thus, if an application wants to know the currently active audio device or other available audio devices,
+ * it has to listen to this interface.
*/
class _OSP_EXPORT_ IAudioRouteEventListener
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IAudioRouteEventListener(void) { }
- /**
- * Called when active audio route changes.
+ /**
+ * Called when an active audio route changes.
*
- * @since 2.0
- * @param[in] route An instance of AudioRouteInfo that is active currently
+ * @since 2.0
+ * @param[in] route An instance of AudioRouteInfo that is currently active
*/
virtual void OnActiveAudioRouteChanged(const AudioRouteInfo& route) = 0;
- /**
- * Called when an available audio route is added.
+ /**
+ * Called when an available audio route is added.
*
- * @since 2.0
- * @param[in] route An instance of AudioRouteInfo for which the routing status is changed
+ * @since 2.0
+ * @param[in] route An instance of AudioRouteInfo for which the routing status is changed
*/
virtual void OnAudioRouteAdded(const AudioRouteInfo& route) = 0;
- /**
- * Called when an audio route is removed.
+ /**
+ * Called when an audio route is removed.
*
- * @since 2.0
- * @param[in] route An instance of AudioRouteInfo for which the routing status is changed
+ * @since 2.0
+ * @param[in] route An instance of AudioRouteInfo for which the routing status is changed
*/
virtual void OnAudioRouteRemoved(const AudioRouteInfo& route) = 0;
protected:
//
/**
- * @file FMediaIAudioStreamFilter.h
- * @brief This is the header file for the %IAudioStreamFilter interface.
+ * @file FMediaIAudioStreamFilter.h
+ * @brief This is the header file for the %IAudioStreamFilter interface.
*
* This header file contains the declarations of the %IAudioStreamFilter interface.
*/
/**
* @interface IAudioStreamFilter
- * @brief This interface represents a filter that processes an audio stream data.
+ * @brief This interface represents a filter that processes audio stream data.
*
* @since 2.1
*
- * The %IAudioStreamFilter interface represents a filter that processes an audio stream data.
-*/
+ * The %IAudioStreamFilter interface represents a filter that processes audio stream data.
+ */
class _OSP_EXPORT_ IAudioStreamFilter
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when
- * the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.1
*/
virtual ~IAudioStreamFilter(void) {}
- /**
- * Processes an audio stream.
+ /**
+ * Processes an audio stream.
*
* @since 2.1
*
- * @param[in,out] frame A frame object containing the audio frame data
- * @remarks This method should not contain any operations that harm thread safety or performance degradation.
+ * @param[in,out] frame The frame object that contains the audio frame data
+ * @remarks This method should not contain any operations that harm thread safety and cause performance degradation.
*/
virtual void ProcessAudioStream(AudioFrame& frame) = 0;
//
/**
- * @file FMediaICameraEventListener.h
- * @brief This is the header file for the %ICameraEventListener interface.
+ * @file FMediaICameraEventListener.h
+ * @brief This is the header file for the %ICameraEventListener interface.
*
* This header file contains the declarations of the %ICameraEventListener interface.
*/
/**
* @interface ICameraEventListener
- * @brief This interface provides a listener that receives events associated with the %Camera class.
+ * @brief This interface provides a listener that receives events associated with %Camera.
*
* @since 2.0
*
- * The %ICameraEventListener interface specifies the methods used to notify the status of the camera and camera events.
+ * The %ICameraEventListener interface specifies the methods used to notify the status of the camera and its events.
* The camera engine works asynchronously. Therefore, it is important to implement this listener
- * to ensure smooth performance of the camera.
+ * to ensure the smooth performance of the camera.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/capturing_still_images.htm">Capturing Still Images</a>.
*/
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~ICameraEventListener(void) {}
- /**
+ /**
* Called when the Camera::SetAutoFocus() method is completed.
*
* @since 2.0
*
- * @param[in] completeCondition The condition of auto focus completion @n
- * Set to @c true if it succeeds, @n
- * else @c false.
+ * @param[in] completeCondition The condition of auto focus completion @n
+ * Set to @c true if it succeeds, @n
+ * else @c false.
*/
virtual void OnCameraAutoFocused(bool completeCondition) = 0;
- /**
+ /**
* Called when the Camera::StartPreview() method is completed. @n
- * Notifies to the application periodically, at the speed of the camera's frame rate,
+ * Notifies the application periodically, at the speed of the camera's frame rate,
* once the %Camera::StartPreview() method is called, so as to receive the preview data.
*
* @since 2.0
*
- * @param[in] previewedData The displayed image data in the viewfinder @n
- * The previewed data format is same as the format
- * set by Camera::SetPreviewFormat().
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_DATA The ByteBuffer contains invalid data.
- * @remarks
- * - This method is called only if the @c previewedData flag of
- * Camera::StartPreview() is @c true.
- * - This method can be delayed or dropped depending on system performance.
- * @see Camera::GetPreviewFormat()
- *
- * The camera rotation can be different according to the physical design.
- * For keeping the compatibility between targets, the application must check the H/W camera rotation.
+ * @param[in] previewedData The displayed image data in the viewfinder @n
+ * The previewed data format is same as the format
+ * set by Camera::SetPreviewFormat().
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_DATA The Tizen::Base::ByteBuffer contains invalid data.
+ * @remarks
+ * - This method is called only if the @c previewedData flag of Camera::StartPreview() is @c true.
+ * - This method can be delayed or dropped depending on the system performance.
+ * @see Camera::GetPreviewFormat()
+ *
+ * The camera rotation can differ according to the physical design. @n
+ * For keeping compatibility between the targets, the application must check the hardware camera rotation.
* Based on this information, the application can rotate the preview data.
*
* The following example demonstrates how to use the %OnCameraPreviewed() method to rotate the preview data in the portrait mode.
*/
virtual void OnCameraPreviewed(Tizen::Base::ByteBuffer& previewedData, result r) = 0;
- /**
- * Called when the Camera::Capture() method is completed.
+ /**
+ * Called when the %Camera::Capture() method is completed.
*
* @since 2.0
*
- * @param[in] capturedData The image data captured by the camera @n
+ * @param[in] capturedData The image data captured by the camera @n
* The captured data format is the same as the format
- * set by Camera::SetCaptureFormat().
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_DATA The ByteBuffer contains invalid data.
- * @see Camera::Capture()
- * @see Camera::GetCaptureFormat()
+ * set by Camera::SetCaptureFormat().
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_DATA The Tizen::Base::ByteBuffer contains invalid data.
+ * @see Camera::Capture()
+ * @see Camera::GetCaptureFormat()
*/
virtual void OnCameraCaptured(Tizen::Base::ByteBuffer& capturedData, result r) = 0;
- /**
- * Called when an error occurs in Camera.
+ /**
+ * Called when an error occurs in Camera.
*
* @since 2.0
*
- * @param[in] r A camera error @n
+ * @param[in] r The camera error @n
* This is one of the ::CameraErrorReason values.
- * @remarks
- * - The ::CAMERA_ERROR_DEVICE_FAILED error occurs when the camera device
- * has a problem, such as damaged shape or hardware malfunction.
- * - The ::CAMERA_ERROR_DEVICE_INTERRUPTED error occurs when the camera
- * device has been interrupted by other request, such as an incoming
- * video telephony call.
- * - In this method, the application calls the Camera::PowerOff()
- * method to reset the camera device.
+ * @remarks
+ * - The @c CAMERA_ERROR_DEVICE_FAILED error occurs when the camera device
+ * has a problem, such as damaged shape or hardware malfunction.
+ * - The @c CAMERA_ERROR_DEVICE_INTERRUPTED error occurs when the camera
+ * device is interrupted by another request, such as an incoming
+ * video telephony call.
+ * - In this method, the application calls the Camera::PowerOff()
+ * method to reset the camera device.
*/
virtual void OnCameraErrorOccurred(CameraErrorReason r) = 0;
//
/**
- * @file FMediaIPlayerEventListener.h
- * @brief This is the header file for the %IPlayerEventListener interface.
+ * @file FMediaIPlayerEventListener.h
+ * @brief This is the header file for the %IPlayerEventListener interface.
*
* This header file contains the declarations of the %IPlayerEventListener interface.
*/
/**
* @interface IPlayerEventListener
- * @brief This interface provides a listener for media playing events.
+ * @brief This interface provides a listener for media playing events.
*
* @since 2.0
*
- * @remarks The OnPlayerInterrupted() method is called when an application is interrupted by another application, and the OnPlayerReleased() method is called at the end of this interruption.
- * The OnPlayerAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not be notified.
- * So, an application must accordingly handle both the events when audio switching occurs between various applications.
+ * @remarks The OnPlayerInterrupted() method is called when an application is interrupted by another application, and the OnPlayerReleased() method is called at the end of this interruption.
+ * The OnPlayerAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not notified.
+ * So, an application must handle both the events accordingly when audio switching occurs between various applications.
*
- * The %IPlayerEventListener interface specifies the methods used to notify the status of the media player during the media playing events.
+ * The %IPlayerEventListener interface specifies the methods used to notify the status of the media player during media playing events.
* The player engine works asynchronously. Therefore, it is important to implement this listener to ensure that the player flows correctly.
* When each operation of the Player is completed, an event is generated, and a method from this class is called.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/playing_audio.htm">Playing Audio</a> and
- <a href="../org.tizen.native.appprogramming/html/guide/media/playing_video.htm">Playing Video</a>.
+
* <a href="../org.tizen.native.appprogramming/html/guide/media/playing_video.htm">Playing Video</a>.
*/
class _OSP_EXPORT_ IPlayerEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IPlayerEventListener(void) {}
- /**
- * Called when an audio/video content is opened asynchronously.
+ /**
+ * Called when an audio/video content is opened asynchronously.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM The device has run out of system resources.
- * @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 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 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.
- * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
- * @see Player::OpenFile()
- * @see Player::OpenUrl()
- * @see Player::OpenBuffer()
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM The device has run out of system resources.
+ * @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 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 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.
+ * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
+ * @see Player::OpenFile()
+ * @see Player::OpenUrl()
+ * @see Player::OpenBuffer()
*/
virtual void OnPlayerOpened(result r) = 0;
- /**
- * Called when the Player reaches the end of the clip.
+ /**
+ * Called when the Player reaches the end of the clip.
*
* @since 2.0
*/
virtual void OnPlayerEndOfClip(void) = 0;
- /**
- * Called when the position of the audio/video content moves asynchronously.
+ /**
+ * Called when the position of the audio/video content moves asynchronously.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @see Player::SeekTo()
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @see Player::SeekTo()
*/
virtual void OnPlayerSeekCompleted(result r){};
- /**
- * Called when the streaming data is being buffered.
+ /**
+ * Called when the streaming data is being buffered.
*
* @since 2.0
*
- * @param[in] percent The percentage of buffering is completed
- * @see Player::OpenUrl()
+ * @param[in] percent The percentage of buffering that is completed
+ * @see Player::OpenUrl()
*/
virtual void OnPlayerBuffering(int percent) = 0;
- /**
- * Called when an error has occurred while the Player is working.
+ /**
+ * Called when an error occurs while the Player is working.
*
* @since 2.0
*
- * @param[in] r A player error reason of type ::PlayerErrorReason
- * @remarks
+ * @param[in] r The 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.
* - If the content includes invalid data, ::PLAYER_ERROR_INVALID_DATA may occur.
- * @see PlayerErrorReason
*/
virtual void OnPlayerErrorOccurred(Tizen::Media::PlayerErrorReason r) = 0;
- /**
- * Called when the Player is being interrupted by a task of higher priority than the %Player.
- *
- * @since 2.0
- */
+ /**
+ * Called when the Player is being interrupted by a task of higher priority than itself.
+ *
+ * @since 2.0
+ */
virtual void OnPlayerInterrupted(void) = 0;
- /**
- * Called when the interrupting Player has been released.
- *
- * @since 2.0
- */
+ /**
+ * Called when the interrupting Player has been released.
+ *
+ * @since 2.0
+ */
virtual void OnPlayerReleased(void) = 0;
- /**
- * Called when an audio playback focus is changed to another application.
+ /**
+ * Called when the 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 ::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.
+ * @since 2.0
+ * @remarks
+ * - After the audio focus is 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 ::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.
+ * - An application cannot play again even in the ::PLAYER_STATE_PAUSED state due to another application which has a higher priority.
*/
virtual void OnPlayerAudioFocusChanged(void) {}
protected:
//
/**
-* @file FMediaIPlayerProgressiveDownloadListener.h
-* @brief This is the header file for the %IPlayerProgressiveDownloadListener interface.
-*
-* This header files contains the declarations of the %IPlayerProgressiveDownloadListener interface.
-*
-*/
+ * @file FMediaIPlayerProgressiveDownloadListener.h
+ * @brief This is the header file for the %IPlayerProgressiveDownloadListener interface.
+ *
+ * This header file contains the declarations of the %IPlayerProgressiveDownloadListener interface.
+ *
+ */
#ifndef _FMEDIA_IPLAYER_PROGRESSIVE_DOWNLOAD_LISTENER_H_
#define _FMEDIA_IPLAYER_PROGRESSIVE_DOWNLOAD_LISTENER_H_
namespace Tizen { namespace Media
{
/**
-* @interface IPlayerProgressiveDownloadListener
-* @brief This interface provides a listener that receives events associated with the progressive download playback.
-*
-* @since 2.0
-*
-* The %IPlayerProgressiveDownloadListener interface specifies the methods used to notify when the application starts, or completes progressive download.
-*/
+ * @interface IPlayerProgressiveDownloadListener
+ * @brief This interface provides a listener that receives events associated with a progressive download playback.
+ *
+ * @since 2.0
+ *
+ * The %IPlayerProgressiveDownloadListener interface specifies the methods used to notify when an application starts, or completes a progressive download.
+ */
class _OSP_EXPORT_ IPlayerProgressiveDownloadListener
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IPlayerProgressiveDownloadListener(void) { }
- /**
- * Called when the progressive download has started.
+ /**
+ * Called when a progressive download has started.
*
* @since 2.0
*
- * @param[in] player An instance of Player that fires the event
+ * @param[in] player An instance of Player that fires the event
*/
virtual void OnPlayerProgressiveDownloadStarted(Player& player) = 0;
- /**
- * Called when the progressive download is in progress.
+ /**
+ * Called when a progressive download is in progress.
*
* @since 2.0
*
* @param[in] player An instance of Player that fires the event
- * @param[in] downloadedSize The total downloaded size in bytes
+ * @param[in] downloadedSize The total downloaded size in bytes
* @param[in] totalSize The total size in bytes
*/
virtual void OnPlayerProgressiveDownloadInProgress(Player& player, int downloadedSize, int totalSize) = 0;
- /**
- * Called when the progressive download has completed.
+ /**
+ * Called when a progressive download has completed.
*
* @since 2.0
*
* @param[in] player An instance of Player that fires the event
- * @param[in] r The result of progressive download
+ * @param[in] r The result of the progressive download
* @exception E_SUCCESS The method is successful.
* @exception E_STORAGE_FULL The storage is full.
- * @exception E_INACCESSIBLE_PATH The file path is invalid to store media data.
+ * @exception E_INACCESSIBLE_PATH The file path is invalid to store the media data.
*/
virtual void OnPlayerProgressiveDownloadCompleted(Player& player, result r) = 0;
class Player;
/**
* @interface IPlayerVideoEventListener
- * @brief This interface provides a listener for the video event.
+ * @brief This interface provides a listener for video events.
*
* @since 2.0
*
- * The %IPlayerVideoEventListener interface specifies the method used to get the decoded video frame.
+ * The %IPlayerVideoEventListener interface specifies the method used to get a decoded video frame.
*/
class _OSP_EXPORT_ IPlayerVideoEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~IPlayerVideoEventListener(void) {}
- /**
- * Called when the video frame is decoded asynchronously.
+ /**
+ * Called when a video frame is decoded asynchronously.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] src An instance of Player that fires the event
- * @param[in] bitmapPixelFormat A pixel format type of the decoded video frame
- * @param[in] dim A dimension of the decoded video frame
- * @param[in] pBuffer A pointer to a decoded video frame buffer
- * @param[in] sizeOfBuffer A size of a buffer
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_INVALID_DATA The video frame has invalid blocks.
- * @remarks
- * - The lifecycle of @c pBuffer is valid inside this method.
- * - When rendering the video frame with Player::Play() method, the rendering performs worse than using Player instance constructed with Tizen::Graphics::BufferInfo.
+ * @param[in] src An instance of Player that fires the event
+ * @param[in] bitmapPixelFormat The pixel format type of the decoded video frame
+ * @param[in] dim The dimension of the decoded video frame
+ * @param[in] pBuffer A pointer to the decoded video frame buffer
+ * @param[in] sizeOfBuffer The size of the buffer
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_INVALID_DATA The video frame has invalid blocks.
+ * @remarks
+ * - The lifecycle of @c pBuffer is valid inside this method.
+ * - When rendering the video frame with the Player::Play() method, the rendering is not performed properly unless a Player instance constructed with Tizen::Graphics::BufferInfo is used.
*
* @see Player::Pause()
* @see Player::SeekTo()
class TonePlayer;
/**
* @interface ITonePlayerEventListener
- * @brief This interface provides a listener for the tone player events.
+ * @brief This interface provides a listener for tone player events.
*
* @since 2.0
*
- * @remarks The OnTonePlayerInterrupted() method is called when an application is interrupted by another application, and the OnTonePlayerReleased() method is called at the end of this interruption.
- * The OnTonePlayerAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not be notified.
- * So, an application must accordingly handle both the events when audio switching occurs between various applications.
+ * @remarks The OnTonePlayerInterrupted() method is called when an application is interrupted by another application, and the OnTonePlayerReleased() method is called at the end of this interruption.
+ * The OnTonePlayerAudioFocusChanged() method is called when an application is interrupted by another application, but the end of this interruption is not notified.
+ * So, an application must handle both the events accordingly when audio switching occurs between various applications.
*
- * The %ITonePlayerEventListener interface specifies the methods used to notify the status of the tone player.
+ * The %ITonePlayerEventListener interface specifies the methods used to notify the status of a tone player.
*/
class _OSP_EXPORT_ ITonePlayerEventListener
: virtual public Tizen::Base::Runtime::IEventListener
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.0
*/
virtual ~ITonePlayerEventListener(void) {}
- /**
- * Called when the tone player reaches the end of the tone or the end of the list of tones.
+ /**
+ * Called when a tone player reaches the end of a tone or the end of the list of tones.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] src An instance of TonePlayer that fires the event
+ * @param[in] src An instance of TonePlayer that fires the event
*
*/
virtual void OnTonePlayerEndOfTone(Tizen::Media::TonePlayer& src) = 0;
- /**
- * Called when the tone player is interrupted by a task of higher priority than the tone player.
+ /**
+ * Called when a tone player is interrupted by a task of higher priority than itself.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] src An instance of TonePlayer that fires the event
+ * @param[in] src An instance of TonePlayer that fires the event
*
*/
virtual void OnTonePlayerInterrupted(Tizen::Media::TonePlayer& src) = 0;
- /**
- * Called when the interrupted tone player is released.
+ /**
+ * Called when an interrupted tone player is released.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] src An instance of TonePlayer that fires the event
+ * @param[in] src An instance of TonePlayer that fires the event
*
*/
virtual void OnTonePlayerReleased(Tizen::Media::TonePlayer& src) = 0;
- /**
- * Called to notify an application that an error has occurred while the tone is played.
+ /**
+ * Called to notify an application that an error occurred while playing a tone.
*
- * @since 2.0
+ * @since 2.0
*
- * @param[in] src An instance of TonePlayer that fires the event
- * @param[in] r The cause of the error
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] src An instance of TonePlayer that fires the event
+ * @param[in] r The cause of the error
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnTonePlayerErrorOccurred(Tizen::Media::TonePlayer& src, result r) = 0;
- /**
- * Called when an audio playback focus is changed to another application.
+ /**
+ * Called when the audio playback focus is changed to another application.
*
- * @since 2.0
+ * @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 ::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.
+ * @param[in] src An instance of TonePlayer that fires the event
+ * @remarks
+ * - After the audio focus is 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 the ::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 the playback again even in the ::TONE_PLAYER_STATE_PAUSED state due to other applications which have a higher priority.
*/
virtual void OnTonePlayerAudioFocusChanged(Tizen::Media::TonePlayer& src) {}
//
/**
- * @file FMediaIVideoRecorderEventListener.h
- * @brief This is the header file for the %IVideoRecorderEventListener interface.
+ * @file FMediaIVideoRecorderEventListener.h
+ * @brief This is the header file for the %IVideoRecorderEventListener interface.
*
* This header file contains the declarations of the %IVideoRecorderEventListener interface.
*/
/**
* @interface IVideoRecorderEventListener
- * @brief This interface represents a listener that receives events associated with the %VideoRecorder class.
+ * @brief This interface represents a listener that receives events associated with the %VideoRecorder class.
* @since 2.0
*
- * The %IVideoRecorderEventListener interface specifies the methods used to notify the status of the video recorder.
+ * The %IVideoRecorderEventListener interface specifies the methods used to notify the status of a video recorder.
* The video recorder engine works asynchronously. Therefore, it is important to implement this listener to ensure that the recorder flows correctly.
- * When an operation of each method is completed, an event is generated and a method of this interface is called.
+ * When the operation of each method is completed, an event is generated and a method of this interface is called.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/recording_video.htm">Recording Video</a>.
*/
{
public:
- /**
+ /**
* This is the destructor for this class.
*
* @since 2.0
*/
virtual ~IVideoRecorderEventListener(void) {}
- /**
- * Called when the VideoRecorder::Stop() method is completed.
+ /**
+ * Called when the VideoRecorder::Stop() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnVideoRecorderStopped(result r) = 0;
- /**
- * Called when the VideoRecorder::Cancel() method is completed.
+ /**
+ * Called when the VideoRecorder::Cancel() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*/
virtual void OnVideoRecorderCanceled(result r) = 0;
- /**
- * Called when the VideoRecorder::Pause() method is completed.
+ /**
+ * Called when the VideoRecorder::Pause() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnVideoRecorderPaused(result r) = 0;
- /**
- * Called when the VideoRecorder::Record() method is completed.
+ /**
+ * Called when the VideoRecorder::Record() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnVideoRecorderStarted(result r) = 0;
- /**
- * Called when VideoRecorder reaches the end of the pre-defined time.
- *
- * @since 2.0
- *
- * @param[in] endCondition The end condition of the recording
- * @see VideoRecorder::SetMaxRecordingTime()
- *
- */
+ /**
+ * Called when VideoRecorder reaches the end of the pre-defined time.
+ *
+ * @since 2.0
+ *
+ * @param[in] endCondition The end condition of the recording
+ * @see VideoRecorder::SetMaxRecordingTime()
+ *
+ */
virtual void OnVideoRecorderEndReached(RecordingEndCondition endCondition) = 0;
- /**
- * Called when the VideoRecorder::Close() method is completed.
+ /**
+ * Called when the VideoRecorder::Close() method is completed.
*
* @since 2.0
*
- * @param[in] r The cause of the error
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
+ * @param[in] r The cause of the error
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
*
*/
virtual void OnVideoRecorderClosed(result r) = 0;
- /**
- * Called when an error occurred in VideoRecorder.
+ /**
+ * Called when an error occurs in VideoRecorder.
*
* @since 2.0
*
- * @param[in] r A video recorder error reason of type ::RecorderErrorReason
- * @remarks
+ * @param[in] r The video recorder error reason of type ::RecorderErrorReason
+ * @remarks
* - ::RECORDER_ERROR_OUT_OF_STORAGE occurs when the recording size exceeds the maximum available capacity.
- * - While recording to an external memory like MMC card, ::RECORDER_ERROR_STORAGE_FAILED can occur.
- * - ::RECORDER_ERROR_DEVICE_FAILED occurs when the recording device has a problem like damaged shape or h/w failure.
+ * - While recording to an external memory like an MMC card, ::RECORDER_ERROR_STORAGE_FAILED can occur.
+ * - ::RECORDER_ERROR_DEVICE_FAILED occurs when the recording device has a problem like damaged shape or hardware failure.
*/
virtual void OnVideoRecorderErrorOccurred(RecorderErrorReason r) = 0;
//
/**
- * @file FMediaIVideoStreamFilter.h
- * @brief This is the header file for the %IVideoStreamFilter interface.
+ * @file FMediaIVideoStreamFilter.h
+ * @brief This is the header file for the %IVideoStreamFilter interface.
*
* This header file contains the declarations of the %IVideoStreamFilter interface.
*/
/**
* @interface IVideoStreamFilter
- * @brief This interface represents a filter that processes the video stream data.
+ * @brief This interface represents a filter that processes video stream data.
*
* @since 2.1
- *
- * The %IVideoStreamFilter interface represents a filter that processes the video stream data.
+ *
+ * The %IVideoStreamFilter interface represents a filter that processes video stream data.
*
*/
class _OSP_EXPORT_ IVideoStreamFilter
{
public:
- /**
- * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when
- * the destructor of this interface is called.
+ /**
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
*
* @since 2.1
*/
virtual ~IVideoStreamFilter(void) {}
- /**
- * Process a video frame.
+ /**
+ * Processes a video frame.
*
* @since 2.1
*
- * @param[in,out] frame A frame object containing the video frame data
- * @remarks This method should not contain any operations that harm thread safety or cause performance degradation.
+ * @param[in,out] frame The frame object that contains the video frame data
+ * @remarks This method should not contain any operations that harm thread safety and cause performance degradation.
*/
virtual void ProcessVideoStream(VideoFrame& frame) = 0;
//
/**
- * @file FMediaMediaStreamInfo.h
- * @brief This is the header file for the %MediaStreamInfo class.
+ * @file FMediaMediaStreamInfo.h
+ * @brief This is the header file for the %MediaStreamInfo class.
*
* This header file contains the declarations of the %MediaStreamInfo class.
*/
* @class MediaStreamInfo
* @brief This class provides methods to get media stream information.
*
- * @since 2.0
+ * @since 2.0
*
* The %MediaStreamInfo class provides methods to get media stream information, including:
* - %Content metadata, such as the title, artist, album title, genre, year, and album art.
* - Audio and video stream information.
*
* This class supports multiple stream content that consists of several audio or video tracks.
- * This class provides a list of AudioStreamInfo and VideoStreamInfo that has the stream information of each audio or video track.
+ * This class provides a list of %AudioStreamInfo and %VideoStreamInfo that has the stream information of each audio or video track.
*
- * For more detailed information, see %AudioStreamInfo and %VideoStreamInfo classes.
+ * For more detailed information, see the AudioStreamInfo and VideoStreamInfo classes.
*
* The following example demonstrates how to use the %MediaStreamInfo class.
* @code
: public Tizen::Base::Object
{
public:
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
*/
virtual ~MediaStreamInfo(void);
public:
- /**
- * Gets the title.
+ /**
+ * Gets the title.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The value of the title, @n
- * else an empty string if the content has no title
+ * @return The title, @n
+ * else an empty string if the content has no title
*/
Tizen::Base::String GetTitle(void) const;
- /**
- * Gets the name of the artist from the content.
+ /**
+ * Gets the name of the artist from the content.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The artist, @n
- * else an empty string if the content has no artist name
+ * @return The artist, @n
+ * else an empty string if the content has no artist name
*/
Tizen::Base::String GetArtist(void) const;
- /**
- * Gets the album title.
+ /**
+ * Gets the album title.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The title of the album, @n
- * else an empty string if the content has no album
+ * @return The title of the album, @n
+ * else an empty string if the content has no album
*/
Tizen::Base::String GetAlbumTitle(void) const;
- /**
- * Gets the genre.
+ /**
+ * Gets the genre.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The genre, @n
- * else an empty string if the content has no genre
+ * @return The genre, @n
+ * else an empty string if the content has no genre
*/
Tizen::Base::String GetGenre(void) const;
- /**
- * Gets the year.
+ /**
+ * Gets the year.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The year, @n
+ * @return The year, @n
* else @c 0 if the content has no year
*/
int GetYear(void) const;
- /**
- * Gets the album art.
+ /**
+ * Gets the album art.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The album art in the content, @n
+ * @return The album art of the content, @n
* else @c null if the content has no album art
*/
Tizen::Base::ByteBuffer* GetAlbumArtN(void) const;
- /**
- * Gets a list of the audio stream information.
+ /**
+ * Gets the list of audio stream information.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to the list containing the audio stream information @n
- * The value belongs to the AudioStreamInfo class.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_DATA The stream cannot be parsed successfully.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return A pointer to the list that contains the audio stream information @n
+ * This value belongs to the AudioStreamInfo class.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_DATA The stream cannot be parsed successfully.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Base::Collection::IList* GetAudioStreamInfoList(void) const;
- /**
- * Gets a list of the video stream information.
+ /**
+ * Gets the list of video stream information.
*
- * @since 2.0
+ * @since 2.0
*
- * @return A pointer to a list containing the video stream information @n
- * The value belongs to the VideoStreamInfo class.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_DATA The stream cannot be parsed successfully.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
+ * @return A pointer to the list that contains the video stream information @n
+ * This value belongs to the VideoStreamInfo class.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_DATA The stream cannot be parsed successfully.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
*/
const Tizen::Base::Collection::IList* GetVideoStreamInfoList(void) const;
- /**
+ /**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @return The copy of this instance
- * @param[in] rhs An instance of %MediaStreamInfo
+ * @return A copy of this instance
+ * @param[in] rhs An instance of %MediaStreamInfo
*/
MediaStreamInfo(const MediaStreamInfo & rhs);
- /**
+ /**
* Copying of objects using this copy assignment operator is allowed.
*
* @since 2.0
*
- * @return The reference of this instance
- * @param[in] rhs An instance of %MediaStreamInfo
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %MediaStreamInfo
*/
MediaStreamInfo & operator =(const MediaStreamInfo & rhs);
- /**
- * Compares the specified instance of Tizen::Base::Object with the calling instance of %MediaStreamInfo.
+ /**
+ * Compares the specified instance of Tizen::Base::Object with the current instance of %MediaStreamInfo.
*
- * @since 2.0
+ * @since 2.0
*
- * @return @c true if the value of the specified instance equals the value of the current instance, @n
+ * @return @c true if the value of the specified instance equals the value of the current instance, @n
* else @c false
- * @param[in] rhs The object to compare with the current instance
+ * @param[in] rhs The object to compare with the current instance
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
- /**
+ /**
* Gets the hash value of the current instance.
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
*/
virtual int GetHashCode(void) const;
* @if OSPDEPREC
* @namespace Tizen::Media::Openal
* @brief <i> [Deprecated] </i>This namespace contains interfaces for %OpenAL.
- * @deprecated This namespace is deprecated because libopenal/libalut open source libraries are supported directly on Tizen.
+ * @deprecated This namespace is deprecated because the libopenal and libalut open source libraries are supported directly on Tizen.
* @since 2.0
*
- * @remarks @b Header @b %file: @b \#include @b <FMediaOpenal.h> or @b \#include @b <AL/al.h>, @b <AL/alc.h>, @b <AL/alex.h> and @b <AL/alut.h> @n
- * @b Library: @b openal and @b alut
+ * @remarks @b Header @b %file: @b \#include @b <FMediaOpenal.h> or @b \#include @b <AL/al.h>, @b <AL/alc.h>, @b <AL/alex.h>
, and @b <AL/alut.h> @n
+ * @b Library: @b openal, and @b alut
* @remarks The capture functions are not supported.
*
*
- * The %OpenAL namespace provides %OpenAL (Version 1.1) methods and utilities.
- * %OpenAL is a cross platform three-dimensional audio method. It can also be referred as a software interface to audio hardware.
+ * The %Openal namespace provides %OpenAL (Version 1.1) methods and utilities.
+ * %OpenAL is a cross platform three-dimensional audio method. It can also be referred to as a software interface for audio hardware.
* The primary purpose of %OpenAL is to allow an application to position audio sources in three-dimensional spaces around a listener, producing reasonable spatialization of the sources for the audio system.
* %OpenAL is appropriate for many audio applications, but is specifically designed for gaming audio.
* This namespace provides %OpenAL Utility Toolkit (ALUT) features.
*
- * For more information, see the <a href="http://connect.creativelabs.com/openal/default.aspx" target="_blank">Creative Labs Web site</a>.
+ * For more information
on the %Openal namespace features, see the <a href="http://connect.creativelabs.com/openal/default.aspx" target="_blank">Creative Labs Web site</a>.
* @endif
*/
namespace Tizen { namespace Media
//
/**
- * @file FMediaPlayer.h
- * @brief This is the header file for the %Player class.
+ * @file FMediaPlayer.h
+ * @brief This is the header file for the %Player class.
*
* This header file contains the declarations of the %Player class.
*/
* - Moving the audio or video content on the basis of time.
* - Controlling the volume of the audio or video content.
* - Looping the audio or video content.
- * - Getting the duration of an audio or the video content.
+ * - Getting the duration of the audio or video content.
* - Playing back multiple audio streams.
*
- * The maximum count of the %Player instance is limited by Media::MediaCapability class.
+ * The maximum count of a %Player instance is limited by the Media::MediaCapability class.
* However, the maximum count is a system wide count and it can be practically applied depending on the CPU model, CPU speed, number of CPU cores, CPU load from other applications, and the available memory.
- * Thus, the exact count can be smaller than the maximum count, in which case the open methods will fail.
+ * Thus, the exact count can be smaller than the maximum count, in which case the open methods fail.
+ * Reasonable working Player count is under 10.
*
* @see OpenFile()
* @see OpenBuffer()
* @see OpenUrl()
- * @see OpenUrlAsync(const Tizen::Base::String, const Tizen::Base::Collection::IMap*)
+ * @see OpenUrlAsync(const Tizen::Base::String&, const Tizen::Base::Collection::IMap*)
* @see OpenUrlAsync(const Tizen::Base::String&, const Tizen::Base::String&, IPlayerProgressiveDownloadListener&, const Tizen::Base::Collection::IMap*)
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/playing_audio.htm">Playing Audio</a> and <a href="../org.tizen.native.appprogramming/html/guide/media/playing_video.htm">Playing Video</a>.
: public Tizen::Base::Object
{
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
*
*/
Player(void);
- /**
+ /**
* This destructor overrides Tizen::Base::Object::~Object(). @n
- * This method deallocates the resources. This method must be called in the same thread as the Construct()
+ * This method deallocates all the resources. This method must be called in the same thread as the Construct()
* method.
*
* @since 2.0
*
* @return An error code
* @param[in] listener An instance of IPlayerEventListener
- * @param[in] pBufferInfo The buffer information to display the video @n
- * This information is essential to play a video but not required for an audio content.
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @param[in] pBufferInfo The buffer information used to display the video @n
+ * This information is essential to play a video but is not required for audio content.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_RESOURCE_UNAVAILABLE The player's resources are unavailable.
* @remarks Multiple instances of %Player can be constructed.
*/
result Construct(IPlayerEventListener& listener, const Tizen::Graphics::BufferInfo* pBufferInfo = null);
- /**
+ /**
* Opens an audio or video file to be played. @n
* The %OpenFile() method works synchronously, but when the second parameter, @c isAsync is set to @c true, this method works asynchronously.
* Note that a method that works asynchronously must implement a listener.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with %Tizen API versions@n
+ * @compatibility This method has compatibility issues with %Tizen API versions @n
* For more information, see @ref CompIoPathPage "here".
* @endif
*
* @return An error code
- * @param[in] mediaLocalPath The local file path of the media source
- * @param[in] isAsync Set to @c true for the asynchronous mode, @n
+ * @param[in] mediaLocalPath The local file path of the media source
+ * @param[in] isAsync Set to @c true for the asynchronous mode, @n
* else @c false for the synchronous mode
- * @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.
+ * @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.
* @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_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_UNSUPPORTED_FORMAT The given content format is not supported.
- * @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.
- * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
- * @remarks This method returns E_SYSTEM when the device runs out of system resources.
+ * @exception E_INVALID_DATA The specified file contains invalid data.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_UNSUPPORTED_FORMAT The specified content format is not supported.
+ * @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.
+ * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
+ * @remarks This method returns @c E_SYSTEM when the device runs out of system resources.
* @see Close()
*/
result OpenFile(const Tizen::Base::String& mediaLocalPath, bool isAsync = false);
- /**
+ /**
* Opens an audio or video streaming content to play through the specified URL. @n
* The %OpenUrl() method works synchronously, but when the second parameter @c isAsync is set to @c true,
* this method works asynchronously. Note that a method that works asynchronously must implement a listener.
* @since 2.0
*
* @return An error code
- * @param[in] mediaUri The URI of the media source
- * @param[in] isAsync Set to @c true for the asynchronous mode, @n
- * else @c false for the synchronous mode
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @param[in] mediaUri The URI of the media source
+ * @param[in] isAsync Set to @c true for the asynchronous mode, @n
+ * else @c false for the synchronous mode
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_CONNECTION_FAILED The network connection has failed.
- * @exception E_UNSUPPORTED_PROTOCOL The protocol is not supported.
- * @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 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.
- * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
+ * @exception E_UNSUPPORTED_PROTOCOL The protocol is not supported.
+ * @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 specified content format is not supported.
+ * @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.
+ * @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.
- * - Input URL should be encoded if there are non-alphanumeric characters in URL.
- * - This method returns E_SYSTEM when the device runs out of system resources.
+ * - The input URL should be encoded if there are non-alphanumeric characters in the URL.
+ * - This method returns @c E_SYSTEM when the device runs out of system resources.
* @see Close()
*/
result OpenUrl(const Tizen::Base::Utility::Uri& mediaUri, bool isAsync = false);
- /**
- * Opens an audio or video content to play on the memory. @n
+ /**
+ * Opens an audio or video content to play in the memory. @n
* The %OpenBuffer() method works synchronously, but when the second parameter @c isAsync is set to @c true, this method works asynchronously.
* Note that a method that works asynchronously must implement a listener.
*
* @since 2.0
*
* @return An error code
- * @param[in] mediaBuffer A pointer to the media source in the external memory
- * @param[in] isAsync Set to @c true for asynchronous mode, @n
- * else @c false for synchronous mode
- * @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.
- * @exception E_OBJ_NOT_FOUND The specified media buffer cannot be found.
- * @exception E_INVALID_DATA The specified buffer contains invalid data.
+ * @param[in] mediaBuffer A pointer to the media source in the external memory
+ * @param[in] isAsync Set to @c true for the asynchronous mode, @n
+ * else @c false for the synchronous mode
+ * @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.
+ * @exception E_OBJ_NOT_FOUND The specified @c mediaBuffer cannot be found.
+ * @exception E_INVALID_DATA The specified @c mediaBuffer 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 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.
- * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
- * @remarks This method returns E_SYSTEM when the device runs out of system resources.
+ * @exception E_UNSUPPORTED_FORMAT The specified content format is not supported.
+ * @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.
+ * @exception E_DISPLAY_RIGHT_VIOLATED The display right is not valid for the specific output device. @b Since: @b 2.1
+ * @remarks This method returns @c E_SYSTEM when the device runs out of system resources.
* @see Close()
*/
result OpenBuffer(const Tizen::Base::ByteBuffer& mediaBuffer, bool isAsync = false);
- /**
+ /**
* Closes the audio or video content. @n
* The %Close() method works synchronously.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @see OpenFile()
* @see OpenBuffer()
* @see OpenUrl()
*/
result Close(void);
- /**
+ /**
* Plays the audio or video content. @n
* The playback starts from the current position. In case of the ::PLAYER_STATE_ENDOFCLIP player state, the audio or video content
* is played again.
* @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.
- * @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_DEVICE_BUSY The device cannot be approached because of other operations.
* @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
* @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
- * @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 .
+ * @exception E_SYSTEM A system error has occurred. @n
+ * If the playback has been paused, it resumes from the last position. @n
+ * @c E_SYSTEM is returned when an unsupported format or codec media data is received while streaming. @n
+ * @c E_SYSTEM is returned when an unsupported 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 ::PLAYER_STATE_ENDOFCLIP,
- * or the Stop() or Pause() method is called .
- * @see Stop()
- * @see Pause()
+ * interface as a parameter, it delivers every video frame of the video content continuously until the state is changed to ::PLAYER_STATE_ENDOFCLIP,
+ * or the Stop() or Pause() method is called .
* @see IPlayerVideoEventListener
*/
result Play(void);
- /**
+ /**
* Stops the playback of the audio or video content. @n
* The %Stop() method works synchronously.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks In the Real Time Streaming Protocol (RTSP), this method stops the media stream and requests the termination of the network session.
* @see Play()
* @see Pause()
*/
result Stop(void);
- /**
+ /**
* Pauses the playback of the audio or video content. @n
* To resume the playback, the Play() method must be called. The %Pause() method works synchronously.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
- * @see Play()
+ * @exception E_SYSTEM A system error has occurred.
* @see Stop()
*/
result Pause(void);
- /**
- * Gets the state of an audio or video player.
+ /**
+ * Gets the state of the audio or video player.
*
* @since 2.0
*
*/
PlayerState GetState(void) const;
- /**
+ /**
* Gets the time for the current playback position of the audio or video content. @n
- * Accuracy of the retrieved time is determined by the subsystem (for example, the time slice of the OS scheduler,
- * time resolution of the audio or video codec, or implementation of the audio or video player).
+ * The accuracy of the retrieved time is determined by the subsystem (for example, the time slice of the OS scheduler,
+ * the time resolution of the audio or video codec, or the implementation of the audio or video player).
* Note that it must not be assumed that the %GetPosition() method can reach the exact position mentioned by GetDuration().
*
* @since 2.0
*
- * @return The current position of the player in milliseconds
- * @exception E_SUCCESS The method is successful.
+ * @return The current position of the player in milliseconds, @n
+ * else @c -1 if it fails
+ * @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 @c -1 when the method fails.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
* @see SeekTo()
*/
long GetPosition(void) const;
- /**
- * Seeks the current playback position of the audio or video content to the specified time. @n
+ /**
+ * Seeks the current playback position of the audio or video content at 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 ::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.
+ * In a video, it may not change the position accurately.
*
* @since 2.0
*
* @return An error code
* @param[in] msTime The time in milliseconds to move to the current playback position @n
* @c 0 indicates the starting position.
- * @exception E_SUCCESS The method is successful.
+ * @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 @c E_INVALID_STATE. @n
- * This method returns @c E_INVALID_STATE, if this method is called again before
+ * This method returns @c E_INVALID_STATE, if it is called again before
* IPlayerEventListener::OnPlayerSeekCompleted() is called.
- * @exception E_OUT_OF_RANGE The specified time is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c msTime is out of the valid range.
* @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()
- * method has a parameter of the IPlayVideoEventListener interface .
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - For a video, this method delivers one video frame at the specified position through the video event.
+ * - Before calling this method, the %Player instance must be created with the Construct()
+ * method having a parameter of the IPlayVideoEventListener interface .
* @see GetPosition()
* @see IPlayerVideoEventListener
*/
result SeekTo(long msTime);
- /**
+ /**
* Gets the total running time of the media source.
*
* @since 2.0
*
- * @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.
+ * @return The running time of the media source in milliseconds, @n
+ * else @c -1 if it fails
+ * @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.
* - 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;
- /**
- * Sets the specified value for the volume of an audio or video player.
+ /**
+ * Sets the specified value for the volume of the audio or video player.
*
* @since 2.0
*
* @return An error code
- * @param[in] volume The new value of volume @n
- * The range of this parameter is @c 0 to @c 100 and it is proportional to the current media sound volume level in setting.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c volume is out of range.
+ * @param[in] volume The new value of the volume @n
+ * This parameter ranges from @c 0 to @c 100 and is proportional to the current media sound volume level in setting.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c volume is out of the valid range.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @remarks If an application wants to start the playback of a media content with the given audio sound, this method should be called before calling the Open methods.
+ * This is because the initial audio packet is not applied as the given audio volume, if this method is called after the open methods are called.
* @see GetVolume()
* @see IsMuted()
* @see SetMute()
- * @remarks If an application wants to start a playback of the media content with the given audio sound, this method should be called before calling the Open methods.
- * This is because the initial audio packet is not applied as the given audio volume if this method is called after the open methods have been called.
*/
result SetVolume(int volume);
- /**
- * Gets the current volume of an audio or video player.
+ /**
+ * Gets the current volume of the audio or video player.
*
* @since 2.0
*
*/
int GetVolume(void) const;
- /**
- * Sets the mute status of an audio or video player.
+ /**
+ * Sets the mute status of the audio or video player.
*
* @since 2.0
*
* @return An error code
* @param[in] mute Set to @c true to mute the audio or video player, @n
* else @c false
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @see GetVolume()
- * @see SetVolume()
- * @see IsMuted()
- * @remarks If an application wants to start a playback of the media content without any sound, this method should be called before calling the Open methods.
- * This is because the initial audio packet is not applied as the given audio volume if this method is called after the open methods have been called.
+ * @remarks If an application wants to start the playback of a media content without any sound, this method should be called before calling the Open() methods.
+ * This is because the initial audio packet is not applied as the given audio volume, if this method is called after the Open() methods are called.
*/
result SetMute(bool mute);
- /**
- * Checks the mute status of an audio or video player.
+ /**
+ * Checks the mute status of the audio or video player.
*
* @since 2.0
*
*/
bool IsMuted(void) const;
- /**
- * Sets an audio or video player to be in a loop. @n
- * Sets the looping to @c true to continuously play the audio or video content.
+ /**
+ * Sets the audio or video player to be in a loop. @n
+ * Sets the looping to @c true to continuously play an audio or video content.
*
* @since 2.0
*
* @return An error code
* @param[in] looping Set to @c true to play the audio or video content in a loop, @n
* else @c false
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @remarks In streaming, this method throws @c E_INVALID_STATE for the cost of network.
+ * @remarks In streaming, this method throws @c E_INVALID_STATE for the cost of the network.
* @see IsLooping()
*/
result SetLooping(bool looping);
- /**
+ /**
* Checks whether the audio or video player is in a loop.
*
* @since 2.0
*
* @since 2.0
*
- * @return A pointer to the MediaStreamInfo instance containing metadata for the current media stream
- * @exception E_SUCCESS The method is successful.
+ * @return A pointer to the MediaStreamInfo instance that contains the metadata of the current media stream
+ * @exception E_SUCCESS The method is successful.
* @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_INVALID_CONTENT The content is inappropriate to compose the 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.
+ * - This method returns the 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;
- /**
- * Sets the rendering buffer for the video playback.
+ /**
+ * Sets the rendering buffer for a video playback.
*
* @since 2.0
*
* @return An error code
- * @param[in] bufferInfo The buffer information to display the video
- * @exception E_SUCCESS The method is successful.
+ * @param[in] bufferInfo The buffer information used to display the video
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @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 .
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred. @n
+ * @c E_SYSTEM is returned when an unsupported resolution is set for rendering .
* @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.
*/
result SetRenderingBuffer(const Tizen::Graphics::BufferInfo& bufferInfo);
- /**
+ /**
* Initializes this instance of %Player with the specified parameters.
*
* @since 2.0
* @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.
- * @remarks This method constructs the %Player instance to render the video content into the buffer of the video event listener.
+ * @remarks This method constructs a %Player instance to render the video content into the buffer of the video event listener.
*/
result Construct(IPlayerEventListener& listener, IPlayerVideoEventListener& videoListener);
- /**
+ /**
* 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 ::PLAYER_STATE_OPENED state of the %Player instance, and the state of the %Player instance is changed to
* @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
+ * @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 @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.
+ * @exception E_SYSTEM A system error has occurred.
* @remarks In the Real Time Streaming Protocol (RTSP), this method does not work properly.
- * The application must wait till the invocation of IPlayerVideoEventListener::OnVideoFrameDecoded() callback from framework for proper functioning.
+ * The application must wait till the invocation of the IPlayerVideoEventListener::OnVideoFrameDecoded() callback from the framework, for proper functioning.
*/
result CaptureVideo(void);
- /**
+ /**
* Sets the audio stream type.
*
* @since 2.0
*
- * @return An error code
- * @param[in] type An audio stream type
+ * @return An error code
+ * @param[in] type The audio stream type
* @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.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @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.
+ * - This method works for the ::PLAYER_STATE_INITIALIZED or ::PLAYER_STATE_CLOSED state of the %Player instance.
+ * - In other states of the %Player instance, this method returns @c E_SUCCESS, but the audio stream type is not changed properly.
*/
result SetAudioStreamType(AudioStreamType type);
- /**
+ /**
* Opens an audio or video streaming content to play through the specified URL with the HTTP header. @n
- * The %OpenUrlAsync() method works asynchronously, thus application can call further methods of %Player after IPlayerEventListener::OnPlayerOpened() is called.
+ * The %OpenUrlAsync() method works asynchronously, thus an application can call other methods of %Player after IPlayerEventListener::OnPlayerOpened() is called.
*
* @since 2.0
*
* @return An error code
* @param[in] url The URL of the media source
- * @param[in] pHeader The list of field and value pairs that will be added in HTTP request header. @n
- The types of field and value are described in the Programming Guide. If @c null, then default values will be set.
+ * @param[in] pHeader The list of field and value pairs that are added in the HTTP request header @n
+ * The types of fields and values are described in the Programming Guide @n
+ * If @c null, then the default values are set.
*
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @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 See Programming Guide for the detail information of supported HTTP header fields.
+ * @remarks See the Programming Guide for detailed information on the supported HTTP header fields.
* @see Close()
*/
result OpenUrlAsync(const Tizen::Base::String& url, const Tizen::Base::Collection::IMap* pHeader = null);
- /**
- * Opens an audio or video streaming content to play through the specified HTTP URL with the HTTP header for the progressive download playback. @n
- * The %OpenUrlAsync() method works asynchronously, thus application can call further methods of %Player after IPlayerEventListener::OnPlayerOpened() is called.
- * The content information of the media source must be located at the beginning of the file for the progressive download playback. Otherwise, it does not guarantee to play and download media stream properly.
+ /**
+ * Opens an audio or video streaming content to play through the specified HTTP URL with the HTTP header for a progressive download playback. @n
+ * The %OpenUrlAsync() method works asynchronously, thus an application can call other methods of %Player after IPlayerEventListener::OnPlayerOpened() is called.
+ * The content information of the media source must be located at the beginning of the file for a progressive download playback. Otherwise, it does not guarantee the playback and download of a media stream properly.
*
* @since 2.0
*
* @return An error code
* @param[in] url The URL of the media source
- * @param[in] filePath The file path on local file system where the downloaded content will be saved
+ * @param[in] filePath The file path on the local file system where the downloaded content is saved
* @param[in] listener The download listener
- * @param[in] pHeader The list of field and value pairs that will be added in HTTP request header @n
- * The types of field and value are described in the Programming Guide.
- * If @c null, then default values will be set.
+ * @param[in] pHeader The list of field and value pairs that are added in the HTTP request header @n
+ * The types of fields and values are described in the Programming Guide @n
+ * If @c null, then the default values are set.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_UNSUPPORTED_PROTOCOL The protocol is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @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.
+ * - If the specified file name already exists, then the old file is overwritten with the new one.
+ * - See Programming Guide for detailed information on the 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);
- /**
- * Sets the interval of calling the progress event.
+ /**
+ * Sets the interval for calling the progress event.
*
* @since 2.0
*
- * @param[in] percent The progress period interval as a percentage 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.
+ * @param[in] percent The progress period interval as a percentage value @n
+ * The default value is @c 10.
+ * @remarks If the server does not provide the information about the content size, the progress event occurs randomly.
* @see IPlayerProgressiveDownloadListener::OnPlayerProgressiveDownloadInProgress()
*/
void SetProgressiveDownloadIntervalByPercent(int percent);
- /**
+ /**
* Initializes this instance of %Player with the specified parameters.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener An IPlayerEventListener instance
- * @param[in] videoTexture An VideoTexture instance
+ * @param[in] listener An IPlayerEventListener instance
+ * @param[in] videoTexture An VideoTexture instance
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_RESOURCE_UNAVAILABLE The player's resources are unavailable.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks This method constructs the %Player instance to render the video content into the video texture area.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_RESOURCE_UNAVAILABLE The player's resources are unavailable.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks This method constructs a %Player instance to render video content into a video texture area.
*/
result Construct(IPlayerEventListener& listener, Tizen::Graphics::Opengl::VideoTexture& videoTexture);
- /**
- * Gets the current downloading progress of HTTP streaming playback in percent.
+ /**
+ * Gets the current downloading progress of an HTTP streaming playback in percent.
*
* @since 2.1
*
- * @return The current position in percent
- * @exception E_SUCCESS The method is successful.
- * @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.
+ * @return The current position in percent, @n
+ * else @c -if it fails
+ * @exception E_SUCCESS The method is successful.
+ * @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 ::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 @c -1 when the method fails.
+ * - This method works only for the ::PLAYER_STATE_PLAYING or ::PLAYER_STATE_PAUSED state of the %Player instance.
+ * - This method is not supported in HTTP Live Streaming.
+ * - The specific error code can be accessed using the GetLastResult() method.
*/
int GetHttpStreamingDownloadProgress(void) const;
-/**
-* Seeks the current playback position of the video content to the nearest key frame at the specified time if the content
-* contains key frames.
-* The %SeekVideoKeyFrameCloseTo() method works asynchronously with the IPlayerEventListener::OnPlayerSeekCompleted() method.
-*
-* @since 2.2
-* @return An error code
-* @param[in] msTime The time in milliseconds to move to the current playback position
-* @c 0 indicates the starting position.
-* @exception E_SUCCESS The method is successful
-* @exception E_INVALID_STATE The given instance is in an invalid state for this method. @n
-* 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.
-* @remarks
-* - This method only works for the PLAYER_STATE_PLAYING, PLAYER_STATE_PAUSED, and PLAYER_STATE_OPENED states of the player instance.
-* - This method is not guaranteed to work correctly when the content does not have key frames.
-* - This method is faster than SeekTo() but the seeking accuracy is worse than %SeekTo().
-**/
+ /**
+ * Seeks the current playback position of the video content to the nearest key frame at the specified time if the content
+ * contains key frames.
+ * The %SeekVideoKeyFrameCloseTo() method works asynchronously with the IPlayerEventListener::OnPlayerSeekCompleted() method.
+ *
+ * @since 2.2
+ * @return An error code
+ * @param[in] msTime The time in milliseconds to move to the current playback position @n
+ * @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 @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 @c msTime is out of the valid range.
+ * @exception E_INVALID_DATA The media data is inappropriate for seeking.
+ * @remarks
+ * - This method only works for the ::PLAYER_STATE_PLAYING, ::PLAYER_STATE_PAUSED, and ::PLAYER_STATE_OPENED states of the %Player instance.
+ * - This method is not guaranteed to work correctly when the content does not have key frames.
+ * - This method is faster than SeekTo() but the seeking accuracy is worse than %SeekTo().
+ */
result SeekVideoKeyFrameCloseTo(long msTime);
//
/**
- * @file FMediaPlayerTypes.h
- * @brief This is the header file for the enumerations of the Player class.
+ * @file FMediaPlayerTypes.h
+ * @brief This is the header file for the enumerations of the %Player class.
*
* This header file contains the declarations of the enumerations of the Player class.
*/
*
* Defines the state of the player.
*
- * @since 2.0
+ * @since 2.0
*
* @see Tizen::Media::Player::GetState()
*/
enum PlayerState
{
PLAYER_STATE_INITIALIZED, /**< The player is initialized */
- PLAYER_STATE_OPENING, /**< The player opening behavior is processed */
+ PLAYER_STATE_OPENING, /**< The player's opening behavior is processed */
PLAYER_STATE_OPENED, /**< The source is opened */
PLAYER_STATE_ENDOFCLIP, /**< The player has reached the end of the clip */
PLAYER_STATE_STOPPED, /**< The player has stopped and has no current play-time, but the media content is still opened and initialized */
- PLAYER_STATE_PAUSED, /**< The player playback is paused */
+ PLAYER_STATE_PAUSED, /**< The player's playback is paused */
PLAYER_STATE_PLAYING, /**< The player is playing the media content */
PLAYER_STATE_CLOSED, /**< The source is closed */
PLAYER_STATE_ERROR, /**< An error has occurred */
/**
* @enum PlayerErrorReason
*
- * Defines the player error reason.
+ * Defines the player's error reason.
*
* @since 2.0
*/
PLAYER_ERROR_STREAMING_TIMEOUT, /**< The streaming has timed out */
PLAYER_ERROR_TRANSPORT, /**< The transport has failed */
PLAYER_ERROR_SERVER, /**< The server has failed */
- PLAYER_ERROR_OUT_OF_MEMORY, /**< The memory is insufficient*/
+ PLAYER_ERROR_OUT_OF_MEMORY, /**< The memory is insufficient */
PLAYER_ERROR_DEVICE_FAILED, /**< The player device has failed */
- 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 */
- PLAYER_ERROR_DISPLAY_RIGHT_VIOLATED, /**< The display right is not valid for the specific output device @b Since: @b 2.1*/
+ 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 */
+ PLAYER_ERROR_DISPLAY_RIGHT_VIOLATED, /**< The display right is not valid for the specific output device @b Since: @b 2.1 */
};
//
/**
- * @file FMediaRecorderTypes.h
- * @brief This is the header file for the enumerations of the AudioRecorder and VideoRecorder classes.
+ * @file FMediaRecorderTypes.h
+ * @brief This is the header file for the enumerations of the %AudioRecorder and %VideoRecorder classes.
*
* This header file contains the definitions of the enumerations of the AudioRecorder and VideoRecorder classes.
*/
*/
enum RecorderState
{
- RECORDER_STATE_INITIALIZED, /**< The recorder is initialized */
- RECORDER_STATE_OPENED, /**< The file to write into is opened */
- RECORDER_STATE_ENDOF_FILE, /**< The recorder has reached the end of size or time */
- RECORDER_STATE_STOPPING, /**< The recorder stops recording */
- RECORDER_STATE_STOPPED, /**< The recorder is stopped and has no current record-time @n
- However, the media content is opened and initialized. */
- RECORDER_STATE_PAUSING, /**< The recorder is paused at a specific position */
- RECORDER_STATE_PAUSED, /**< The recorder is paused */
+ RECORDER_STATE_INITIALIZED, /**< The recorder is initialized */
+ RECORDER_STATE_OPENED, /**< The file to write into is opened */
+ RECORDER_STATE_ENDOF_FILE, /**< The recorder has reached the end of the size or time */
+ RECORDER_STATE_STOPPING, /**< The recorder has stopped recording */
+ RECORDER_STATE_STOPPED, /**< The recorder has stopped and has no current record-time @n
+ However, the media content is opened and initialized */
+ RECORDER_STATE_PAUSING, /**< The recorder is paused at a specific position */
+ RECORDER_STATE_PAUSED, /**< The recorder is paused */
RECORDER_STATE_STARTING, /**< The recording operation is starting */
- RECORDER_STATE_RECORDING, /**< The recording state of the recorder */
- RECORDER_STATE_CLOSING, /**< The recorder process is closing */
- RECORDER_STATE_CLOSED, /**< The file is closed */
- RECORDER_STATE_ERROR, /**< An error has occurred in the recorder */
+ RECORDER_STATE_RECORDING, /**< The recording state of the recorder */
+ RECORDER_STATE_CLOSING, /**< The recorder process is closing */
+ RECORDER_STATE_CLOSED, /**< The file is closed */
+ RECORDER_STATE_ERROR, /**< An error has occurred in the recorder */
};
/**
enum RecordingQuality
{
RECORDING_QUALITY_LOW, /**< The low quality */
- RECORDING_QUALITY_MEDIUM, /**< The medium quality */
- RECORDING_QUALITY_HIGH, /**< The high quality */
+ RECORDING_QUALITY_MEDIUM, /**< The medium quality */
+ RECORDING_QUALITY_HIGH, /**< The high quality */
};
/**
* @enum RecordingEndCondition
*
- * Defines the record ending by reaching the limit.
+ * Defines the end condition of the recording.
*
* @since 2.0
*
enum RecorderErrorReason
{
RECORDER_ERROR_NONE, // Undefined error
- RECORDER_ERROR_OUT_OF_STORAGE, /**< The storage is insufficient */
- RECORDER_ERROR_STORAGE_FAILED, /**< The device storage access has failed */
- RECORDER_ERROR_DEVICE_FAILED, /**< The recording device has failed */
+ RECORDER_ERROR_OUT_OF_STORAGE, /**< The storage is insufficient */
+ RECORDER_ERROR_STORAGE_FAILED, /**< The device storage access has failed */
+ RECORDER_ERROR_DEVICE_FAILED, /**< The recording device has failed */
};
/**
//
/**
- * @file FMediaTone.h
- * @brief This is the header file for the %Tone class.
+ * @file FMediaTone.h
+ * @brief This is the header file for the %Tone class.
*
* This header file contains the declarations of the %Tone class.
*/
*
* @since 2.0
*
- * @remarks
- * The instance of the %Tone class can be played using TonePlayer.
+ * @remarks The instance of the %Tone class can be played using TonePlayer.
*
* The %Tone class generates a tone and provides methods for:
* - Generating a single tone.
* - Generating dual tones with two different values of frequencies.
- * - Generating a silent tone for a specified period of interval.
+ * - Generating a silent tone for a specified time interval.
*
*/
class _OSP_EXPORT_ Tone
: public Tizen::Base::Object
{
public:
- /**
- * 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.
+ /**
+ * This is the default constructor for this class. @n
+ * Initializes this instance of %Tone with the zero value. @n
*
* @since 2.0
*
/**
* This destructor overrides Tizen::Base::Object::~Object(). @n
- * The resources are deallocated by this method.
- * This method must be called in the same thread as the Construct() method.
+ * All the resources are deallocated by this method. @n
*
* @since 2.0
*
- * @see Construct()
*/
virtual ~Tone(void);
public:
- /**
+ /**
* @if OSPDEPREC
- * Initializes this instance of %Tone with the values of the specified tone.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because this method is not used as 2-phase constructor.
- * @since 2.0
- *
- * @return An error code
- * @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
- * 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.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE A specified input parameter is out of range.
- * @remarks If both the input frequencies are @c 0 Hz, the tone is set as a silent tone.
+ * Initializes this instance of %Tone with the values of the specified tone.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because this method is not used as a two-phase constructor.
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] firstFrequency The first frequency of the dual tone in Hertz (Hz) @n
+ * This parameter ranges from @c 0 Hz to @c 15000 Hz.
+ * @param[in] secondFrequency The second frequency of the dual tone in Hertz (Hz) @n
+ * This parameter ranges from @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.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE A specified input parameter is out of the valid range.
+ * @remarks If both the input frequencies are @c 0 Hz, the tone is set as a silent tone.
* @endif
*/
result Construct(int firstFrequency, int secondFrequency, long duration);
- /**
+ /**
* @if OSPDEPREC
- * Initializes this instance of %Tone with the values of the specified DTMF preset tone.
- *
- * @brief <i> [Deprecated] </i>
- * @deprecated This method is deprecated because this method is not used as 2-phase constructor.
- * @since 2.0
- *
- * @return An error code
- * @param[in] preset The preset of the DTMF tone
- * @param[in] duration The duration of the tone in milliseconds @n
- * The value of this parameter must be greater than @c 0.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE A specified input parameter is out of range.
+ * Initializes this instance of %Tone with the values of the specified DTMF preset tone.
+ *
+ * @brief <i> [Deprecated] </i>
+ * @deprecated This method is deprecated because this method is not used as a two-phase constructor.
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] preset The preset of the DTMF tone
+ * @param[in] duration The duration of the tone in milliseconds @n
+ * The value of this parameter must be greater than @c 0.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE A specified input parameter is out of the valid range.
* @endif
*/
result Construct(DtmfPreset preset, long duration);
- /**
- * Gets the current frequency.
+ /**
+ * Gets the current frequency.
*
- * @since 2.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)
- * @exception E_SUCCESS The method is successful.
- * @remarks The specified input parameters of this method are @c -1 when an exception occurs.
+ * @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)
+ * @exception E_SUCCESS The method is successful.
+ * @remarks The specified input parameters of this method are set to @c -1 if an exception occurs.
*/
result GetFrequency(int& firstFrequency, int& secondFrequency) const;
- /**
- * Gets the current duration.
+ /**
+ * Gets the current duration.
*
- * @since 2.0
+ * @since 2.0
*
- * @return The duration of the tone
- * @remarks This method returns @c 0 before the Construct() method is called.
+ * @return The duration of the tone
*/
long GetDuration(void) const;
- /**
- * Initializes this instance of %Tone with the values of the specified tone.
+ /**
+ * Initializes this instance of %Tone with the values of the specified tone.
*
- * @since 2.0
+ * @since 2.0
*
- * @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
- * 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.
- * @remarks If both the input frequencies are @c 0 Hz, the tone is set as a silent tone.
+ * @param[in] firstFrequency The first frequency of the dual tone in Hertz (Hz) @n
+ * This parameter ranges from @c 0 Hz to @c 15000 Hz.
+ * @param[in] secondFrequency The second frequency of the dual tone in Hertz (Hz) @n
+ * This parameter ranges from @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.
+ * @remarks If both the input frequencies are @c 0 Hz, the tone is set as a silent tone.
*/
Tone(int firstFrequency, int secondFrequency, long duration);
- /**
+ /**
* Initializes this instance of %Tone with the values of the specified DTMF preset tone.
*
* @since 2.0
*
- * @param[in] preset The preset of the DTMF tone
- * @param[in] duration The duration of the tone in milliseconds @n
- * The value of this parameter must be greater than @c 0.
+ * @param[in] preset The preset of the DTMF tone
+ * @param[in] duration The duration of the tone in milliseconds @n
+ * The value of this parameter must be greater than @c 0.
*/
Tone(DtmfPreset preset, long duration);
- /**
- * Compares the specified instance of %Tone with the calling instance.
+ /**
+ * Compares the specified instance of %Tone with the current instance.
*
* @since 2.0
*
- * @return @c true if the values match, @n
- * else @c false
+ * @return @c true if the values match, @n
+ * else @c false
* @param[in] rhs The other Tizen::Base::Object to compare
- * @see Tizen::Base::Object::Equals()
+ * @see Tizen::Base::Object::Equals()
*/
virtual bool Equals(const Object& rhs) const;
- /**
+ /**
* Gets the hash value of the current instance.
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
*/
virtual int GetHashCode(void) const;
- /**
+ /**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @return The copy of this instance
- * @param[in] rhs An instance of %Tone
+ * @return A copy of this instance
+ * @param[in] rhs An instance of %Tone to copy
*/
Tone(const Tone& rhs);
- /**
- * Copying of objects using this copy assignment operator is allowed.
- *
- * @since 2.0
- *
- * @return The reference of this instance
- * @param[in] rhs An instance of %Tone
- */
+ /**
+ * Copying of objects using this copy assignment operator is allowed.
+ *
+ * @since 2.0
+ *
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %Tone to copy
+ */
Tone& operator =(const Tone& rhs);
private:
//
/**
- * @file FMediaTonePlayer.h
- * @brief This is the header file for the %TonePlayer class.
+ * @file FMediaTonePlayer.h
+ * @brief This is the header file for the %TonePlayer class.
*
* This header file contains the declarations of the %TonePlayer class.
*/
class _TonePlayerImpl;
/**
* @class TonePlayer
- * @brief This class plays the tone(s).
+ * @brief This class plays a tone(s).
*
* @since 2.0
*
- * @remarks
- * The maximum number of the %TonePlayer instance is limited by Media::MediaCapability class.
- * However, the maximum count is a system wide count and it can be practically applied depending on the CPU model, CPU speed, number of CPU cores, CPU load from other applications, and the available memory.
- * Thus, the exact count can be smaller than the maximum count, in which case the open methods will fail.
+ * @remarks The maximum number of the %TonePlayer instances is limited by the Media::MediaCapability class.
+ * However, the maximum count is a system wide count and it can be practically applied depending on the CPU model, CPU speed, number of CPU cores, CPU load from other applications, and the available memory.
+ * Thus, the exact count can be smaller than the maximum count, in which case the open methods fail.
*
* @see Open(const Tizen::Base::Collection::IList&, int)
* @see Open(const Tizen::Media::Tone&, int)
*
* The %TonePlayer class provides methods for:
- * - Playing the tone(s)
+ * - Playing tone(s)
* - Controlling a tone player instance
*
* The following example demonstrates how to use the %TonePlayer class for playing a single tone and a list of tones.
: public Tizen::Base::Object
{
public:
- /**
- * 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
- *
- */
+ /**
+ * 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
+ *
+ */
TonePlayer(void);
- /**
- * This is the destructor for this class. @n
- * All the allocated resources are released by this method. @n
- * This method must be called in the same thread as the Construct() method.
- *
- * @since 2.0
- *
- */
+ /**
+ * This is the destructor for this class. @n
+ * All the allocated resources are released by this method. @n
+ * This method must be called in the same thread as the Construct() method.
+ *
+ * @since 2.0
+ *
+ */
virtual ~TonePlayer(void);
- /**
+ /**
* Initializes this instance of %TonePlayer with the specified listener.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener An instance of ITonePlayerEventListener
- * @exception E_SUCCESS The method is successful.
+ * @param[in] listener An instance of ITonePlayerEventListener
+ * @exception E_SUCCESS The method is successful.
* @exception E_RESOURCE_UNAVAILABLE The tone player's resources are unavailable.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_SYSTEM A system error has occurred.
*/
result Construct(Tizen::Media::ITonePlayerEventListener& listener);
- /**
+ /**
* Opens the specified list of tones.
*
* @since 2.0
*
* @return An error code
- * @param[in] toneList A list of Tone instances
- * @param[in] repeatCount The number of times the list of tones should be played @n
+ * @param[in] toneList The list of Tone instances
+ * @param[in] repeatCount The number of times the list of tones are played @n
* This number is greater than or equal to @c 1.
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_OBJ_NOT_FOUND The specified tone instance cannot be found in the list.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OUT_OF_RANGE The count is out of range.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The item(s) of the specified @c toneList must be an instance(s) of Tone.
+ * @exception E_OUT_OF_RANGE The count is out of the valid range.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The item(s) of the specified @c toneList must be an instance(s) of Tone.
+ * - This method returns @c E_INVALID_STATE when the device runs out of audio resources.
* @see Close()
- * @remarks This method returns E_IVALID_STATE when the device runs out of audio resources.
*/
result Open(const Tizen::Base::Collection::IList& toneList, int repeatCount = 1);
- /**
+ /**
* Opens the specified tone.
*
* @since 2.0
*
* @return An error code
* @param[in] tone The tone instance
- * @param[in] repeatCount The number of times a tone should be played @n
+ * @param[in] repeatCount The number of times a tone is played @n
* This number is greater than or equal to @c 1.
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OUT_OF_RANGE The count is out of range.
- * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_RANGE The count is out of the valid range.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks This method returns @c E_INVALID_STATE when the device runs out of audio resources.
* @see Close()
- * @remarks This method returns E_IVALID_STATE when the device runs out of audio resources.
*/
result Open(const Tizen::Media::Tone& tone, int repeatCount = 1);
- /**
+ /**
* Plays the playback or resumes the playback if Pause() has been called. @n
- * In case of the @c TONEPLAYER_STATE_ENDOFTONE state, the tone(s) can be played again.
+ * In case of the ::TONE_PLAYER_STATE_END_OF_TONE state, the tone(s) can be played again.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_DEVICE_BUSY The device is busy for other operations.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The playback starts from the current position. If playback is paused, playback restarts from
+ * @exception E_DEVICE_BUSY The device is busy due to other operations.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The playback starts from the current position. If the playback is paused, it restarts from
* the last position.
* @see Stop()
* @see Pause()
*/
result Play(void);
- /**
+ /**
* Stops the playback.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @see Play()
* @see Pause()
*/
result Stop(void);
- /**
+ /**
* Pauses the playback. @n
* To resume the paused playback, call Play().
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @see Stop()
*/
result Pause(void);
- /**
+ /**
* Sets the volume level.
*
* @since 2.0
*
* @return An error code
- * @param[in] volume The new value for @c volume @n
- * The range of this parameter is @c 0 to @c 100 and it is proportional to the current media sound volume level in setting.
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c volume parameter is out of range.
+ * @param[in] volume The new value for the volume @n
+ * This parameter ranges from @c 0 to @c 100 and is proportional to the current media sound volume level in setting.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c volume is out of the valid range.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @see GetVolume()
*/
result SetVolume(int volume);
- /**
+ /**
* Gets the current volume level.
*
* @since 2.0
*/
int GetVolume(void) const;
- /**
+ /**
* Closes the tone player.
*
* @since 2.0
*
* @return An error code
- * @exception E_SUCCESS The method is successful.
+ * @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.
+ * @exception E_SYSTEM A system error has occurred.
* @see Open()
*/
result Close(void);
- /**
+ /**
* Gets the current state of the tone player instance.
*
* @since 2.0
*/
TonePlayerState GetState(void) const;
- /**
- * Sets an audio stream type for tone playback.
+ /**
+ * Sets the audio stream type for a tone playback.
*
* @since 2.0
*
- * @return An error code
- * @param[in] type An audio stream type
- * @exception E_SUCCESS The method is successful.
+ * @return An error code
+ * @param[in] type The audio stream type
+ * @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_INVALID_ARG The specified input parameter is invalid.
- * @remarks This method should be called before Open().
+ * @exception E_INVALID_ARG The specified input parameter is invalid.
+ * @remarks This method should be called before Open().
*/
result SetAudioStreamType(AudioStreamType type);
//
/**
- * @file FMediaToneTypes.h
- * @brief This is the header file for the common types of Tone and TonePlayer.
+ * @file FMediaToneTypes.h
+ * @brief This is the header file for the common types of %Tone and %TonePlayer.
*
- * This header file contains the declarations of the enumerations of the Tone class.
+ * This header file contains the declarations of the enumerations of the Tone and TonePlayer classes.
*/
#ifndef _FMEDIA_TONE_TYPES_H_
TONE_PLAYER_STATE_INITIALIZED, /**< The tone player is initialized */
TONE_PLAYER_STATE_OPENED, /**< The tone player instance is opened */
TONE_PLAYER_STATE_PLAYING, /**< The tone player is playing the tone(s) */
- TONE_PLAYER_STATE_PAUSED, /**< The tone player playback is paused */
+ TONE_PLAYER_STATE_PAUSED, /**< The tone player's playback is paused */
TONE_PLAYER_STATE_STOPPED, /**< The tone player has stopped and has no current play-time @n
- However, the tone(s) is still opened and initialized. */
+ However, the tone(s) is still opened and initialized */
TONE_PLAYER_STATE_CLOSED, /**< The tone player is closed */
TONE_PLAYER_STATE_END_OF_TONE, /**< The tone player has reached the end of the tone(s) */
TONE_PLAYER_STATE_ERROR, /**< An error has occurred */
/**
* @class VideoDecoder
- * @brief This class decodes a compressed video stream into a raw video data.
+ * @brief This class decodes a compressed video stream into raw video data.
*
* @since 2.0
*
- * The %VideoDecoder class decodes a compressed video stream into a raw video data.
+ * The %VideoDecoder class decodes a compressed video stream into raw video data.
* The video decoding formats, such as CODEC_H263, CODEC_MPEG4, and CODEC_H264 are supported.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm">Encoding and Decoding Video</a>.
: public Tizen::Base::Object
{
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.
- *
- * @since 2.0
- *
- */
+ /**
+ * 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
+ *
+ */
VideoDecoder(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
virtual ~VideoDecoder(void);
- /**
- * Initializes this instance of %VideoDecoder with the specified parameters.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] type The codec type
-
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">optional parameters</a>
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_CODEC The specified decoder is not supported.
- * @exception E_OUT_OF_RANGE A specified input parameter has a value that is out of range.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The key type of the specified option is Tizen::Base::Integer and the value type varies depending on the key type.
- */
+ /**
+ * Initializes this instance of %VideoDecoder with the specified parameters.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] type The codec type
+
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">optional parameters</a>
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_CODEC The specified decoder is not supported.
+ * @exception E_OUT_OF_RANGE A specified input parameter is out of the valid range.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The key type of the specified option is Tizen::Base::Integer and the value type varies depending on the key type.
+ */
result Construct(CodecType type, const Tizen::Base::Collection::HashMap* pOption = null);
public:
- /**
- * Probes whether the video data can be decoded and sets the width, height, and pixel format of the video data.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] srcBuf The source buffer that stores the compressed video data
- * @param[out] width The width of the decoded video frame
- * @param[out] height The height of the decoded video frame
- * @param[out] pixelFormat The pixel format of the decoded video frame
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c srcBuf is invalid.
- * @exception E_UNSUPPORTED_FORMAT The input data is not in a supported format.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks This method resets the internal state of the video decoder.
- */
+ /**
+ * Probes whether the video data can be decoded and sets the width, height, and pixel format of the video data.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] srcBuf The source buffer that stores the compressed video data
+ * @param[out] width The width of the decoded video frame
+ * @param[out] height The height of the decoded video frame
+ * @param[out] pixelFormat The pixel format of the decoded video frame
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c srcBuf is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The input data is not in a supported format.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks This method resets the internal state of the video decoder.
+ */
result Probe(const Tizen::Base::ByteBuffer& srcBuf, int& width, int& height, MediaPixelFormat& pixelFormat);
- /**
- * Decodes the video data from the source buffer and stores the decoded data into the destination buffer.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] srcBuf The source buffer that stores the compressed video data
- * @param[out] dstBuf The destination buffer that stores the decoded video data
- * @param[out] gotFrame @c true when a frame is decoded, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c srcBuf or @c dstBuf is invalid.
- * @exception E_UNSUPPORTED_FORMAT The input data is not in a supported format.
- * @exception E_OUT_OF_MEMORY The destination buffer has insufficient memory.
- * @exception E_DIMENSION_CHANGED The dimension of video stream has changed.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks
- * - The destination buffer must have sufficient free space to store the decoded frame data.
- * - The decoder starts the decoding of the frame from the current position of the source buffer,
- * and moves the position of the source buffer to the end of the consumed data.
- * The decoder also fills the destination buffer with the decoded frame from the current position of the destination buffer,
- * and moves the position of the destination buffer to the end of the decoded frame.
- * - When the first decoding begins, the @c E_DIMENSION_CHANGED exception can occur.
- * An exception can also occur when the dimension of the video frame in the bitstream has changed.
- * An application should increase the size of @c dstBuf if the @c dstBuf cannot hold the video frame with new dimensions.
- * The video frame can be received even if the result is @c E_DIMENSION_CHANGED.
- * The application should check the @c position of the destination buffer and the value of @c gotFrame
- * when the result is @c E_DIMENSION_CHANGED.
- * - The H.264 video decoder returns data with the width and height in multiples of 16.
- * The application should detect the width and height of the frame and crop the decoder's output data if the original dimension is not a multiple of @c 16.
- * @see Probe()
- */
+ /**
+ * Decodes the video data from the source buffer and stores the decoded data into the destination buffer.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] srcBuf The source buffer that stores the compressed video data
+ * @param[out] dstBuf The destination buffer that stores the decoded video data
+ * @param[out] gotFrame @c true when a frame is decoded, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c srcBuf or @c dstBuf is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The input data is not in a supported format.
+ * @exception E_OUT_OF_MEMORY The destination buffer has insufficient memory.
+ * @exception E_DIMENSION_CHANGED The dimension of the video stream has changed.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The destination buffer must have sufficient free space to store the decoded frame data.
+ * - The decoder starts the decoding of the frame from the current position of the source buffer,
+ * and moves the position of the source buffer to the end of the consumed data.
+ * The decoder also fills the destination buffer with the decoded frame from the current position of the destination buffer,
+ * and moves the position of the destination buffer to the end of the decoded frame.
+ * - When the first decoding begins, the @c E_DIMENSION_CHANGED exception can occur.
+ * An exception can also occur when the dimension of the video frame in the bitstream has changed.
+ * An application should increase the size of @c dstBuf if @c dstBuf cannot hold the video frame with the new dimensions.
+ * The video frame can be received even if the result is @c E_DIMENSION_CHANGED.
+ * The application should check the @c position of the destination buffer and the value of @c gotFrame,
+ * when the result is @c E_DIMENSION_CHANGED.
+ * - The H.264 video decoder returns data with the width and height in multiples of @c 16.
+ * The application should detect the width and height of the frame and crop the decoder's output data if the original dimension is not a multiple of @c 16.
+ * @see Probe()
+ */
result Decode(Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& dstBuf, bool& gotFrame);
- /**
- * Resets the internal state of the video decoder to process a new video stream.
- *
- * @since 2.0
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- */
+ /**
+ * Resets the internal state of the video decoder to process a new video stream.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ */
result Reset(void);
- /**
- * Gets the specified property value of this instance.
- *
- * @since 2.0
- *
- * @return An error code
-
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">key</a> whose value is required
- * @param[out] value The obtained property value
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG The specified @c key is not supported.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The property whose value is of type enum can be obtained by using this method.
- */
+ /**
+ * Gets the specified property value of this instance.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">key</a> whose value is required
+ * @param[out] value The obtained property value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG The specified @c key is not supported.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The property whose value is of type enum can be obtained by using this method.
+ */
result GetValue(MediaPropertyType key, int& value) const;
- /**
- * Gets the specified property value of this instance.
- *
- * @since 2.0
- *
- * @return An error code
-
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">key</a> whose value is required
- * @param[out] value The obtained property value
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG The specified @c key is not supported.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The property whose value is of type enum can be obtained using this method.
- */
+ /**
+ * Gets the specified property value of this instance.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">key</a> whose value is required
+ * @param[out] value The obtained property value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG The specified @c key is not supported.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The property whose value is of type enum can be obtained using this method.
+ */
result GetValue(MediaPropertyType key, float& value) const;
- /**
- * Gets the supported properties of this instance.
- *
- * @since 2.0
- *
- * @return A list of supported properties, @n
- * else @c null if no property is supported or if an exception occurs
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OBJ_NOT_FOUND This instance does not support any property.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted.
- */
+ /**
+ * Gets the supported properties of this instance.
+ *
+ * @since 2.0
+ *
+ * @return The list of supported properties, @n
+ * else @c null if no property is supported or an exception occurs
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OBJ_NOT_FOUND This instance does not support any property.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted.
+ */
Tizen::Base::Collection::IListT<MediaPropertyType>* GetSupportedPropertyListN(void) const;
- /**
- * Checks whether the specified property is supported.
- *
- * @since 2.0
- *
- * @return @c true if the property is supported, @n
- * else @c false
-
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">key</a> whose value is required
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ /**
+ * Checks whether the specified property is supported.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the property is supported, @n
+ * else @c false
+
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#decoding_video">key</a> whose value is required
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
bool IsPropertySupported(MediaPropertyType key) const;
- /**
- * Gets a list of the supported codecs.
- *
- * @since 2.0
- * @return A list of the codecs supported by the %VideoDecoder class, @n
- * else @c null if an exception occurs
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted by the caller.
- */
+ /**
+ * Gets the list of supported codecs.
+ *
+ * @since 2.0
+ * @return The list of the codecs supported by the %VideoDecoder class, @n
+ * else @c null if an exception occurs
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted by the caller.
+ */
static Tizen::Base::Collection::IListT<CodecType>* GetSupportedCodecListN(void);
/**
* @class VideoEncoder
- * @brief This class encodes a raw video stream into a compressed video data.
+ * @brief This class encodes a raw video stream into compressed video data.
*
* @since 2.0
*
- * The %VideoEncoder class encodes a raw video stream into a compressed video data. The video encoders such as H.263, MPEG4 Part 2 are supported.
+ * The %VideoEncoder class encodes a raw video stream into compressed video data. The video encoders such as H.263 and MPEG4 Part 2 are supported.
*
* For more information on the class features, see <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm">Encoding and Decoding Video</a>.
*
: public Tizen::Base::Object
{
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.
- *
- * @since 2.0
- *
- */
+ /**
+ * 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
+ *
+ */
VideoEncoder(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- */
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ */
virtual ~VideoEncoder(void);
- /**
- * Initializes an instance of %VideoEncoder with the specified parameters.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] type The codec type
-
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">optional parameters</a>
- * @exception E_SUCCESS The method is successful.
- * @exception E_UNSUPPORTED_CODEC The specified encoder is not supported.
- * @exception E_INVALID_ARG A specified input parameter has invalid data.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks
- * - The key type of the specified option is Tizen::Base::Integer and the value type varies depending
- * on the key type.
- * The unsupported keys in @c pOption are ignored.
- * If specified @c pOption has an invalid value, @c E_INVALID_ARG is returned.
- * - The supported codec types can vary depending on the device model or platform version.
- */
+ /**
+ * Initializes an instance of %VideoEncoder with the specified parameters.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] type The codec type
+
* @param[in] pOption The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">optional parameters</a>
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_UNSUPPORTED_CODEC The specified encoder is not supported.
+ * @exception E_INVALID_ARG A specified input parameter has invalid data.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The key type of the specified option is Tizen::Base::Integer and the value type varies depending
+ * on the key type.
+ * - The unsupported keys in @c pOption are ignored.
+ * If the specified @c pOption has an invalid value, @c E_INVALID_ARG is returned.
+ * - The supported codec types can vary depending on the device model or platform version.
+ */
result Construct(CodecType type, const Tizen::Base::Collection::HashMap* pOption = null);
public:
- /**
- * Encodes the video data from the source buffer and stores the encoded data in the destination buffer.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] srcBuf The source buffer that stores the raw video data
- * @param[out] dstBuf The destination buffer that stores the encoded video data
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified source or destination buffer is invalid or has insufficient memory.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks
- * - The destination buffer must have sufficient free space to store the encoded frame data.
- * - The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
- */
+ /**
+ * Encodes the video data from the source buffer and stores the encoded data in the destination buffer.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] srcBuf The source buffer that stores the raw video data
+ * @param[out] dstBuf The destination buffer that stores the encoded video data
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c srcBuf or @c dstBuf is either invalid or has insufficient memory.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks
+ * - The destination buffer must have sufficient free space to store the encoded frame data.
+ * - The position of the source buffer is moved to the end of the consumed data and the position of the destination buffer is moved to the end of the written data.
+ */
result Encode(Tizen::Base::ByteBuffer& srcBuf, Tizen::Base::ByteBuffer& dstBuf);
- /**
- * Resets the internal state of the video encoder to process a new video stream.
-
- * @since 2.0
- *
- * @return An error code
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks This method resets the properties that were set after the execution of the Construct() method.
- */
+ /**
+ * Resets the internal state of the video encoder to process a new video stream.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks This method resets the properties that were set after the execution of the Construct() method.
+ */
result Reset(void);
- /**
- * Sets the specified property value of this instance.
- *
- * @since 2.0
- *
- * @return An error code
-
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">key</a> value to set
- * @param[in] value The property value to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The media property that has the value of type enum can be set using this method.
- */
+ /**
+ * Sets the specified property value of this instance.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">key</a> value to set
+ * @param[in] value The property value to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The media property whose value is of type enum can be set using this method.
+ */
result SetValue(MediaPropertyType key, int value);
- /**
- * Sets the specified property value of this instance.
- *
- * @since 2.0
- *
- * @return An error code
-
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">key</a> value to set
- * @param[in] value The property value to set
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The media property that has the value of type enum can be set using this method.
- */
+ /**
+ * Sets the specified property value of this instance.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">key</a> value to set
+ * @param[in] value The property value to set
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The media property whose value is of type enum can be set using this method.
+ */
result SetValue(MediaPropertyType key, bool value);
- /**
- * Gets the properties supported by this instance.
- *
- * @since 2.0
- *
- * @return A list of the supported properties, @n
- * else @c null if no property is supported or if an exception occurs
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OBJ_NOT_FOUND This instance does not support any property.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- * The returned value must be deleted.
- */
+ /**
+ * Gets the properties supported by this instance.
+ *
+ * @since 2.0
+ *
+ * @return The list of supported properties, @n
+ * else @c null if no property is supported or an exception occurs
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OBJ_NOT_FOUND This instance does not support any property.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The returned value must be deleted.
+ */
Tizen::Base::Collection::IListT<MediaPropertyType>* GetSupportedPropertyListN(void) const;
- /**
- * Checks whether the specified property is supported.
- *
- * @since 2.0
- *
- * @return @c true if the property is supported, @n
- * else @c false
-
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">key</a> value
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
- * @exception E_SYSTEM A system error has occurred.
- * @remarks The specific error code can be accessed using the GetLastResult() method.
- */
+ /**
+ * Checks whether the specified property is supported.
+ *
+ * @since 2.0
+ *
+ * @return @c true if the property is supported, @n
+ * else @c false
+
* @param[in] key The <a href="../org.tizen.native.appprogramming/html/guide/media/encoding_decoding_video.htm#encoding_video">key</a> value
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The specified @c key is not found.
+ * @exception E_SYSTEM A system error has occurred.
+ * @remarks The specific error code can be accessed using the GetLastResult() method.
+ */
bool IsPropertySupported(MediaPropertyType key) const;
- /**
- * Gets a list of the supported codecs.
- *
- * @since 2.0
- *
- * @return A list of the codecs supported by the %VideoEncoder class, @n
- * else @c null if an exception occurs
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be deleted by the caller.
- */
+ /**
+ * Gets the list of supported codecs.
+ *
+ * @since 2.0
+ *
+ * @return The list of the codecs supported by the %VideoEncoder class, @n
+ * else @c null if an exception occurs
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be deleted by the caller.
+ */
static Tizen::Base::Collection::IListT<CodecType>* GetSupportedCodecListN(void);
private:
//
/**
- * @file FMediaVideoFrame.h
- * @brief This is the header file for the %VideoFrame class.
+ * @file FMediaVideoFrame.h
+ * @brief This is the header file for the %VideoFrame class.
*
* This header file contains the declarations of the %VideoFrame class.
*/
/**
* @class VideoFrame
- * @brief This class has the video frame data.
+ * @brief This class has video frame data.
*
* @final This class is not intended for extension.
*
* @since 2.1
*
- * The %VideoFrame class has the video frame data.
- * The frame has several plane components which represents each color of YUV. @n
+ * The %VideoFrame class has video frame data.
+ * The frame has several plane components which represent each color of YUV. @n
* This object is delivered to the application by IVideoStreamFilter::ProcessVideoStream() when the video is being streamed.
*
* The following example demonstrates how to use the %VideoFrame class.
* int width = frame.GetWidth();
* int height = frame.GetHeight();
*
+ * AppLog("frame plane count is %d", count);
+ * AppLog("frame plane width is %d and height is %d", width, height);
+ * AppLog("frame Pixel Format is %d", format);
+ *
* for (int i=0; i<count; i++)
* {
* switch(frame.GetPlaneType(i))
: public Tizen::Base::Object
{
public:
- /**
- *
- * Gets the plane count that the frame data has.
- *
- * @since 2.1
- *
- * @return The plane count
- *
- */
+ /**
+ * Gets the plane count of the frame data.
+ *
+ * @since 2.1
+ *
+ * @return The plane count
+ *
+ */
int GetPlaneCount(void) const;
- /**
- *
- * Gets the video plane type at a specified index from the frame.
- *
- * @since 2.1
- *
- * @return The video plane type, @n
- * else ::VIDEO_PLANE_TYPE_NONE if an error occurred
- * @param[in] index The index at which the value is read
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range.
- * @remarks
- * - The index should be less than the plane count.
- * - The specific error code can be accessed using the GetLastResult() method.
- *
- */
+ /**
+ * Gets the video plane type at the specified index from the frame.
+ *
+ * @since 2.1
+ *
+ * @return The video plane type, @n
+ * else ::VIDEO_PLANE_TYPE_NONE if an error occurs
+ * @param[in] index The index at which the value is read
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid range.
+ * @remarks
+ * - The index should be less than the plane count.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ *
+ */
VideoPlaneType GetPlaneType(int index) const;
- /**
- *
- * Gets the plane data at a specified index from the frame.
- *
- * @since 2.1
- *
- * @return The plane data, @n
- * else @c null if an error occurred
- * @param[in] index The index at which the value is read
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range.
- * @remarks
- * - The index should be less than the plane count.
- * - The buffer in ByteBuffer is shared with VideoFrame instance.
- * - The specific error code can be accessed using the GetLastResult() method.
- *
- */
+ /**
+ *
+ * Gets the plane data at the specified index from the frame.
+ *
+ * @since 2.1
+ *
+ * @return The plane data, @n
+ * else @c null if an error occurs
+ * @param[in] index The index at which the value is read
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid range.
+ * @remarks
+ * - The index should be less than the plane count.
+ * - The buffer in Tizen::Base::ByteBuffer is shared with the %VideoFrame instance.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ *
+ */
Tizen::Base::ByteBuffer* GetPlaneData(int index) const;
- /**
- *
- * Gets the bytes count per a line of a specified index plane.
- *
- * @since 2.1
- *
- * @return The number of bytes per a line of the plane, @n
- * else @c 0 if an error occurred
- * @param[in] index The index at which the value is read
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified index is out of range.
- * @remarks
- * - The index should be less than the plane count.
- * - The specific error code can be accessed using the GetLastResult() method.
- *
- */
+ /**
+ * Gets the byte count per line of the specified index plane.
+ *
+ * @since 2.1
+ *
+ * @return The number of bytes per line of the plane, @n
+ * else @c 0 if an error occurs
+ * @param[in] index The index at which the value is read
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c index is out of the valid range.
+ * @remarks
+ * - The index should be less than the plane count.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ *
+ */
int GetBytesCountPerLine(int index) const;
- /**
- *
- * Gets the width of the frame.
- *
- * @since 2.1
- *
- * @return The width of the frame
- *
- */
+ /**
+ * Gets the width of the frame.
+ *
+ * @since 2.1
+ *
+ * @return The width of the frame
+ *
+ */
int GetWidth(void) const;
- /**
- *
- * Gets the height of the frame.
- *
- * @since 2.1
- *
- * @return The height of the frame
- *
- */
+ /**
+ * Gets the height of the frame.
+ *
+ * @since 2.1
+ *
+ * @return The height of the frame
+ *
+ */
int GetHeight(void) const;
- /**
- *
- * Gets the pixel format of the frame.
- *
- * @since 2.1
- *
- * @return The pixel format of the frame
- *
- */
+ /**
+ * Gets the pixel format of the frame.
+ *
+ * @since 2.1
+ *
+ * @return The pixel format of the frame
+ *
+ */
MediaPixelFormat GetPixelFormat(void) const;
private:
/**
* @class VideoFrameExtractor
- * @brief This class is used to extract video frame from video file.
+ * @brief This class is used to extract a video frame from a video file.
*
* @since 2.0
*
- * The %VideoFrameExtractor class is used to extract video frame from video file.
+ * The %VideoFrameExtractor class is used to extract a video frame from a video file.
*
- * The following example demonstrates how to use the %VideoFrameExtractor class to extract video frame from video file.
+ * The following example demonstrates how to use the %VideoFrameExtractor class to extract a video frame from a video file.
*
* @code
* #include <FMedia.h>
*
* delete pImage;
* }
- * return E_SUCCESS;
+ * return r;
* }
* @endcode
*/
: public Tizen::Base::Object
{
public:
- /**
- * This is the default constructor for this class.
- *
- * @since 2.0
- *
- * @see Construct()
- */
+ /**
+ * This is the default constructor for this class.
+ *
+ * @since 2.0
+ *
+ * @see Construct()
+ */
VideoFrameExtractor(void);
- /**
- * This destructor overrides Tizen::Base::Object::~Object().
- *
- * @since 2.0
- *
- * @see Construct()
- */
+ /**
+ * This destructor overrides Tizen::Base::Object::~Object().
+ *
+ * @since 2.0
+ *
+ * @see Construct()
+ */
virtual ~VideoFrameExtractor(void);
- /**
- * Initializes this instance of %VideoFrameExtractor with the specified parameters.
- *
- * @since 2.0
- *
- * @return An error code
- * @param[in] filePath The video file path
- * @param[in] pixelFormat The pixel format of output image data.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
- * @remarks The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, and @c MEDIA_PIXEL_FORMAT_BGRA8888.
- */
+ /**
+ * Initializes this instance of %VideoFrameExtractor with the specified parameters.
+ *
+ * @since 2.0
+ *
+ * @return An error code
+ * @param[in] filePath The video file path
+ * @param[in] pixelFormat The pixel format of the output image data.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
+ * @remarks The supported pixel formats are @c MEDIA_PIXEL_FORMAT_RGB565LE, and @c MEDIA_PIXEL_FORMAT_BGRA8888.
+ */
result Construct(const Tizen::Base::String &filePath, MediaPixelFormat pixelFormat);
- /**
- * Gets the width of the video frame.
- *
- * @since 2.0
- *
- * @return The width of video frame
- */
+ /**
+ * Gets the width of the video frame.
+ *
+ * @since 2.0
+ *
+ * @return The width of the video frame
+ */
int GetWidth(void) const;
- /**
- * Gets the height of the video frame.
- *
- * @since 2.0
- *
- * @return The height of the video frame
- */
+ /**
+ * Gets the height of the video frame.
+ *
+ * @since 2.0
+ *
+ * @return The height of the video frame
+ */
int GetHeight(void) const;
- /**
- * Gets the duration of the video in millisecond.
- *
- * @since 2.0
- *
- * @return The duration of the video in millisecond
- */
+ /**
+ * Gets the duration of the video in milliseconds.
+ *
+ * @since 2.0
+ *
+ * @return The duration of the video in milliseconds
+ */
long GetDuration(void) const;
- /**
- * Extracts video frame at the specified position.
- *
- * @since 2.0
- *
- * @return A pointer to ImageBuffer containing the extracted video frame
- * @param[in] timestamp The timestamp of video frame to extract
- * @exception E_SUCCESS The method is successful.
- * @exception E_OUT_OF_RANGE The specified @c timestamp is out of range.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OPERATION_FAILED Video frame at given position is not found or extraction is failed.
- * @exception E_UNSUPPORTED_FORMAT The specified pixel format is not supported.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The extracted frame may not be exact frame of given timestamp,
- * so that the same frame can be returned even if the timestamp is different.
- * - Frames near the end of contents may not be extracted if no key-frame is found after timestamp.
- */
+ /**
+ * Extracts the video frame from the specified position.
+ *
+ * @since 2.0
+ *
+ * @return A pointer to ImageBuffer that contains the extracted video frame
+ * @param[in] timestamp The timestamp of the video frame to extract
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OUT_OF_RANGE The specified @c timestamp is out of the valid range.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OPERATION_FAILED Either of the following conditions has occurred:
+ * - The video frame at the specified position is not found.
+ * - The video frame extraction has failed.
+ * @exception E_UNSUPPORTED_FORMAT The specified pixel format is not supported.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The extracted frame may not be the exact frame of the given timestamp,
+ * so the same frame can be returned even if the timestamp is different.
+ * - Frames near the end of the content may not be extracted if no key-frame is found after the timestamp.
+ */
ImageBuffer* GetFrameN(long timestamp);
- /**
- * Extracts video thumbnail from the specified position.
- *
- * @since 2.0
- *
- * @return A pointer to ImageBuffer containing the extracted video frame
- * @param[in] path The video file path
- * @param[in] timestamp The timestamp of video frame that want to extract
- * @param[in] pixelFormat The pixel format of output image data.
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG A specified input parameter is invalid.
- * @exception E_OUT_OF_RANGE The specified @c timestamp is out of range.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_OPERATION_FAILED Video frame at given position is not found or extraction is failed.
- * @exception E_UNSUPPORTED_FORMAT The specified pixel format is not supported.
- * @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The extracted frame may not be exact frame of given timestamp,
- * so that the same frame can be returned even if the timestamp is different.
- * - Frames near the end of contents may not be extracted if no key-frame is found after timestamp.
- */
+ /**
+ * Extracts the video thumbnail from the specified position.
+ *
+ * @since 2.0
+ *
+ * @return A pointer to ImageBuffer that contains the extracted video frame
+ * @param[in] path The video file path
+ * @param[in] timestamp The timestamp of the video frame to extract
+ * @param[in] pixelFormat The pixel format of the output image data.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG A specified input parameter is invalid.
+ * @exception E_OUT_OF_RANGE The specified @c timestamp is out of the valid range.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OPERATION_FAILED Either of the following conditions has occurred:
+ * - The video frame at the specified position is not found.
+ * - The video frame extraction has failed.
+ * @exception E_UNSUPPORTED_FORMAT The specified pixel format is not supported.
+ * @remarks
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The extracted frame may not be the exact frame of the given timestamp,
+ * so the same frame can be returned even if the timestamp is different.
+ * - Frames near the end of the content may not be extracted if no key-frame is found after the timestamp.
+ */
static ImageBuffer* GetFrameN(const Tizen::Base::String& path, MediaPixelFormat pixelFormat, long timestamp);
- /**
+ /**
* Gets the current recording rotation of the video data.
*
- * @since 2.1
+ * @since 2.1
*
- * @return The recording rotation information of the current video data
+ * @return The recording rotation information of the current video data
*/
RecordingRotation GetRecordingRotation(void) const;
//
/**
- * @file FMediaVideoRecorder.h
- * @brief This is the header file for the %VideoRecorder class.
+ * @file FMediaVideoRecorder.h
+ * @brief This is the header file for the %VideoRecorder class.
*
* This header file contains the declarations of the %VideoRecorder class.
*/
*
* @since 2.0
*
- * The %VideoRecorder class provides video recording from the camera device. All the input sources must be
- * controlled independently from the video recording operation. The supported codecs and resolutions are
+ * The %VideoRecorder class provides video recording from a camera device. All the input sources must be
+ * controlled independently by the video recording operation. The supported codecs and resolutions are
* device-dependent and the available list can be retrieved using the methods available in this class.
* The recording operation is limited by the maximum time or size.
*
: public Tizen::Base::Object
{
public:
- /**
- * 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
- *
- */
+ /**
+ * 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
+ *
+ */
VideoRecorder(void);
- /**
- * This is the destructor for this class. @n
- * All allocated resources are deallocated by this method. This method must be called in the same thread in
- * which the Construct() method is called. @n This polymorphic destructor should be overridden if required. This way,
- * the destructors of the derived classes are called when the destructor of this interface is called.
- *
- * @since 2.0
- *
- */
+ /**
+ * This is the destructor for this class. @n
+ * All the allocated resources are deallocated by this method. This method must be called in the same thread as
+ * the Construct() method is called. @n
+ * This polymorphic destructor should be overridden if required. @n
+ * This way, the destructors of the derived classes are called when the destructor of this interface is called.
+ *
+ * @since 2.0
+ *
+ */
virtual ~VideoRecorder(void);
- /**
+ /**
* Initializes this instance of %VideoRecorder with an associated listener and an input source.
*
* @since 2.0
*
* @return An error code
- * @param[in] listener An event listener object
- * @param[in] camera A Camera object for the input source
- * @exception E_SUCCESS The method is successful.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_DEVICE_BUSY The recorder is under use by other application or already used in this application.
- * @exception E_UNSUPPORTED_OPERATION This video recorder usage is not supported.
+ * @param[in] listener The event listener object
+ * @param[in] camera The Camera object for the input source
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_DEVICE_BUSY Either of the following conditions has occurred:
+ * - The recorder is being used by another application.
+ * - The recorder is already used in this application.
+ * @exception E_UNSUPPORTED_OPERATION The usage of this video recorder is not supported.
*/
result Construct(IVideoRecorderEventListener& listener, const Camera& camera);
- /**
+ /**
* Creates a video file for a recording.
*
* @if OSPCOMPAT
- * @brief <i> [Compatibility] </i>
+ * @brief <i> [Compatibility] </i>
* @endif
- * @since 2.0
+ * @since 2.0
* @if OSPCOMPAT
- * @compatibility This method has compatibility issues with OSP compatible applications. @n
- * For more information, see @ref CompIoPathPage "here".
+ * @compatibility This method has compatibility issues with OSP compatible applications. @n
+ * For more information, see @ref CompIoPathPage "here".
* @endif
- * @privlevel public
- * @privilege %http://tizen.org/privilege/videorecorder
- *
- * @return An error code
- * @param[in] destMediaPath The destination for the file that is written @n
- * The available paths start with prefixes retrieved from the functions such as: @n
- * Tizen::App::App::GetInstance()->GetAppRootPath() @n
- * Tizen::System::Environment::GetMediaPath() @n
- * Tizen::System::Environment::GetExternalStoragePath()
- * @param[in] overwrite Set to @c true to overwrite the file, @n
- * else @c false
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_RESOURCE_UNAVAILABLE The required file path is unavailable.
- * @exception E_FILE_ALREADY_EXIST The specified file already exists.
- * @exception E_STORAGE_FULL The storage is full.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The application can register newly created files into the Contents database using Tizen::Content::ContentManager::CreateContent().
- * @see Close()
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/videorecorder
+ *
+ * @return An error code
+ * @param[in] destMediaPath The destination for the written file @n
+ * The available paths start with prefixes retrieved from the functions such as: @n
+ * Tizen::App::App::GetInstance()->GetAppRootPath() @n
+ * Tizen::System::Environment::GetMediaPath() @n
+ * Tizen::System::Environment::GetExternalStoragePath()
+ * @param[in] overwrite Set to @c true to overwrite the file, @n
+ * else @c false
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_RESOURCE_UNAVAILABLE The required file path is unavailable.
+ * @exception E_FILE_ALREADY_EXIST The specified file already exists.
+ * @exception E_STORAGE_FULL The storage is full.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @remarks The application can register newly created files into the Contents database using Tizen::Content::ContentManager::CreateContent().
+ * @see Close()
*/
result CreateVideoFile(const Tizen::Base::String& destMediaPath, bool overwrite);
- /**
+ /**
* Closes the video file. @n
* The %Close() method is a synchronous method.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
*/
result Close(void);
- /**
+ /**
* Records the video file. @n
- * Resumes the recording if Pause() has been called.
+ * Resumes the recording if Pause() is called.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @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.
* @exception E_SYSTEM A system error has occurred.
- * @exception E_DEVICE_BUSY The recorder is under use by other application.
+ * @exception E_DEVICE_BUSY The recorder is being used by another application.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks This method must be called after the input media source is started (for example, Camera::StartPreview()).
*/
result Record(void);
- /**
+ /**
* Stops the recording.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
*/
result Stop(void);
- /**
+ /**
* Pauses the recording. @n
* To resume the recording after the %Pause() method is called, Record() must be called.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
*/
result Pause(void);
- /**
+ /**
* Cancels the recording operation without saving the data.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - When this method is called, the state is changed to ::RECORDER_STATE_STOPPING.
- * - After IVideoRecorderEventListener::OnVideoRecorderCanceled() is called, the state is changed to
- * ::RECORDER_STATE_STOPPED.
+ * - When this method is called, the state is changed to ::RECORDER_STATE_STOPPING.
+ * - After IVideoRecorderEventListener::OnVideoRecorderCanceled() is called, the state is changed to
+ * ::RECORDER_STATE_STOPPED.
* @see Record()
* @see Stop()
*/
result Cancel(void);
- /**
+ /**
* Gets the state of a recorder.
*
* @since 2.0
* @see Record()
* @see Stop()
* @see Pause()
- * @see RecorderState
*/
RecorderState GetState(void) const;
- /**
+ /**
* Gets the current recording time.
*
* @since 2.0
*/
long GetRecordingTime(void) const;
- /**
+ /**
* Gets the current recording size.
*
* @since 2.0
*
- * @return A @c long value indicating the current recording size in bytes, @n
+ * @return The current recording size in bytes, @n
* else @c -1 if the recording has not started as yet
*/
long GetRecordingSize(void) const;
- /**
+ /**
* Sets the time limit for the recording in milliseconds.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* @param[in] msTime The maximum recording time in milliseconds @n
- * The time must be greater than @c 0.
+ * The time must be greater than @c 0. @n
+ * The default value is @c 60 seconds.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified time is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c msTime is out of the valid range.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks The default time is @c 60 seconds.
* @see GetMaxRecordingTime()
*/
result SetMaxRecordingTime(long msTime);
- /**
+ /**
* Gets the time limit of the recording in milliseconds.
*
* @since 2.0
*
- * @return A @c long value indicating the maximum recording time in milliseconds, @n
+ * @return The maximum recording time in milliseconds, @n
* else @c -1 if the recording has not started as yet
* @see SetMaxRecordingTime()
*/
* Sets the codec for the recorder. @n
* Initially, the default codec from the internal configuration is set.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container) method that
- * sets the audio/video codec and container together.
+ * Instead of using this method, use the SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container) method that
+ * sets the audio/video codec and container together.
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
- * @param[in] codec The codec name @n
- * It must be one of the strings listed by GetSupportedCodecListN(). @n
- * GetSupportedCodecListN() returns the list of strings in the following formats: @n
- * - "VIDEO_CODEC_H263" @n
- * - "VIDEO_CODEC_MPEG4SP" @n
- * The returned strings are different depending on each device. @n
- * The following string is always operated upon. This value is different
- * for each device. @n
- * "VIDEO_CODEC_DEFAULT": the default codec
- * @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_UNSUPPORTED_CODEC The specified codec is not supported.
- * @exception E_SYSTEM A system error has occurred.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @param[in] codec The codec name @n
+ * It must be one of the strings listed by GetSupportedCodecListN() @n
+ * %GetSupportedCodecListN() returns the list of strings in the following formats: @n
+ * - "VIDEO_CODEC_H263" @n
+ * - "VIDEO_CODEC_MPEG4SP" @n
+ * The returned strings are different depending on each device @n
+ * The following string is always operated upon @n
+ * This value is different for each device @n
+ * "VIDEO_CODEC_DEFAULT": the default codec.
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
+ * @exception E_UNSUPPORTED_CODEC The specified @c codec is not supported.
+ * @exception E_SYSTEM A system error has occurred.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see GetCodec()
* @endif
*/
result SetCodec(const Tizen::Base::String& codec);
- /**
+ /**
* @if OSPDEPREC
* Gets the codec for the recorder.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) const
- * method that gets the audio/video codec and container together.
+ * Instead of using this method, use the GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) constant
+ * method that gets the audio/video codec and container together.
* @since 2.0
*
* @return The current codec
*/
Tizen::Base::String GetCodec(void) const;
- /**
+ /**
* @if OSPDEPREC
* Gets the list of supported video recorder codecs. @n
* Each item in the list is a Tizen::Base::String value.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the GetSupportedAudioCodecListN() and GetSupportedVideoCodecListN() methods.
+ * Instead of using this method, use the GetSupportedAudioCodecListN() and GetSupportedVideoCodecListN() methods.
* @since 2.0
*
- * @return The list of strings that represents the supported video recorder codecs, @n
- * else @c null if no codec is supported or if an exception occurs
+ * @return The list of strings that represent the supported video recorder codecs, @n
+ * else @c null if no codec is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be released by the caller. @n
- * All items in the list must be released by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be released by the caller.
+ * - All the items in the list must be released by the caller.
* @see SetCodec()
* @see GetCodec()
* @endif
*/
Tizen::Base::Collection::IList* GetSupportedCodecListN(void) const;
- /**
+ /**
* Gets the list of supported audio codecs. @n
* Each item in the list has a ::CodecType value.
*
* @since 2.0
*
- * @return A list of supported audio codecs, @n
+ * @return The list of supported audio codecs, @n
* else @c null if no codec is supported or if an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
*/
Tizen::Base::Collection::IListT <CodecType>* GetSupportedAudioCodecListN(void) const;
- /**
+ /**
* Gets the list of supported video codecs. @n
* Each item in the list has a ::CodecType value.
*
* @since 2.0
*
- * @return A list of supported video codecs, @n
- * else @c null if no codec is supported or if an exception occurs
+ * @return The list of supported video codecs, @n
+ * else @c null if no codec is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be released by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be released by the caller.
* @see SetFormat( CodecType audioCodec, CodecType videoCodec, MediaContainerType container )
* @see GetFormat( CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container ) const
*/
Tizen::Base::Collection::IListT <CodecType>* GetSupportedVideoCodecListN(void) const;
- /**
+ /**
* Gets the list of supported containers. @n
* Each item in the list has a ::MediaContainerType value.
*
* @since 2.0
*
- * @return A list of supported containers, @n
- * else @c null if no container is supported or if an exception occurs
+ * @return The list of supported containers, @n
+ * else @c null if no container is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
- * - The specific error code can be accessed using the GetLastResult() method.
- * - The return value must be released by the caller.
+ * - The specific error code can be accessed using the GetLastResult() method.
+ * - The return value must be released by the caller.
* @see SetFormat( CodecType audioCodec, CodecType videoCodec, MediaContainerType container )
* @see GetFormat( CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container ) const
*/
Tizen::Base::Collection::IListT <MediaContainerType>* GetSupportedContainerListN(void) const;
- /**
+ /**
* @if OSPDEPREC
* Sets the video format of the recorder. @n
* Initially, the default format from internal configuration is set.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container) method that sets
- * the audio/video codec and container together.
+ * Instead of using this method, use the SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container) method that sets
+ * the audio/video codec and container together.
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* ::VIDEORECORDING_FORMAT_DEFAULT sets the system's default recording format.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_UNSUPPORTED_FORMAT The specified format is not supported.
+ * @exception E_UNSUPPORTED_FORMAT The specified @c format is not supported.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @see GetFormat()
*/
result SetFormat(VideoRecordingFormat format);
- /**
+ /**
* @if OSPDEPREC
* Gets the current format that has been set for the recorder.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) const method
- * that gets the audio/video codec and container together.
+ * Instead of using this method, use the GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) constant method
+ * that gets the audio/video codec and container together.
* @since 2.0
*
* @return The current video format, @n
*/
VideoRecordingFormat GetFormat(void) const;
- /**
+ /**
* @if OSPDEPREC
* Sets the mode of the recorder.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container) method that
- * determines whether the video recorder includes the audio codec.
+ * Instead of using this method, use the SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container) method that
+ * determines whether the video recorder includes the audio codec.
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
*/
result SetMode(VideoRecorderMode mode);
- /**
+ /**
* @if OSPDEPREC
* Gets the mode of the recorder.
*
- * @brief <i> [Deprecated] </i>
+ * @brief <i> [Deprecated] </i>
* @deprecated This method is deprecated. @n
- * Instead of using this method, use the GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) const
- * method that determines whether the video recorder includes the audio codec.
+ * Instead of using this method, use the GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) constant
+ * method that determines whether the video recorder includes the audio codec.
* @since 2.0
*
* @return The current mode
*/
VideoRecorderMode GetMode(void) const;
- /**
+ /**
* Sets the audio and video codecs, and the container of the recorder. @n
* Initially, the default codec and container format are set with the internal configuration.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @remarks
- * - If the audio codec is @c CODEC_NONE, the audio will be ignored, and only the video stream will be recorded.
+ * - If the audio codec is @c CODEC_NONE, the audio is ignored, and only the video stream is recorded.
* - If the specified container does not support the specified codec, @c E_UNSUPPORTED_FORMAT may be returned.
* @see GetFormat( CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container ) const
*/
result SetFormat(CodecType audioCodec, CodecType videoCodec, MediaContainerType container);
- /**
+ /**
* Gets the audio and video codecs, and the container of the recorder.
*
* @since 2.0
*/
result GetFormat(CodecType& audioCodec, CodecType& videoCodec, MediaContainerType& container) const;
- /**
+ /**
* Sets the quality of the recorder.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* @param[in] quality The quality of the recorder @n
- * The default quality is ::RECORDING_QUALITY_MEDIUM.
+ * The default quality is @c RECORDING_QUALITY_MEDIUM.
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The specified @c quality is not supported.
*/
result SetQuality(RecordingQuality quality);
- /**
+ /**
* Gets the quality of the recorder.
*
* @since 2.0
*/
RecordingQuality GetQuality(void) const;
- /**
+ /**
* Sets the recording resolution of the recorder. @n
* Initially, the default resolution from the internal configuration is set.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* GetSupportedRecordingResolutionListN().
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_STATE This instance is in an invalid state for this method.
- * @exception E_OUT_OF_RANGE The specified resolution is out of range.
+ * @exception E_OUT_OF_RANGE The specified @c resolution is out of the valid range.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result SetRecordingResolution(const Tizen::Graphics::Dimension& resolution);
- /**
+ /**
* Gets the recording resolution.
*
* @since 2.0
*/
Tizen::Graphics::Dimension GetRecordingResolution(void) const;
- /**
- * Gets a list of the supported video recorder resolutions. @n
+ /**
+ * Gets the list of supported video recorder resolutions. @n
* Each list item is a Tizen::Graphics::Dimension value.
*
* @since 2.0
*
- * @return A list of strings representing the supported video recorder resolutions, @n
- * else an empty list if no recording resolution is supported or if an exception occurs
+ * @return The list of strings that represent the supported video recorder resolutions, @n
+ * else an empty list if no recording resolution is supported or an exception occurs
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @remarks
* - The specific error code can be accessed using the GetLastResult() method.
* - The return value must be released by the calling method. @n
- * All items in the list must be released by the calling method.
+ * - All the items in the list must be released by the calling method.
* @see SetRecordingResolution()
* @see GetRecordingResolution()
*/
Tizen::Base::Collection::IList* GetSupportedRecordingResolutionListN(void) const;
- /**
+ /**
* Gets the maximum supported frame rate of the input resolution.
*
* @since 2.0
*/
int GetSupportedMaxFrameRate(const Tizen::Graphics::Dimension& dim) const;
- /**
+ /**
* Sets the mute state of a recorder.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
*/
result SetMute(bool mute);
- /**
+ /**
* Checks whether the mute state of the recorder is enabled.
*
* @since 2.0
*/
bool IsMuted(void) const;
- /**
+ /**
* Sets the recording rotation of the recorder.
*
* @since 2.0
- * @privlevel public
+ * @privlevel public
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
* @param[in] rotation The rotation of the recorder
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_STATE This method is invalid for the current state of this instance.
+ * @exception E_INVALID_STATE This instance is in an invalid state for this method.
* @exception E_INVALID_ARG The specified @c rotation is not supported.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks This method add the rotation information to the video file.
- * A video player can rotate the surface or the stream using this information to display correctly.
+ * @remarks
+ * - This method adds the rotation information to the video file.
+ * - A video player can rotate the surface or the stream using this information to display correctly.
* @see GetRecordingRotation()
*/
result SetRecordingRotation(RecordingRotation rotation);
- /**
+ /**
* Gets the rotation of the recorder.
*
* @since 2.0
*/
RecordingRotation GetRecordingRotation(void) const;
- /**
+ /**
* Adds a stream filter to process the audio stream data while recording.
*
* @since 2.1
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
- * @param[in] filter An instance of IAudioStreamFilter
- * @exception E_SUCCESS The method is successful.
+ * @param[in] filter An instance of IAudioStreamFilter
+ * @exception E_SUCCESS The method is successful.
* @exception E_OBJ_ALREADY_EXIST The filter already exists.
- * @exception E_OUT_OF_MEMORY The memory is insufficient.
+ * @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @remarks IAudioStreamFilter::ProcessAudioStream() is called when the audio frame is ready.
+ * @remarks IAudioStreamFilter::ProcessAudioStream() is called when the audio frame is ready.
*/
result AddAudioStreamFilter(IAudioStreamFilter& filter);
- /**
+ /**
* Removes a stream filter to stop processing the audio stream data.
*
* @since 2.1
* @privilege %http://tizen.org/privilege/videorecorder
*
* @return An error code
- * @param[in] filter An instance of IAudioStreamFilter
- * @exception E_SUCCESS The method is successful.
- * @exception E_OBJ_NOT_FOUND The filter is not found.
+ * @param[in] filter An instance of IAudioStreamFilter
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_OBJ_NOT_FOUND The filter is not found.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
*/
result RemoveAudioStreamFilter(IAudioStreamFilter& filter);
* Defines the mode of a video recorder.
*
* @brief <i> [Deprecated] </i>
- * @deprecated This enum is deprecated because new methods do not use this enum. For video only recording, instead of using this enum, use
+ * @deprecated This enum is deprecated because new methods do not use this enum. For only video recording, instead of using this enum, use
* ::CODEC_NONE.
* @since 2.0
*
//
/**
- * @file FMediaVideoStreamInfo.h
- * @brief This is the header file for the %VideoStreamInfo class.
+ * @file FMediaVideoStreamInfo.h
+ * @brief This is the header file for the %VideoStreamInfo class.
*
* This header file contains the declarations of the %VideoStreamInfo class.
*/
: public Tizen::Base::Object
{
public:
- /**
+ /**
* This destructor overrides Tizen::Base::Object::~Object().
*
* @since 2.0
virtual ~VideoStreamInfo(void);
public:
- /**
+ /**
* Gets the encoding type of a video.
*
* @since 2.0
*
- * @return The value of the encoding type
+ * @return The encoding type
*/
CodecType GetCodecType(void) const;
- /**
+ /**
* Gets the width of a video.
*
* @since 2.0
*
- * @return The value of the video width
+ * @return The video width
*/
int GetWidth(void) const;
- /**
+ /**
* Gets the height of a video.
*
* @since 2.0
*
- * @return The value of the video height
+ * @return The video height
*/
int GetHeight(void) const;
- /**
+ /**
* Gets the bit rate of a video.
*
* @since 2.0
*
- * @return The video bit rate in bits per second (bps)
+ * @return The video bit rate in bits per second (bps)
*/
int GetBitRate(void) const;
- /**
+ /**
* Gets the frame rate of a video.
*
* @since 2.0
*
- * @return The video frame rate
+ * @return The video frame rate
*/
float GetFrameRate(void) const;
- /**
+ /**
* Copying of objects using this copy constructor is allowed.
*
* @since 2.0
*
- * @return The copy of this instance
- * @param[in] rhs An instance of %VideoStreamInfo
+ * @return A copy of this instance
+ * @param[in] rhs An instance of %VideoStreamInfo to copy
*/
VideoStreamInfo(const VideoStreamInfo & rhs);
- /**
+ /**
* Copying of objects using this copy assignment operator is allowed.
*
* @since 2.0
*
- * @return The reference of this instance
- * @param[in] rhs An instance of %VideoStreamInfo
+ * @return A reference to this instance
+ * @param[in] rhs An instance of %VideoStreamInfo to copy
*/
VideoStreamInfo & operator =(const VideoStreamInfo & rhs);
- /**
- * Compares the specified instance of Tizen::Base::Object with the calling instance of %VideoStreamInfo.
+ /**
+ * Compares the specified instance of Tizen::Base::Object with the current instance of %VideoStreamInfo.
*
* @since 2.0
*
- * @return @c true if the value of the specified instance equals the value of the current instance, @n
- * else @c false
- * @param[in] rhs The object to compare with the current instance
+ * @return @c true if the value of the specified instance equals the value of the current instance, @n
+ * else @c false
+ * @param[in] rhs The object to compare with the current instance
*/
virtual bool Equals(const Tizen::Base::Object& rhs) const;
- /**
+ /**
* Gets the hash value of the current instance.
*
* @since 2.0
*
- * @return The hash value of the current instance
+ * @return The hash value of the current instance
*/
virtual int GetHashCode(void) const;
#include <FMediaAudioIn.h>
#include <FMediaAudioTypes.h>
#include <FBaseSysLog.h>
+#include <FSec_AccessController.h>
#include "FMedia_AudioInImpl.h"
+using namespace Tizen::Security;
namespace Tizen { namespace Media
{
SysAssertf(__pAudioInImpl != null, "Not yet constructed! Construct() should be called before use");
+ r = _AccessController::CheckUserPrivilege(_PRV_AUDIORECORDER);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, "[E_PRIVILEGE_DENIED]. This application does not have the privilege to call this method.");
+
r = __pAudioInImpl->Prepare(audioSampleType, audioChannelType, audioSampleRate);
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
return r;
SysAssertf(__pAudioInImpl != null, "Not yet constructed! Construct() should be called before use");
+ r = _AccessController::CheckUserPrivilege(_PRV_AUDIORECORDER);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, "[E_PRIVILEGE_DENIED]. This application does not have the privilege to call this method.");
+
r = __pAudioInImpl->Prepare(audioSampleType, audioChannelType, audioSampleRate);
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
return r;
SysAssertf(__pAudioInImpl != null, "Not yet constructed! Construct() should be called before use");
+ r = _AccessController::CheckUserPrivilege(_PRV_AUDIORECORDER);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, "[E_PRIVILEGE_DENIED]. This application does not have the privilege to call this method.");
+
r = __pAudioInImpl->Unprepare();
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
return r;
SysAssertf(__pAudioInImpl != null, "Not yet constructed! Construct() should be called before use");
+ r = _AccessController::CheckUserPrivilege(_PRV_AUDIORECORDER);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, "[E_PRIVILEGE_DENIED]. This application does not have the privilege to call this method.");
+
r = __pAudioInImpl->Start();
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
SysAssertf(__pAudioInImpl != null, "Not yet constructed! Construct() should be called before use");
+ r = _AccessController::CheckUserPrivilege(_PRV_AUDIORECORDER);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, "[E_PRIVILEGE_DENIED]. This application does not have the privilege to call this method.");
+
r = __pAudioInImpl->Stop();
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
return r;
SysAssertf(__pAudioInImpl != null, "Not yet constructed! Construct() should be called before use");
+ r = _AccessController::CheckUserPrivilege(_PRV_AUDIORECORDER);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, "[E_PRIVILEGE_DENIED]. This application does not have the privilege to call this method.");
+
r = __pAudioInImpl->Reset();
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
return r;
ByteBuffer* pBuffer = null;
int buffer_size = 0;
unsigned char* pData = NULL;
+ unsigned char* pDataBase = NULL;
result r = E_SUCCESS;
int ret = 0;
bool isSuccesful = true;
buffer_size = pBuffer->GetLimit();
pData = (unsigned char*) pBuffer->GetPointer();
SysTryCatch(NID_MEDIA, pData, r = E_INVALID_ARG, E_INVALID_ARG, "[E_INVALID_ARG] Invalid argument is used. The data to write is null");
+ pDataBase = pData;
index = 0;
while (!__stop && buffer_size)
{
}
else
{
- pData = pData + index;
+ pData = pDataBase + index;
ret = audio_out_write(__audioOutHandle, (void*) pData, feedSize);
}
if (ret != feedSize)
, __stateChangeReason(_RECORDER_STATE_REASON_NORMAL)
, __pAudioStreamCoordinator(null)
, __audioStreamTimeDuration(0)
- , __audioStreamCallback(false)
+ , __audioStreamFilterState(_AUDIO_STREAM_FILTER_OFF)
{
}
err = recorder_unset_error_cb(__handle);
err = recorder_unset_recording_status_cb(__handle);
err = recorder_unset_interrupted_cb(__handle);
+ if (__audioStreamFilterState != _AUDIO_STREAM_FILTER_OFF)
+ {
+ err = recorder_unset_audio_stream_cb(__handle);
+ }
__handle = MM_INVALID_HANDLE;
}
}
result
-_AudioRecorderImpl::AddAudioStreamFilter(IAudioStreamFilter& filter)
+_AudioRecorderImpl::ChangeAudioStreamFilterState(_AudioStreamFilterState nextState)
{
result r = E_SUCCESS;
+ int err = ::RECORDER_ERROR_NONE;
+ _AudioStreamFilterState currentState = __audioStreamFilterState;
- r = __pAudioStreamCoordinator->AddAudioStreamFilter(filter);
- SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
+ SysTryReturn(NID_MEDIA, nextState >= _AUDIO_STREAM_FILTER_OFF && nextState <= _AUDIO_STREAM_FILTER_PLAYING, E_INVALID_ARG, E_INVALID_ARG
+ , "[E_INVALID_ARG] Invalid argument(AudioStreamFilterState) is used. nextState=%d.", nextState);
- if (__audioStreamCallback != true)
+ if (currentState == nextState)
{
- int err = ::RECORDER_ERROR_NONE;
- err = recorder_set_audio_stream_cb(__handle, AudioStreamCb, this);
+ SysLog(NID_MEDIA, "Current state(%d) is same next state(%d).", __audioStreamFilterState, nextState);
+ return r;
+ }
+
+ switch (nextState)
+ {
+ case _AUDIO_STREAM_FILTER_OFF:
+ err = recorder_unset_audio_stream_cb(__handle);
r = ConvertResult(err);
- SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder set audio stream callback failed.", GetErrorMessage(r));
- __audioStreamCallback = true;
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder unset recording status callback failed.", GetErrorMessage(r));
+ break;
+
+ case _AUDIO_STREAM_FILTER_HIBERNATION:
+ //fall through
+ case _AUDIO_STREAM_FILTER_PLAYING:
+ if (currentState == _AUDIO_STREAM_FILTER_OFF)
+ {
+ err = recorder_set_audio_stream_cb(__handle, AudioStreamCb, this);
+ r = ConvertResult(err);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder set audio stream callback failed.", GetErrorMessage(r));
+ }
+ break;
}
+ SysLog(NID_MEDIA, "current state : %d, next state : %d", __audioStreamFilterState, nextState);
+ __audioStreamFilterState = nextState;
+
+ return r;
+}
+
+result
+_AudioRecorderImpl::AddAudioStreamFilter(IAudioStreamFilter& filter)
+{
+ result r = E_SUCCESS;
+ SysLog(NID_MEDIA, "audio recorder AddAudioStreamFilter");
+
+ r = __pAudioStreamCoordinator->AddAudioStreamFilter(filter);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
+
+ r = ChangeAudioStreamFilterState(_AUDIO_STREAM_FILTER_PLAYING);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder set audio stream callback failed.", GetErrorMessage(r));
+
return r;
}
_AudioRecorderImpl::RemoveAudioStreamFilter(IAudioStreamFilter& filter)
{
result r = E_SUCCESS;
+ SysLog(NID_MEDIA, "audio recorder RemoveAudioStreamFilter");
r = __pAudioStreamCoordinator->RemoveAudioStreamFilter(filter);
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
if (__pAudioStreamCoordinator->GetFilterListCount() == 0)
{
- int err = ::RECORDER_ERROR_NONE;
- err = recorder_unset_audio_stream_cb(__handle);
- r = ConvertResult(err);
- SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder unset recording status callback failed.", GetErrorMessage(r));
- __audioStreamCallback = false;
+ _AudioStreamFilterState state = (GetMmState() == ::RECORDER_STATE_RECORDING ? _AUDIO_STREAM_FILTER_HIBERNATION : _AUDIO_STREAM_FILTER_OFF);
+ r = ChangeAudioStreamFilterState(state);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] video recorder unset audio stream callback failed.", GetErrorMessage(r));
}
return r;
, E_INVALID_STATE, E_INVALID_STATE, "[E_INVALID_STATE] AudioRecorder is in an invalid state. AudioRecorder state is %d.",
state);
+ if (__audioStreamFilterState == _AUDIO_STREAM_FILTER_HIBERNATION)
+ {
+ r = ChangeAudioStreamFilterState(_AUDIO_STREAM_FILTER_OFF);
+ SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] video recorder unset audio stream callback failed.", GetErrorMessage(r));
+ }
+
mmState = GetMmState();
switch (mmState)
{
SysTryReturnVoidResult(NID_MEDIA, _CamRef::IsAlive(*pImpl), E_INVALID_OPERATION, "[E_INVALID_OPERATION] The object was already destroyed.");
SysTryReturnVoidResult(NID_MEDIA, pStream != null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] _AudioRecorderImpl instance is not available. Stream data is null.");
- if (pImpl->__audioStreamCallback == true)
+ if (pImpl->__audioStreamFilterState == _AUDIO_STREAM_FILTER_PLAYING)
{
samplingRate = _RecorderUtil::CalculateSampleRate(size, channel, pImpl->__audioStreamTimeDuration, _RecorderUtil::GetOspSampleType(format));
(pImpl->__pAudioStreamCoordinator)->ProcessAudioStreamData((byte*)pStream, size, samplingRate, _RecorderUtil::GetOspChannelType(channel), _RecorderUtil::GetOspSampleType(format));
*/
result ReloadConfiguration(int reload);
+ /**
+ * Changes the audio stream filter state.
+ *
+ * @return An error code
+ * @param[in] state nextState
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c state is not supported.
+ * @exception E_SYSTEM A system error has occurred.
+ */
+ result ChangeAudioStreamFilterState(_AudioStreamFilterState nextState);
+
_AudioRecorderImpl(const _AudioRecorderImpl&);
_AudioRecorderImpl& operator =(const _AudioRecorderImpl& _AudioRecorderImpl);
_RecorderStateChangeReason __stateChangeReason;
std::unique_ptr <_AudioStreamCoordinator> __pAudioStreamCoordinator;
int __audioStreamTimeDuration;
- bool __audioStreamCallback;
+ _AudioStreamFilterState __audioStreamFilterState;
};
}}// Tizen::Media
{
_CapabilityCopyMap* pInfo = (_CapabilityCopyMap*) &(_COPY_MAP[i]);
- if (pInfo == 0)
- {
- continue;
- }
+ //pInfo pointer cannot be null as the pointer is of static array
//check for valid key value and then get the corresponding value from the hash map
if (key.Equals(pInfo->pKey, true))
{
default:
break;
- }
+ }//switch
// Retrieve again.
pObj = __pMap->GetValue(key);
SysTryReturn(NID_MEDIA, pObj != null, E_OBJ_NOT_FOUND, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] Object instance is not available. Value is not found. key:%ls", key.GetPointer());
- }
+ }//ifcase-pObj
SysTryReturn(NID_MEDIA, pInfo->copy != null, E_SYSTEM, E_SYSTEM, "[E_SYSTEM] A system error has been occurred. Copy function is not found.");
r = (pInfo->copy)(type, pObj, value);
found = true;
break;
- }
+ }//if
}
SysTryCatch(NID_MEDIA, found, r = E_OBJ_NOT_FOUND, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] String instance is not available. key is not found. key:%ls", key.GetPointer());
return r;
r = MapExceptionToResult(err);
SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] error has been occurred. Failed to perform player_get_state operation with - 0x%x",GetErrorMessage(r), err);
SysTryCatch(NID_MEDIA, __corePlayerCurState == ::PLAYER_STATE_READY , , r = E_SYSTEM, "[E_SYSTEM] A system error has been occurred. wrong sync state is [%d]", __corePlayerCurState);
+
+ err = player_set_x11_display_visible(__hPlayer, 1);
+ r = MapExceptionToResult(err);
+ SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] error has been occurred. Failed to perform player_set_x11_display_visible operation with 0x%x", GetErrorMessage(r), err);
+
__currentState = PLAYER_STATE_OPENED;
}
else
"[E_INVALID_STATE] The device has moved to invalid state as it has run out of system resources : 0x%x", err);
r = MapExceptionToResult(err);
SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] error has been occured. Failed to perform player_prepare_async operation with 0x%x", GetErrorMessage(r), err);
+
+ err = player_set_x11_display_visible(__hPlayer, 1);
+ r = MapExceptionToResult(err);
+ SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] error has been occurred. Failed to perform player_set_x11_display_visible operation with 0x%x", GetErrorMessage(r), err);
}
if (__isStreamingContent)
r = MapExceptionToResult(ret);
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Failed to perform player_stop operation with - 0x%x", GetErrorMessage(r), ret);
+ if (__handleType == _BufferInfoImpl::HANDLE_TYPE_VE_SURFACE)
+ {
+ ret = player_set_x11_display_visible(__hPlayer, 1);
+ r = MapExceptionToResult(ret);
+ SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] error has been occurred. Failed to perform player_set_x11_display_visible operation with 0x%x", GetErrorMessage(r), ret);
+ }
+
ret = player_get_state(__hPlayer, &__corePlayerCurState);
r = MapExceptionToResult(ret);
SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] Failed to perform player_get_state operation with - 0x%x", GetErrorMessage(r), ret);
_PlayerImpl::HandlePlayerCompleted(void)
{
player_stop(__hPlayer);
+ if (__handleType == _BufferInfoImpl::HANDLE_TYPE_VE_SURFACE)
+ {
+ player_set_x11_display_visible(__hPlayer, 1);
+ }
__currentState = PLAYER_STATE_ENDOFCLIP;
SendEvent(_PLAYER_EVENT_ENDOFCLIP, 0);
}
"[E_SYSTEM] A system error has been occurred. Failed to perform player_get_codec_info operation with 0x%x", err);
pAudioList = new (std::nothrow) Tizen::Base::Collection::ArrayList();
- if (pAudioList && String::Compare(String(pAudioCodec),(String(L"unknown"))))
+ if (pAudioList && *pAudioCodec != '\0' && String::Compare(String(pAudioCodec),(String(L"unknown"))))
{
SysLog(NID_MEDIA, "Audio Codec is %s",pAudioCodec);
AudioChannelType channel = AUDIO_CHANNEL_TYPE_NONE;
}
pVideoList = new (std::nothrow) Tizen::Base::Collection::ArrayList();
- if (pVideoList && *pVideoCodec != '\0')
+ if (pVideoList && *pVideoCodec != '\0' && String::Compare(String(pVideoCodec),(String(L"unknown"))))
{
CodecType codec = CODEC_UNKNOWN;
int width = 0;
r = MapExceptionToResult(ret);
SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] Failed to perform player_set_sound_type operation with 0x%x", GetErrorMessage(r), ret);
- ret = player_set_audio_latency_mode(__hPlayer, ::AUDIO_LATENCY_MODE_HIGH);
- r = MapExceptionToResult(ret);
- SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] Failed to perform player_set_audio_latency_mode operation with 0x%x", GetErrorMessage(r), ret);
+ if (type == AUDIO_STREAM_TYPE_MEDIA)
+ {
+ ret = player_set_audio_latency_mode(__hPlayer, ::AUDIO_LATENCY_MODE_HIGH);
+ r = MapExceptionToResult(ret);
+ SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] Failed to perform player_set_audio_latency_mode operation with 0x%x", GetErrorMessage(r), ret);
+ }
return E_SUCCESS;
CATCH:
_RECORDER_STATE_REASON_ERROR,\r
};\r
+enum _AudioStreamFilterState\r
+{\r
+ _AUDIO_STREAM_FILTER_OFF, // cb func off, filter off\r
+ _AUDIO_STREAM_FILTER_HIBERNATION, //cb func on, filter off\r
+ _AUDIO_STREAM_FILTER_PLAYING, //cb func on, filter on\r
+};\r
+\r
}}
#endif
, __stateChangeReason(_RECORDER_STATE_REASON_NORMAL)
, __pAudioStreamCoordinator(null)
, __audioStreamTimeDuration(0)
- , __audioStreamCallback(false)
+ , __audioStreamFilterState(_AUDIO_STREAM_FILTER_OFF)
{
__recordingResolution.width = 0;
__recordingResolution.height = 0;
err = recorder_unset_error_cb(__handle);
err = recorder_unset_recording_status_cb(__handle);
err = recorder_unset_interrupted_cb(__handle);
+ if (__audioStreamFilterState != _AUDIO_STREAM_FILTER_OFF)
+ {
+ err = recorder_unset_audio_stream_cb(__handle);
+ }
__handle = MM_INVALID_HANDLE;
}
if (__pCoordinator != null)
}
result
-_VideoRecorderImpl::AddAudioStreamFilter(IAudioStreamFilter& filter)
+_VideoRecorderImpl::ChangeAudioStreamFilterState(_AudioStreamFilterState nextState)
{
result r = E_SUCCESS;
+ int err = ::RECORDER_ERROR_NONE;
+ _AudioStreamFilterState currentState = __audioStreamFilterState;
- r = __pAudioStreamCoordinator->AddAudioStreamFilter(filter);
- SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
+ SysTryReturn(NID_MEDIA, nextState >= _AUDIO_STREAM_FILTER_OFF && nextState <= _AUDIO_STREAM_FILTER_PLAYING, E_INVALID_ARG, E_INVALID_ARG
+ , "[E_INVALID_ARG] Invalid argument(AudioStreamFilterState) is used. nextState=%d.", nextState);
- if (__audioStreamCallback != true)
+ if (currentState == nextState)
{
- int err = ::RECORDER_ERROR_NONE;
- err = recorder_set_audio_stream_cb(__handle, AudioStreamCb, this);
+ SysLog(NID_MEDIA, "Current state(%d) is same next state(%d).", __audioStreamFilterState, nextState);
+ return r;
+ }
+
+ switch (nextState)
+ {
+ case _AUDIO_STREAM_FILTER_OFF:
+ err = recorder_unset_audio_stream_cb(__handle);
r = ConvertResult(err);
- SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder set audio stream callback failed.", GetErrorMessage(r));
- __audioStreamCallback = true;
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] video recorder unset recording status callback failed.", GetErrorMessage(r));
+ break;
+
+ case _AUDIO_STREAM_FILTER_HIBERNATION:
+ //fall through
+ case _AUDIO_STREAM_FILTER_PLAYING:
+ if (currentState == _AUDIO_STREAM_FILTER_OFF)
+ {
+ err = recorder_set_audio_stream_cb(__handle, AudioStreamCb, this);
+ r = ConvertResult(err);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] video recorder set audio stream callback failed.", GetErrorMessage(r));
+ }
+ break;
}
+ SysLog(NID_MEDIA, "current state : %d, next state : %d", __audioStreamFilterState, nextState);
+ __audioStreamFilterState = nextState;
+
+ return r;
+}
+
+result
+_VideoRecorderImpl::AddAudioStreamFilter(IAudioStreamFilter& filter)
+{
+ result r = E_SUCCESS;
+ SysLog(NID_MEDIA, "video recorder AddAudioStreamFilter");
+
+ r = __pAudioStreamCoordinator->AddAudioStreamFilter(filter);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
+
+ r = ChangeAudioStreamFilterState(_AUDIO_STREAM_FILTER_PLAYING);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] video recorder set audio stream callback failed.", GetErrorMessage(r));
+
return r;
}
_VideoRecorderImpl::RemoveAudioStreamFilter(IAudioStreamFilter& filter)
{
result r = E_SUCCESS;
+ SysLog(NID_MEDIA, "video recorder RemoveAudioStreamFilter");
r = __pAudioStreamCoordinator->RemoveAudioStreamFilter(filter);
SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r));
if (__pAudioStreamCoordinator->GetFilterListCount() == 0)
{
- int err = ::RECORDER_ERROR_NONE;
- err = recorder_unset_audio_stream_cb(__handle);
- r = ConvertResult(err);
- SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] audio recorder unset recording status callback failed.", GetErrorMessage(r));
- __audioStreamCallback = false;
+ _AudioStreamFilterState state = (GetMmState() == ::RECORDER_STATE_RECORDING ? _AUDIO_STREAM_FILTER_HIBERNATION : _AUDIO_STREAM_FILTER_OFF);
+ r = ChangeAudioStreamFilterState(state);
+ SysTryReturn(NID_MEDIA, r == E_SUCCESS, r, r, "[%s] video recorder unset audio stream callback failed.", GetErrorMessage(r));
}
return r;
SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] Propagating", GetErrorMessage(r));
}
+ if (__audioStreamFilterState == _AUDIO_STREAM_FILTER_HIBERNATION)
+ {
+ r = ChangeAudioStreamFilterState(_AUDIO_STREAM_FILTER_OFF);
+ SysTryCatch(NID_MEDIA, r == E_SUCCESS, , r, "[%s] video recorder unset audio stream callback failed.", GetErrorMessage(r));
+ }
+
mmState = GetMmState();
switch (mmState)
{
SysTryReturnVoidResult(NID_MEDIA, _CamRef::IsAlive(*pImpl), E_INVALID_OPERATION, "[E_INVALID_OPERATION] The object was already destroyed.");
SysTryReturnVoidResult(NID_MEDIA, pStream != null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] void instance is not available. pStream is null.");
- if (pImpl->__audioStreamCallback == true)
+ if (pImpl->__audioStreamFilterState == _AUDIO_STREAM_FILTER_PLAYING)
{
samplingRate = _RecorderUtil::CalculateSampleRate(size, channel, pImpl->__audioStreamTimeDuration, _RecorderUtil::GetOspSampleType(format));
(pImpl->__pAudioStreamCoordinator)->ProcessAudioStreamData((byte*)pStream, size, samplingRate, _RecorderUtil::GetOspChannelType(channel), _RecorderUtil::GetOspSampleType(format));
*/
result SetCallback(void);
+ /**
+ * Changes the audio stream filter state.
+ *
+ * @return An error code
+ * @param[in] state nextState
+ * @exception E_SUCCESS The method is successful.
+ * @exception E_INVALID_ARG The specified @c state is not supported.
+ * @exception E_SYSTEM A system error has occurred.
+ */
+ result ChangeAudioStreamFilterState(_AudioStreamFilterState nextState);
+
_VideoRecorderImpl(const _VideoRecorderImpl& _VideoRecorderImpl);
_VideoRecorderImpl& operator =(const _VideoRecorderImpl& _VideoRecorderImpl);
_RecorderStateChangeReason __stateChangeReason;
std::unique_ptr <_AudioStreamCoordinator> __pAudioStreamCoordinator;
int __audioStreamTimeDuration;
- bool __audioStreamCallback;
+ _AudioStreamFilterState __audioStreamFilterState;
};
SysTryCatch(NID_MEDIA, __offset != __maxOffsetLength, r = E_END_OF_FILE, E_END_OF_FILE,
"[%s] Reached End of File",GetErrorMessage(E_END_OF_FILE));
- while (ogg_sync_pageout(&__state, &page) != 1)
+ while ( (res = ogg_sync_pageout(&__state, &page)) != 1)
{
+
+ SysTryCatch(NID_MEDIA, !(res == 0 && __offset >= __maxOffsetLength), r = E_UNSUPPORTED_FORMAT, E_UNSUPPORTED_FORMAT,
+ "[%s] Not supported ",GetErrorMessage(E_UNSUPPORTED_FORMAT));
+
pBuffer = ogg_sync_buffer(&__state, PAGE_SIZE);
SysTryCatch(NID_MEDIA, pBuffer != null, r = E_OUT_OF_MEMORY, E_OUT_OF_MEMORY,
"[%s] Memory Allocation Failed ",GetErrorMessage(E_OUT_OF_MEMORY));
else
{
memcpy(pBuffer, __pBuf + __offset, __maxOffsetLength - __offset );
+ ogg_sync_wrote(&__state, __maxOffsetLength - __offset);
__offset = __maxOffsetLength;
- ogg_sync_wrote(&__state, PAGE_SIZE);
- res = ogg_sync_pageout(&__state, &page);
- SysTryCatch(NID_MEDIA, res == 1, r = E_UNSUPPORTED_FORMAT, E_UNSUPPORTED_FORMAT,
- "[%s] The input data format is not supported or Reached End of File ",GetErrorMessage(E_UNSUPPORTED_FORMAT));
}
}
SysTryCatch(NID_MEDIA, ( srcBuf != null && srcBufSize >= 0), r = E_INVALID_STATE, E_INVALID_STATE,
"[%s] The instance is in invalid state",GetErrorMessage(E_INVALID_STATE));
+ SysTryCatch(NID_MEDIA, dstBufSize >= DEFAULT_BUFFER_SIZE,
+ r = E_OUT_OF_MEMORY, E_OUT_OF_MEMORY,
+ "[%s] Failed to get a packet", GetErrorMessage(E_SYSTEM));
+
__pBuf = (byte*) srcBuf;
__maxOffsetLength = srcBufSize;
__offset = 0;
SysTryCatch(NID_MEDIA, (__isConstructed == true), r = E_INVALID_STATE, E_INVALID_STATE,
"[%s] The instance is in invalid state",GetErrorMessage(E_INVALID_STATE));
- res = vorbis_synthesis_restart(&__vorbisState);
+ vorbis_block_clear(&__vorbisBlock);
+ vorbis_dsp_clear(&__vorbisState);
+ vorbis_comment_clear(&__vorbisComment);
+ vorbis_info_clear(&__vorbisInfo);
+
+ // call to avoid memory leak
+ ogg_sync_clear(&__state);
+
+ vorbis_info_init(&__vorbisInfo);
+ vorbis_comment_init(&__vorbisComment);
+
+
__isHeaderDecoded = false;
SysTryCatch(NID_MEDIA, res == E_SUCCESS, r = E_INVALID_STATE, E_INVALID_STATE,
"[%s] The instance is in invalid state",GetErrorMessage(E_INVALID_STATE));
private:
static const int PAGE_SIZE = 4096;
- static const int DEFAULT_BUFFER_SIZE = 8192 * 2;
+ static const int DEFAULT_BUFFER_SIZE = 8192;
static const int HEADER_COUNT = 3;
vorbis_dsp_state __vorbisState;
projects / platform / framework / native / media.git / commitdiff