- Reviewed by Lionbridge.
Change-Id: I7a07f7335c07a68d94bab933ff3a98e0f5834757
Signed-off-by: Haesu Gwon <haesu.gwon@samsung.com>
public partial class Recorder
{
/// <summary>
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;
/// </summary>
public event EventHandler<RecordingErrorOccurredEventArgs> ErrorOccurred;
private Native.RecorderErrorCallback _errorOccurredCallback;
private Native.InterruptedCallback _interruptedCallback;
/// <summary>
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>
/// </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>
/// </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.
/// </summary>
/// <remarks>
/// Do not call <see cref="Commit"/> and <see cref="Cancel"/> in this event.
/// Occurs when recording limit is reached.
/// </summary>
/// <remarks>
/// 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>
/// </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;
/// </summary>
public event EventHandler<MuxedStreamDeliveredEventArgs> MuxedStreamDelivered;
private Native.MuxedStreamCallback _muxedStreamCallback;
- /// Gets or sets the number of audio channel.
+ /// Gets or sets the number of the audio channel.
/// </summary>
/// <remarks>
/// </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>
/// </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>
/// </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>
/// Gets or sets the audio device for recording.
/// </summary>
/// <remarks>
/// 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.
- /// <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>
/// <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>
/// Gets or sets the sampling rate of an audio stream in hertz.
/// </summary>
/// <remarks>
/// 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>
/// </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>
/// Gets or sets the bitrate of an audio encoder in bits per second.
/// </summary>
/// <remarks>
/// 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>
/// </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>
/// </value>
/// <remarks>
/// After reaching the limitation, the data which is being recorded will
/// </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
- /// 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>
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
/// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
/// </value>
/// <remarks>
/// After reaching the limitation, the data which is being recorded will
/// </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
- /// 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>
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
/// <exception cref="InvalidOperationException">The recorder is not in the valid state.</exception>
/// <summary>
/// Gets the current state of the recorder.
/// </summary>
/// <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
{
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
public RecorderState State
{
#region Methods
/// <summary>
#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
/// </summary>
/// <remarks>
/// The recorder should be in the <see cref="RecorderState.Idle"/> state.\n
/// </summary>
/// <remarks>
/// The recorder should be in the <see cref="RecorderState.Ready"/> state.
/// </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">
/// It has no effect if the current state is the <see cref="RecorderState.Idle"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
/// </summary>
/// <remarks>
/// The recorder must be in the <see cref="RecorderState.Ready"/> state.
/// </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.
/// \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>
/// </remarks>
/// <param name="savePath">The file path for recording result.</param>
/// <privilege>http://tizen.org/privilege/recorder</privilege>
/// </summary>
/// <remarks>
/// The recorder should be in the <see cref="RecorderState.Paused"/> state.
/// </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">
/// It has no effect if the current state is the <see cref="RecorderState.Recording"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// Pause the recording.
+ /// Pauses the recording.
/// </summary>
/// <remarks>
/// The recorder should be in the <see cref="RecorderState.Recording"/> state.
/// </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">
/// It has no effect if the current state is the <see cref="RecorderState.Paused"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
/// Stops recording and saves the result.
/// </summary>
/// <remarks>
/// 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
/// </remarks>
/// <exception cref="InvalidOperationException">
/// The recorder is not in the valid state.\n
/// The recording data is discarded and not written in the recording file.
/// </summary>
/// <remarks>
/// 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
/// </remarks>
/// <exception cref="InvalidOperationException">
/// The recorder is not in the valid state.\n
/// Apply the audio stream policy.
/// </summary>
/// <remarks>
/// 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>
/// </remarks>
/// <param name="policy">The policy to apply.</param>
/// <exception cref="ArgumentNullException"><paramref name="policy"/> is null.</exception>
/// Returns the peak audio input level in dB since the last call to this method.
/// </summary>
/// <remarks>
/// 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
- /// 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()
/// </remarks>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
public double GetPeakAudioLevel()
public enum RecorderAudioDevice
{
/// <summary>
public enum RecorderAudioDevice
{
/// <summary>
- /// Capture audio from Mic device.
+ /// Capture audio from the Mic device.
/// </summary>
Mic,
/// <summary>
/// </summary>
Mic,
/// <summary>
- /// Capture audio from modem.
+ /// Capture audio from the modem.
public enum RecordingLimitType
{
/// <summary>
public enum RecordingLimitType
{
/// <summary>
- /// Time limit in seconds of recording file
+ /// Time limit in seconds of the recording file
/// </summary>
Time,
/// <summary>
/// </summary>
Time,
/// <summary>
- /// Size limit in KB(KiloBytes) of recording file.
+ /// Size limit in KB(KiloBytes) of the recording file.
/// </summary>
Size,
/// <summary>
/// </summary>
Size,
/// <summary>
- /// No free space in storage.
+ /// No free space in the storage.
/// </summary>
Idle = 1,
/// <summary>
/// </summary>
Idle = 1,
/// <summary>
- /// Recorder is ready to record. In case of video recorder,
+ /// Recorder is ready to record. In case of a video recorder,
/// preview display will be shown.
/// </summary>
Ready,
/// <summary>
/// preview display will be shown.
/// </summary>
Ready,
/// <summary>
- /// Recorder is recording media.
+ /// Recorder is recording the media.
/// </summary>
Recording,
/// <summary>
/// </summary>
Recording,
/// <summary>
- /// Recorder is paused while recording media.
+ /// Recorder is paused while recording the media.
/// </summary>
/// <remarks>
/// The attribute is valid only in a video recorder.\n
/// </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
- /// 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>
/// </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>
- /// 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>
/// </summary>
/// <value>A <see cref="Rotation"/> that specifies the type of orientation.</value>
/// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
/// Gets or sets the resolution of the video recording.
/// </summary>
/// <remarks>
/// 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.
- /// <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>
/// <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>
- /// 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.
/// </summary>
/// <remarks>
/// To set, the recorder must be in the <see cref="RecorderState.Idle"/> or <see cref="RecorderState.Ready"/> state.