[Recorder] Update descriptions to fix ths grammer errors. 07/148207/3
authorHaesu Gwon <haesu.gwon@samsung.com>
Thu, 7 Sep 2017 06:15:07 +0000 (15:15 +0900)
committerHaesu Gwon <haesu.gwon@samsung.com>
Fri, 8 Sep 2017 06:09:41 +0000 (15:09 +0900)
- Reviewed by Lionbridge.

Change-Id: I7a07f7335c07a68d94bab933ff3a98e0f5834757
Signed-off-by: Haesu Gwon <haesu.gwon@samsung.com>
src/Tizen.Multimedia.Recorder/Recorder/Recorder.Events.cs [changed mode: 0644->0755]
src/Tizen.Multimedia.Recorder/Recorder/Recorder.Settings.cs [changed mode: 0644->0755]
src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs
src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs
src/Tizen.Multimedia.Recorder/Recorder/VideoRecorder.cs [changed mode: 0644->0755]

old mode 100644 (file)
new mode 100755 (executable)
index e28f85f..31d6447
@@ -23,7 +23,7 @@ namespace Tizen.Multimedia
     public partial class Recorder
     {
         /// <summary>
-        /// Occurs when an error occurs during recorder operation.
+        /// Occurs when an error occurs during the recorder operation.
         /// </summary>
         public event EventHandler<RecordingErrorOccurredEventArgs> ErrorOccurred;
         private Native.RecorderErrorCallback _errorOccurredCallback;
@@ -35,20 +35,20 @@ namespace Tizen.Multimedia
         private Native.InterruptedCallback _interruptedCallback;
 
         /// <summary>
-        /// This event occurs when recorder state is changed.
+        /// This event occurs when the recorder state is changed.
         /// </summary>
         public event EventHandler<RecorderStateChangedEventArgs> StateChanged;
         private Native.StatechangedCallback _stateChangedCallback;
 
         /// <summary>
-        /// Occurs when recording information changes.
+        /// Occurs when the recording information changes.
         /// </summary>
         public event EventHandler<RecordingStatusChangedEventArgs> RecordingStatusChanged;
         private Native.RecordingProgressCallback _recordingProgressCallback;
 
         //TODO need to test dispose while event handler is running.
         /// <summary>
-        /// Occurs when audio stream data is being delivered.
+        /// Occurs when the audio stream data is being delivered.
         /// </summary>
         /// <remarks>
         /// Do not call <see cref="Commit"/> and <see cref="Cancel"/> in this event.
@@ -60,13 +60,13 @@ namespace Tizen.Multimedia
         /// Occurs when recording limit is reached.
         /// </summary>
         /// <remarks>
-        /// After this event is raised, recording data is discarded and not written in the recording file.
+        /// After this event is raised, the recording data is discarded and not written in the recording file.
         /// </remarks>
         public event EventHandler<RecordingLimitReachedEventArgs> RecordingLimitReached;
         private Native.RecordingLimitReachedCallback _recordingLimitReachedCallback;
 
         /// <summary>
-        /// Occurs when muxed stream data is being delivered.
+        /// Occurs when the muxed stream data is being delivered.
         /// </summary>
         public event EventHandler<MuxedStreamDeliveredEventArgs> MuxedStreamDelivered;
         private Native.MuxedStreamCallback _muxedStreamCallback;
old mode 100644 (file)
new mode 100755 (executable)
index f2d28a9..59ba378
@@ -68,14 +68,14 @@ 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>
@@ -107,9 +107,9 @@ 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>
@@ -136,7 +136,7 @@ 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>
@@ -170,7 +170,7 @@ 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>
@@ -207,9 +207,9 @@ 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
+        /// be discarded and will not be written to the file.\n
         /// \n
-        /// 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 zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
@@ -248,9 +248,9 @@ 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
+        /// be discarded and will not be written to the file.\n
         /// \n
-        /// 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 zero.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
index 6f5303b..24807ce 100755 (executable)
@@ -120,7 +120,7 @@ namespace Tizen.Multimedia
         /// <summary>
         /// Gets the current state of the recorder.
         /// </summary>
-        /// <value>A <see cref="RecorderState"/> that specifies the state of recorder.</value>
+        /// <value>A <see cref="RecorderState"/> that specifies the state of the recorder.</value>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
         public RecorderState State
         {
@@ -135,7 +135,7 @@ namespace Tizen.Multimedia
 
         #region Methods
         /// <summary>
-        /// Prepare the media recorder for recording.
+        /// Prepares the media recorder for recording.
         /// </summary>
         /// <remarks>
         /// The recorder should be in the <see cref="RecorderState.Idle"/> state.\n
@@ -175,7 +175,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <remarks>
         /// The recorder should be in the <see cref="RecorderState.Ready"/> state.
-        /// The state of recorder will be <see cref="RecorderState.Idle"/> after this.
+        /// The state of recorder will be the <see cref="RecorderState.Idle"/> after this.
         /// It has no effect if the current state is the <see cref="RecorderState.Idle"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
@@ -205,14 +205,14 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <remarks>
         /// The recorder must be in the <see cref="RecorderState.Ready"/> state.
-        /// The state of recorder will be <see cref="RecorderState.Recording"/> after this. \n
+        /// The state of the recorder will be the <see cref="RecorderState.Recording"/> after this. \n
         /// \n
         /// If the specified path exists, the file is removed automatically and updated by new one.\n
         /// The mediastorage privilege(http://tizen.org/privilege/mediastorage) is required if the path is relevant to media storage.\n
         /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) is required if the path is relevant to external storage.\n
         /// \n
         /// In the video recorder, some preview format does not support record mode.
-        ///    You should use default preview format or <see cref="CameraPixelFormat.Nv12"/> in the record mode.
+        ///    You should use the default preview format or the <see cref="CameraPixelFormat.Nv12"/> in the record mode.
         /// </remarks>
         /// <param name="savePath">The file path for recording result.</param>
         /// <privilege>http://tizen.org/privilege/recorder</privilege>
@@ -255,7 +255,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <remarks>
         /// The recorder should be in the <see cref="RecorderState.Paused"/> state.
-        /// The state of recorder will be <see cref="RecorderState.Recording"/> after this.
+        /// The state of recorder will be the <see cref="RecorderState.Recording"/> after this.
         /// It has no effect if the current state is the <see cref="RecorderState.Recording"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
@@ -279,11 +279,11 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Pause the recording.
+        /// Pauses the recording.
         /// </summary>
         /// <remarks>
         /// The recorder should be in the <see cref="RecorderState.Recording"/> state.
-        /// The state of recorder will be <see cref="RecorderState.Paused"/> after this.
+        /// The state of the recorder will be the <see cref="RecorderState.Paused"/> after this.
         /// It has no effect if the current state is the <see cref="RecorderState.Paused"/>.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
@@ -310,8 +310,8 @@ namespace Tizen.Multimedia
         /// Stops recording and saves the result.
         /// </summary>
         /// <remarks>
-        /// The recorder must be in the <see cref="RecorderState.Recording"/> or <see cref="RecorderState.Paused"/> state.
-        /// The state of recorder will be <see cref="RecorderState.Ready"/> after the operation.
+        /// The recorder must be in the <see cref="RecorderState.Recording"/> or the <see cref="RecorderState.Paused"/> state.
+        /// The state of the recorder will be the <see cref="RecorderState.Ready"/> after the operation.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
         ///     The recorder is not in the valid state.\n
@@ -337,8 +337,8 @@ namespace Tizen.Multimedia
         /// The recording data is discarded and not written in the recording file.
         /// </summary>
         /// <remarks>
-        /// The recorder must be in the <see cref="RecorderState.Recording"/> or <see cref="RecorderState.Paused"/> state.
-        /// The state of recorder will be <see cref="RecorderState.Ready"/> after the operation.
+        /// The recorder must be in the <see cref="RecorderState.Recording"/> or the <see cref="RecorderState.Paused"/> state.
+        /// The state of the recorder will be the <see cref="RecorderState.Ready"/> after the operation.
         /// </remarks>
         /// <exception cref="InvalidOperationException">
         ///     The recorder is not in the valid state.\n
@@ -363,7 +363,7 @@ namespace Tizen.Multimedia
         /// Apply the audio stream policy.
         /// </summary>
         /// <remarks>
-        /// The recorder must be in the <see cref="RecorderState.Idle"/> or <see cref="RecorderState.Ready"/> state.
+        /// The recorder must be in the <see cref="RecorderState.Idle"/> or the <see cref="RecorderState.Ready"/> state.
         /// </remarks>
         /// <param name="policy">The policy to apply.</param>
         /// <exception cref="ArgumentNullException"><paramref name="policy"/> is null.</exception>
@@ -395,9 +395,9 @@ namespace Tizen.Multimedia
         /// Returns the peak audio input level in dB since the last call to this method.
         /// </summary>
         /// <remarks>
-        /// 0dB indicates maximum input level, -300dB indicates minimum input level.\n
+        /// 0dB indicates the maximum input level, -300dB indicates the minimum input level.\n
         /// \n
-        /// The recorder must be in the <see cref="RecorderState.Recording"/> or <see cref="RecorderState.Paused"/> state.
+        /// The recorder must be in the <see cref="RecorderState.Recording"/> or the <see cref="RecorderState.Paused"/> state.
         /// </remarks>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
         public double GetPeakAudioLevel()
index 3639d20..8d93891 100755 (executable)
@@ -54,11 +54,11 @@ namespace Tizen.Multimedia
     public enum RecorderAudioDevice
     {
         /// <summary>
-        /// Capture audio from Mic device.
+        /// Capture audio from the Mic device.
         /// </summary>
         Mic,
         /// <summary>
-        /// Capture audio from modem.
+        /// Capture audio from the modem.
         /// </summary>
         Modem
     }
@@ -126,15 +126,15 @@ namespace Tizen.Multimedia
     public enum RecordingLimitType
     {
         /// <summary>
-        /// Time limit in seconds of recording file
+        /// Time limit in seconds of the recording file
         /// </summary>
         Time,
         /// <summary>
-        /// Size limit in KB(KiloBytes) of recording file.
+        /// Size limit in KB(KiloBytes) of the recording file.
         /// </summary>
         Size,
         /// <summary>
-        /// No free space in storage.
+        /// No free space in the storage.
         /// </summary>
         Space
     }
@@ -149,16 +149,16 @@ namespace Tizen.Multimedia
         /// </summary>
         Idle = 1,
         /// <summary>
-        /// Recorder is ready to record. In case of video recorder,
+        /// Recorder is ready to record. In case of video recorder,
         /// preview display will be shown.
         /// </summary>
         Ready,
         /// <summary>
-        /// Recorder is recording media.
+        /// Recorder is recording the media.
         /// </summary>
         Recording,
         /// <summary>
-        /// Recorder is paused while recording media.
+        /// Recorder is paused while recording the media.
         /// </summary>
         Paused
     }
old mode 100644 (file)
new mode 100755 (executable)
index 78bec71..fa8821a
@@ -229,10 +229,10 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <remarks>
         /// The attribute is valid only in a video recorder.\n
-        /// If the rate is in range of 0-1, video is recorded in a slow motion mode.\n
-        /// If the rate is bigger than 1, video is recorded in a fast motion mode.\n
+        /// If the rate is in range of 0-1, the video is recorded in a slow motion mode.\n
+        /// If the rate is bigger than 1, the video is recorded in a fast motion mode.\n
         /// \n
-        /// 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">The <paramref name="value"/> is less than or equal to 0.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
@@ -262,7 +262,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets or sets the orientation in a video metadata tag.
+        /// Gets or sets the orientation in the video metadata tag.
         /// </summary>
         /// <value>A <see cref="Rotation"/> that specifies the type of orientation.</value>
         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
@@ -289,11 +289,9 @@ namespace Tizen.Multimedia
         /// Gets or sets the resolution of the video 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>
-        /// <exception cref="ArgumentOutOfRangeException">
-        ///    Width or height of <paramref name="value"/> is less than or equal to zero.
-        /// </exception>
+        /// <exception cref="ArgumentOutOfRangeException">Width or height of <paramref name="value"/> is less than or equal to zero.</exception>
         /// <exception cref="NotSupportedException"><paramref name="value"> is not supported.</exception>
         /// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
         /// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
@@ -330,7 +328,7 @@ namespace Tizen.Multimedia
         }
 
         /// <summary>
-        /// Gets or sets the bitrate of an video encoder in bits per second.
+        /// Gets or sets the bitrate of the video 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.