Setting since_tizen 3/4 on Tizen.NET API

[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.Recorder / Recorder / Recorder.Settings.cs

diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs
old mode 100644 (file)
new mode 100755 (executable)
index f2d28a9..4c9da41
--- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs
+++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs
@@ -28,6 +28,7 @@ namespace Tizen.Multimedia
         /// Gets the audio codec for encoding an audio stream.
         /// </summary>
         /// <seealso cref="GetSupportedAudioCodecs"/>
+        /// <since_tizen> 4 </since_tizen>
         public RecorderAudioCodec AudioCodec
         {
             get => _audioCodec;
@@ -52,6 +53,7 @@ namespace Tizen.Multimedia
         /// Gets the file format of the recording result.
         /// </summary>
         /// <seealso cref="GetSupportedFileFormats"/>
+        /// <since_tizen> 4 </since_tizen>
         public RecorderFileFormat FileFormat
         {
             get => _fileFormat;
@@ -68,18 +70,19 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets or sets the number of audio channel.
+        /// Gets or sets the number of the audio channel.
         /// </summary>
         /// <remarks>
-        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or <see cref="RecorderState.Ready"/> state.
+        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref="RecorderState.Ready"/> state.
         /// </remarks>
         /// <value>
-        /// For mono recording, set channel to 1.
-        /// For stereo recording, set channel to 2.
+        /// For mono recording, set the channel to 1.
+        /// For stereo recording, set the channel to 2.
         /// </value>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public int AudioChannels
         {
             get
@@ -107,12 +110,13 @@ namespace Tizen.Multimedia
         /// Gets or sets the audio device for recording.
         /// </summary>
         /// <remarks>
-        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or <see cref="RecorderState.Ready"/> state.
+        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref="RecorderState.Ready"/> state.
         /// </remarks>
-        /// <value>A <see cref="RecorderAudioDevice"/> that specifies the type of audio device.</value>
+        /// <value>A <see cref="RecorderAudioDevice"/> that specifies the type of the audio device.</value>
         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public RecorderAudioDevice AudioDevice
         {
             get
@@ -136,11 +140,12 @@ namespace Tizen.Multimedia
         /// Gets or sets the sampling rate of an audio stream in hertz.
         /// </summary>
         /// <remarks>
-        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or <see cref="RecorderState.Ready"/> state.
+        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref="RecorderState.Ready"/> state.
         /// </remarks>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public int AudioSampleRate
         {
             get
@@ -170,11 +175,12 @@ namespace Tizen.Multimedia
         /// Gets or sets the bitrate of an audio encoder in bits per second.
         /// </summary>
         /// <remarks>
-        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or <see cref="RecorderState.Ready"/> state.
+        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref="RecorderState.Ready"/> state.
         /// </remarks>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public int AudioBitRate
         {
             get
@@ -207,13 +213,14 @@ namespace Tizen.Multimedia
         /// </value>
         /// <remarks>
         /// After reaching the limitation, the data which is being recorded will
-        /// be discarded and not written to the file.\n
-        /// \n
-        /// To set, the recorder must be in the<see cref="RecorderState.Idle"/> or <see cref= "RecorderState.Ready" /> state.
+        /// be discarded and will not be written to the file.<br/>
+        /// <br/>
+        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref= "RecorderState.Ready" /> state.
         /// </remarks>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public int SizeLimit
         {
             get
@@ -248,13 +255,14 @@ namespace Tizen.Multimedia
         /// </value>
         /// <remarks>
         /// After reaching the limitation, the data which is being recorded will
-        /// be discarded and not written to the file.\n
-        /// \n
-        /// To set, the recorder must be in the<see cref="RecorderState.Idle"/> or <see cref= "RecorderState.Ready" /> state.
+        /// be discarded and will not be written to the file.<br/>
+        /// <br/>
+        /// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref= "RecorderState.Ready" /> state.
         /// </remarks>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public int TimeLimit
         {
             get
@@ -283,6 +291,7 @@ namespace Tizen.Multimedia
         /// Gets or sets the mute state of a recorder.
         /// </summary>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
+        /// <since_tizen> 4 </since_tizen>
         public bool Muted
         {
             get => Native.GetMute(Handle);