/// Prepares the AudioCapture for reading audio data by starting buffering of audio data from the device.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// Operation failed due to an internal error.\n
- /// -or-\n
+ /// Operation failed due to an internal error.<br/>
+ /// -or-<br/>
/// The current state is not <see cref="AudioIOState.Idle"/>.
/// </exception>
/// <seealso cref="Unprepare"/>
/// Unprepares the AudioCapture.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// Operation failed due to an internal error.\n
- /// -or-\n
+ /// Operation failed due to an internal error.<br/>
+ /// -or-<br/>
/// The current state is <see cref="AudioIOState.Idle"/>.
/// </exception>
/// <seealso cref="Prepare"/>
/// Pauses buffering of audio data from the device.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// The current state is <see cref="AudioIOState.Idle"/>.\n
- /// -or-\n
+ /// The current state is <see cref="AudioIOState.Idle"/>.<br/>
+ /// -or-<br/>
/// The method is called in the <see cref="AsyncAudioCapture.DataAvailable"/> event handler.
/// </exception>
/// <seealso cref="Resume"/>
/// Resumes buffering audio data from the device.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// The current state is <see cref="AudioIOState.Idle"/>.\n
- /// -or-\n
+ /// The current state is <see cref="AudioIOState.Idle"/>.<br/>
+ /// -or-<br/>
/// The method is called in the <see cref="AsyncAudioCapture.DataAvailable"/> event handler.
/// </exception>
/// <seealso cref="Pause"/>
/// <param name="channel">The audio channel type.</param>
/// <param name="sampleType">The audio sample type.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="sampleRate"/> is less than <see cref="AudioCaptureBase.MinSampleRate"/>.\n
- /// -or-\n
+ /// <paramref name="sampleRate"/> is less than <see cref="AudioCaptureBase.MinSampleRate"/>.<br/>
+ /// -or-<br/>
/// <paramref name="sampleRate"/> is greater than <see cref="AudioCaptureBase.MaxSampleRate"/>.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="channel"/> is invalid.\n
- /// -or-\n
+ /// <paramref name="channel"/> is invalid.<br/>
+ /// -or-<br/>
/// <paramref name="sampleType"/> is invalid.
/// </exception>
/// <exception cref="InvalidOperationException">The required privilege is not specified.</exception>
/// <param name="channel">The audio channel type.</param>
/// <param name="sampleType">The audio sample type.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="sampleRate"/> is less than <see cref="AudioCaptureBase.MinSampleRate"/>.\n
- /// -or-\n
+ /// <paramref name="sampleRate"/> is less than <see cref="AudioCaptureBase.MinSampleRate"/>.<br/>
+ /// -or-<br/>
/// <paramref name="sampleRate"/> is greater than <see cref="AudioCaptureBase.MaxSampleRate"/>.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="channel"/> is invalid.\n
- /// -or-\n
+ /// <paramref name="channel"/> is invalid.<br/>
+ /// -or-<br/>
/// <paramref name="sampleType"/> is invalid.
/// </exception>
/// <exception cref="InvalidOperationException">The required privilege is not specified.</exception>
/// <param name="channel">The audio channel type.</param>
/// <param name="sampleType">The audio sample type.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="sampleRate"/> is less than <see cref="MinSampleRate"/>.\n
- /// -or-\n
+ /// <paramref name="sampleRate"/> is less than <see cref="MinSampleRate"/>.<br/>
+ /// -or-<br/>
/// <paramref name="sampleRate"/> is greater than <see cref="MaxSampleRate"/>.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="channel"/> is invalid.\n
- /// -or-\n
+ /// <paramref name="channel"/> is invalid.<br/>
+ /// -or-<br/>
/// <paramref name="sampleType"/> is invalid.
/// </exception>
public AudioPlayback(int sampleRate, AudioChannel channel, AudioSampleType sampleType)
/// This must be called before <see cref="Write(byte[])"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// Operation failed due to an internal error.\n
- /// -or-\n
+ /// Operation failed due to an internal error.<br/>
+ /// -or-<br/>
/// The current state is not <see cref="AudioIOState.Idle"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The AudioPlayback has already been disposed of.</exception>
/// Unprepares the AudioPlayback.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// Operation failed due to an internal error.\n
- /// -or-\n
+ /// Operation failed due to an internal error.<br/>
+ /// -or-<br/>
/// The current state is <see cref="AudioIOState.Idle"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The AudioPlayback has already been disposed of.</exception>
/// </summary>
/// <remarks>It has no effect if the current state is <see cref="AudioIOState.Paused"/>.</remarks>
/// <exception cref="InvalidOperationException">
- /// The current state is <see cref="AudioIOState.Idle"/>.\n
- /// -or-\n
+ /// The current state is <see cref="AudioIOState.Idle"/>.<br/>
+ /// -or-<br/>
/// The method is called in the <see cref="BufferAvailable"/> event handler.
/// </exception>
/// <exception cref="ObjectDisposedException">The AudioPlayback has already been disposed of.</exception>
/// </summary>
/// <remarks>It has no effect if the current state is <see cref="AudioIOState.Running"/>.</remarks>
/// <exception cref="InvalidOperationException">
- /// The current state is <see cref="AudioIOState.Idle"/>.\n
- /// -or-\n
+ /// The current state is <see cref="AudioIOState.Idle"/>.<br/>
+ /// -or-<br/>
/// The method is called in an event handler.
/// </exception>
/// <exception cref="ObjectDisposedException">The AudioPlayback has already been disposed of.</exception>
/// <param name="streamPolicy">The <see cref="AudioStreamPolicy"/> to apply for the AudioPlayback.</param>
/// <exception cref="ArgumentNullException"><paramref name="streamPolicy"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="streamPolicy"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="streamPolicy"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// The AudioPlayback has already been disposed of.
/// </exception>
/// <exception cref="NotSupportedException"><paramref name="streamPolicy"/> is not supported.</exception>
/// Prepares the MediaCodec for encoding or decoding.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// The codec is not configured yet.\n
- /// -or-\n
+ /// The codec is not configured yet.<br/>
+ /// -or-<br/>
/// Internal error.
/// </exception>
public void Prepare()
/// <param name="codecType">The value indicating whether the codec uses hardware acceleration.</param>
/// <exception cref="ArgumentNullException"><paramref name="format"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="codecType"/> is invalid.\n
- /// -or-\n
+ /// <paramref name="codecType"/> is invalid.<br/>
+ /// -or-<br/>
/// <paramref name="format"/> is neither audio type nor video type.
/// </exception>
/// <exception cref="NotSupportedException">The mime type of the format is not supported.</exception>
/// <param name="index">The index of the band to get.</param>
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> has already been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <pramref name="index"/> is less than zero.\n
- /// -or-\n
+ /// <pramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="index"/> is equal to or greater than <see cref="Count"/>.
/// </exception>
public EqualizerBand this[int index]
/// </summary>
/// <param name="length">The value indicating the size of the buffer.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="length"/> is zero.\n
- /// -or-\n
+ /// <paramref name="length"/> is zero.<br/>
+ /// -or-<br/>
/// <paramref name="length"/> is less than zero.
/// </exception>
public MediaBufferSource(int length)
/// <param name="offset">The value indicating the offset in the buffer of the first byte to copy.</param>
/// <exception cref="ArgumentNullException"><paramref name="buffer"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="offset"/> is less than zero.\n
- /// -or-\n
- /// <paramref name="length"/> is equal to or less than zero.\n
- /// -or-\n
+ /// <paramref name="offset"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="length"/> is equal to or less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="offset"/>+<paramref name="length"/> is greater than buffer.Length.
/// </exception>
public MediaBufferSource(byte[] buffer, int length, int offset = 0)
/// <summary>
/// Gets the offset.
/// </summary>
- public ulong Offset { get; }
+ public ulong Offset { get; }
/// <summary>
/// Returns a string that represents the current object.
/// <remarks>AAC and H.264 are supported.</remarks>
/// <exception cref="ArgumentNullException">Both <paramref name="audioMediaFormat"/> and <paramref name="videoMediaFormat"/> are null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="audioMediaFormat"/> is not supported.\n
- /// -or-\n
- /// <paramref name="videoMediaFormat"/> is not supported.\n
+ /// <paramref name="audioMediaFormat"/> is not supported.<br/>
+ /// -or-<br/>
+ /// <paramref name="videoMediaFormat"/> is not supported.
/// </exception>
/// <seealso cref="SupportedAudioTypes"/>
/// <seealso cref="SupportedVideoTypes"/>
/// <see cref="PlayerState.Playing"/>, or <see cref="PlayerState.Paused"/> state.</remarks>
/// <param name="packet">The <see cref="MediaPacket"/> to decode.</param>
/// <exception cref="InvalidOperationException">
- /// This source is not set as a source to a player.\n
- /// -or-\n
+ /// This source is not set as a source to a player.<br/>
+ /// -or-<br/>
/// The player is not in the valid state.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="packet"/> is null.</exception>
/// <exception cref="ObjectDisposedException"><paramref name="packet"/> has been disposed of.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="packet"/> is neither video nor audio type.\n
- /// -or-\n
+ /// <paramref name="packet"/> is neither video nor audio type.<br/>
+ /// -or-<br/>
/// The format of packet is not matched with the specified format in the constructor.
/// </exception>
/// <exception cref="NoBufferSpaceException">The internal buffer has reached its limits.</exception>
/// <remarks>Valid volume range is from 0 to 1.0, inclusive.</remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="value"/> is greater than 1.0.
/// </exception>
public float Volume
/// <returns>The <see cref="DownloadProgress"/> containing current download progress.</returns>
/// <remarks>The player must be in the <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
/// <exception cref="InvalidOperationException">
- /// The player is not streaming.\n
- /// -or-\n
+ /// The player is not streaming.<br/>
+ /// -or-<br/>
/// The player is not in the valid state.
/// </exception>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <remarks>The player must be in the <see cref="PlayerState.Playing"/> or <see cref="PlayerState.Paused"/> state.</remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="InvalidOperationException">
- /// The player is not in the valid state.\n
- /// -or-\n
+ /// The player is not in the valid state.<br/>
+ /// -or-<br/>
/// No subtitle is set.
/// </exception>
/// <seealso cref="SetSubtitle(string)"/>
/// </summary>
/// <remarks>
/// The player must be in the <see cref="PlayerState.Ready"/> or <see cref="PlayerState.Paused"/> state.
- /// It has no effect if the player is already in the <see cref="PlayerState.Playing"/> state.\n
- /// \n
+ /// It has no effect if the player is already in the <see cref="PlayerState.Playing"/> state.<br/>
+ /// <br/>
/// Sound can be mixed with other sounds if you don't control the stream focus using <see cref="ApplyAudioStreamPolicy"/>.
/// </remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <remarks>The player must be in the <see cref="PlayerState.Idle"/> state.</remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="InvalidOperationException">
- /// The player is not in the valid state.\n
- /// -or-\n
+ /// The player is not in the valid state.<br/>
+ /// -or-<br/>
/// It is not able to assign the source to the player.
/// </exception>
/// <seealso cref="PrepareAsync"/>
/// </remarks>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="InvalidOperationException">
- /// The player is not in the valid state.\n
- /// -or-\n
+ /// The player is not in the valid state.<br/>
+ /// -or-<br/>
/// Streaming playback.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="rate"/> is less than 5.0.\n
- /// -or-\n
- /// <paramref name="rate"/> is greater than 5.0.\n
- /// -or-\n
+ /// <paramref name="rate"/> is less than 5.0.<br/>
+ /// -or-<br/>
+ /// <paramref name="rate"/> is greater than 5.0.<br/>
+ /// -or-<br/>
/// <paramref name="rate"/> is zero.
/// </exception>
public void SetPlaybackRate(float rate)
/// </summary>
/// <param name="policy">The <see cref="AudioStreamPolicy"/> to apply.</param>
/// <remarks>
- /// The player must be in the <see cref="PlayerState.Idle"/> state.\n
- /// \n
- /// <see cref="Player"/> does not support all <see cref="AudioStreamType"/>.\n
+ /// The player must be in the <see cref="PlayerState.Idle"/> state.<br/>
+ /// <br/>
+ /// <see cref="Player"/> does not support all <see cref="AudioStreamType"/>.<br/>
/// Supported types are <see cref="AudioStreamType.Media"/>, <see cref="AudioStreamType.System"/>,
/// <see cref="AudioStreamType.Alarm"/>, <see cref="AudioStreamType.Notification"/>,
/// <see cref="AudioStreamType.Emergency"/>, <see cref="AudioStreamType.VoiceInformation"/>,
/// <see cref="AudioStreamType.RingtoneVoip"/> and <see cref="AudioStreamType.MediaExternalOnly"/>.
/// </remarks>
/// <exception cref="ObjectDisposedException">
- /// The player has already been disposed of.\n
- /// -or-\n
+ /// The player has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="policy"/> has already been disposed of.
/// </exception>
/// <exception cref="InvalidOperationException">The player is not in the valid state.</exception>
/// To set roi, <see cref="Mode"/> must be set to <see cref="PlayerDisplayMode.Roi"/> first.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// Operation failed; internal error.\n
- /// -or-\n
+ /// Operation failed; internal error.<br/>
+ /// -or-<br/>
/// <see cref="Mode"/> is not set to <see cref="PlayerDisplayMode.Roi"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The player has already been disposed of.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> that this instance belongs to has been disposed of.</exception>
/// <exception cref="InvalidOperationException">The <see cref="Player"/> that this instance belongs to is not in the valid state.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="index"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="index"/> is equal to or greater than <see cref="GetCount()"/>
/// </exception>
public string GetLanguageCode(int index)
/// <exception cref="ObjectDisposedException">The <see cref="Player"/> that this instance belongs to has been disposed of.</exception>
/// <exception cref="InvalidOperationException">The <see cref="Player"/> that this instance belongs to is not in the valid state.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="value"/> is equal to or greater than <see cref="GetCount()"/>
/// </exception>
public int Selected
/// </summary>
/// <privilege>
/// If you want to access only an internal storage,
- /// you should add privilege http://tizen.org/privilege/mediastorage. \n
+ /// you should add privilege http://tizen.org/privilege/mediastorage.<br/>
/// Or if you want to access only an external storage,
- /// you should add privilege http://tizen.org/privilege/externalstorage. \n
+ /// you should add privilege http://tizen.org/privilege/externalstorage.
/// </privilege>
public class MetadataEditor : IDisposable
{
/// Writes the modified metadata to the media file.
/// </summary>
/// <exception cref="InvalidOperationException">
- /// An internal error occurs.\n
- /// -or-\n
+ /// An internal error occurs.<br/>
+ /// -or-<br/>
/// The file is read-only.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
/// <returns>The artwork included in the media file.</returns>
/// <exception cref="InvalidOperationException">An internal error occurs.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="index"/> is less than zero.\n
- /// -or-\n
- /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.\n
+ /// <paramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
public Artwork GetPicture(int index)
/// <since_tizen> 3 </since_tizen>
/// <param name="path">The path of the picture for adding to the metadata.</param>
/// <exception cref="InvalidOperationException">
- /// An internal error occurs.\n
- /// -or-\n
+ /// An internal error occurs.<br/>
+ /// -or-<br/>
/// The media file is read-only.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null</exception>
/// <since_tizen> 3 </since_tizen>
/// <param name="index">The index of the picture to remove.</param>
/// <exception cref="InvalidOperationException">
- /// An internal error occurs.\n
- /// -or-\n
+ /// An internal error occurs.<br/>
+ /// -or-<br/>
/// The media file is read-only.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="index"/> is less than zero.\n
- /// -or-\n
- /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.\n
+ /// <paramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="index"/> is greater than or equal to <see cref="PictureCount"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MetadataEditor"/> has already been disposed of.</exception>
public void RemovePicture(int index)
/// Gets or sets the radio frequency in the range of 87500 ~ 108000 kHz.
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than <see cref="Range.Min"/> of <see cref="FrequencyRange"/>.\n
- /// - or - \n
- /// <paramref name="value"/> is greater than <see cref="Range.Max"/> of <see cref="FrequencyRange"/>.\n
+ /// <paramref name="value"/> is less than <see cref="Range.Min"/> of <see cref="FrequencyRange"/>.<br/>
+ /// - or - <br/>
+ /// <paramref name="value"/> is greater than <see cref="Range.Max"/> of <see cref="FrequencyRange"/>.
/// </exception>
public int Frequency
{
/// <remarks>Valid volume range is from 0 to 1.0(100%), inclusive.</remarks>
/// <value>The default is 1.0.</value>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// - or -\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// - or -<br/>
/// <paramref name="value"/> is greater than 1.0.
/// </exception>
public float Volume
/// </returns>
/// <remarks>The radio must be in the <see cref="RadioState.Playing"/> state.</remarks>
/// <exception cref="InvalidOperationException">
- /// The radio is not in the valid state.\n
- /// -or-\n
+ /// The radio is not in the valid state.<br/>
+ /// -or-<br/>
/// Seeking is in progress.
/// </exception>
public Task<int> SeekUpAsync()
/// </returns>
/// <remarks>The radio must be in the <see cref="RadioState.Playing"/> state.</remarks>
/// <exception cref="InvalidOperationException">
- /// The radio is not in the valid state.\n
- /// -or-\n
+ /// The radio is not in the valid state.<br/>
+ /// -or-<br/>
/// Seeking is in progress.
/// </exception>
public Task<int> SeekDownAsync()
/// <feature>http://tizen.org/feature/microphone</feature>
/// <exception cref="InvalidOperationException">An internal error occurred.</exception>
/// <exception cref="NotSupportedException">
- /// A required feature is not supported.\n
- /// -or-\n
- /// <paramref name="audioCodec"/> is not supported.\n
- /// -or-\n
+ /// A required feature is not supported.<br/>
+ /// -or-<br/>
+ /// <paramref name="audioCodec"/> is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified audio codec.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="audioCodec"/> is not valid.\n
- /// -or-\n
+ /// <paramref name="audioCodec"/> is not valid.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not valid.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// <param name="audioCodec">The codec for audio encoding.</param>
/// <param name="fileFormat">The format of result file.</param>
/// <exception cref="NotSupportedException">
- /// <paramref name="audioCodec"/> is not supported.\n
- /// -or-\n
+ /// <paramref name="audioCodec"/> is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified audio codec.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="audioCodec"/> is not valid.\n
- /// -or-\n
+ /// <paramref name="audioCodec"/> is not valid.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not valid.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// Gets the audio stream buffer.
/// </summary>
/// <remarks>
- /// If the stream is modified in the event handler, the modified data will be stored.
- /// \n
- /// The buffer is only valid in the event.\n
+ /// If the stream is modified in the event handler, the modified data will be stored.<br/>
+ /// <br/>
+ /// The buffer is only valid in the event.<br/>
/// Any attempt to access to this buffer after the event ends will throw an exception.
/// </remarks>
public IMediaBuffer Stream { get; }
/// Gets the stream buffer that will be recordered.
/// </summary>
/// <remarks>
- /// This buffer is read-only and only valid in the event.\n
+ /// This buffer is read-only and only valid in the event.<br/>
/// Any attempt to access to this buffer after the event ends will throw an exception.
/// </remarks>
public IMediaBuffer Stream { get; }
/// </value>
/// <remarks>
/// After reaching the limitation, the data which is being recorded will
- /// be discarded and will not be written to the file.\n
- /// \n
+ /// 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>
/// </value>
/// <remarks>
/// After reaching the limitation, the data which is being recorded will
- /// be discarded and will not be written to the file.\n
- /// \n
+ /// 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>
{
/// <summary>
/// Recorder is a base class for audio and video recorders that
- /// provides the ability to control the recording of a multimedia content.\n
- /// \n
+ /// provides the ability to control the recording of a multimedia content.<br/>
+ /// <br/>
/// Simple audio and audio/video are supported.
/// </summary>
public abstract partial class Recorder : IDisposable
/// Prepares the media recorder for recording.
/// </summary>
/// <remarks>
- /// The recorder should be in the <see cref="RecorderState.Idle"/> state.\n
- /// The state of the recorder will be the <see cref="RecorderState.Ready"/> after this.\n
+ /// The recorder should be in the <see cref="RecorderState.Idle"/> state.<br/>
+ /// The state of the recorder will be the <see cref="RecorderState.Ready"/> after this.<br/>
/// It has no effect if the current state is the <see cref="RecorderState.Ready"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// The recorder is not in the valid state.\n
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
/// It has no effect if the current state is the <see cref="RecorderState.Idle"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// The recorder is not in the valid state.\n
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
/// </summary>
/// <remarks>
/// The recorder must be in the <see cref="RecorderState.Ready"/> state.
- /// 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
+ /// The state of the recorder will be the <see cref="RecorderState.Recording"/> after this. <br/>
+ /// <br/>
+ /// If the specified path exists, the file is removed automatically and updated by new one.<br/>
+ /// The mediastorage privilege(http://tizen.org/privilege/mediastorage) is required if the path is relevant to media storage.<br/>
+ /// The externalstorage privilege(http://tizen.org/privilege/externalstorage) is required if the path is relevant to external storage.<br/>
+ /// <br/>
/// In the video recorder, some preview format does not support record mode.
- /// You should use the default preview format or the <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>
/// <exception cref="InvalidOperationException">
- /// The recorder is not in the valid state.\n
- /// -or-\n
- /// The preview format of the camera is not supported.
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
+ /// The preview format of the camera is not supported.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
/// It has no effect if the current state is the <see cref="RecorderState.Recording"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// The recorder is not in the valid state.\n
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
/// It has no effect if the current state is the <see cref="RecorderState.Paused"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// The recorder is not in the valid state.\n
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
/// 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
- /// -or-\n
- /// The method is called in <see cref="AudioStreamStoring"/> event.
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
+ /// The method is called in <see cref="AudioStreamStoring"/> event.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
}
/// <summary>
- /// Cancels the recording.\n
+ /// Cancels the recording.<br/>
/// The recording data is discarded and not written in the recording file.
/// </summary>
/// <remarks>
/// 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
- /// -or-\n
- /// The method is called in <see cref="AudioStreamStoring"/> event.
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
+ /// The method is called in <see cref="AudioStreamStoring"/> event.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">The recorder already has been disposed of.</exception>
/// <param name="policy">The policy to apply.</param>
/// <exception cref="ArgumentNullException"><paramref name="policy"/> is null.</exception>
/// <exception cref="InvalidOperationException">
- /// The recorder is not in the valid state.\n
- /// -or-\n
- /// <paramref name="policy"/> is not supported for the recorder.
- /// -or-\n
+ /// The recorder is not in the valid state.<br/>
+ /// -or-<br/>
+ /// <paramref name="policy"/> is not supported for the recorder.<br/>
+ /// -or-<br/>
/// An internal error occurred.
/// </exception>
/// <exception cref="ObjectDisposedException">
- /// The recorder already has been disposed of.\n
- /// -or-\n
+ /// The recorder already has been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="policy"/> already has been disposed of.
/// </exception>
public void ApplyAudioStreamPolicy(AudioStreamPolicy policy)
/// Returns the peak audio input level in dB since the last call to this method.
/// </summary>
/// <remarks>
- /// 0dB indicates the maximum input level, -300dB indicates the minimum input level.\n
- /// \n
+ /// 0dB indicates the maximum input level, -300dB indicates the minimum input level.<br/>
+ /// <br/>
/// 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>
/// </summary>
/// <remarks>
/// If the state of <see cref="Camera"/> is <see cref="CameraState.Created"/>,
- /// the <see cref="CameraSettings.PreviewPixelFormat"/> will be changed to the recommended format for recording.\n
- /// \n
+ /// the <see cref="CameraSettings.PreviewPixelFormat"/> will be changed to the recommended format for recording.<br/>
+ /// <br/>
/// The initial state of the Recorder will be <see cref="RecorderState.Ready"/>
/// if the state of <see cref="Camera"/> is <see cref="CameraState.Preview"/> or <see cref="CameraState.Captured"/>.
/// </remarks>
/// <feature>http://tizen.org/feature/camera</feature>
/// <exception cref="InvalidOperationException">An internal error occurred.</exception>
/// <exception cref="NotSupportedException">
- /// A required feature is not supported.\n
- /// -or-\n
- /// <paramref name="videoCodec"/> is not supported.\n
- /// -or-\n
+ /// A required feature is not supported.<br/>
+ /// -or-<br/>
+ /// <paramref name="videoCodec"/> is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified video codec.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="videoCodec"/> is not valid.\n
- /// -or-\n
- /// <paramref name="fileFormat"/> is not valid.\n
- /// -or-\n
+ /// <paramref name="videoCodec"/> is not valid.<br/>
+ /// -or-<br/>
+ /// <paramref name="fileFormat"/> is not valid.<br/>
+ /// -or-<br/>
/// <paramref name="camera"/> is being used by another object.
/// </exception>
/// <exception cref="ObjectDisposedException"><paramref name="camera"/> has been disposed of.</exception>
/// </summary>
/// <remarks>
/// If the state of <see cref="Camera"/> is <see cref="CameraState.Created"/>,
- /// the <see cref="CameraSettings.PreviewPixelFormat"/> will be changed to the recommended format for recording.\n
- /// \n
+ /// the <see cref="CameraSettings.PreviewPixelFormat"/> will be changed to the recommended format for recording.<br/>
+ /// <br/>
/// The initial state of the Recorder will be <see cref="RecorderState.Ready"/>
/// if the state of <see cref="Camera"/> is <see cref="CameraState.Preview"/> or <see cref="CameraState.Captured"/>.
/// </remarks>
/// <feature>http://tizen.org/feature/camera</feature>
/// <exception cref="InvalidOperationException">An internal error occurred.</exception>
/// <exception cref="NotSupportedException">
- /// A required feature is not supported.\n
- /// -or-\n
- /// <paramref name="videoCodec"/> is not supported.\n
- /// -or-\n
- /// <paramref name="audioCodec"/> is not supported.\n
- /// -or-\n
+ /// A required feature is not supported.<br/>
+ /// -or-<br/>
+ /// <paramref name="videoCodec"/> is not supported.<br/>
+ /// -or-<br/>
+ /// <paramref name="audioCodec"/> is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified video codec.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified audio codec.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="videoCodec"/> is not valid.\n
- /// -or-\n
- /// <paramref name="audioCodec"/> is not valid.\n
- /// -or-\n
+ /// <paramref name="videoCodec"/> is not valid.<br/>
+ /// -or-<br/>
+ /// <paramref name="audioCodec"/> is not valid.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not valid.
/// </exception>
/// <exception cref="ObjectDisposedException"><paramref name="camera"/> has been disposed of.</exception>
/// <param name="videoCodec">The codec for video encoding.</param>
/// <param name="fileFormat">The format of result file.</param>
/// <exception cref="NotSupportedException">
- /// <paramref name="videoCodec"/> is not supported.\n
- /// -or-\n
+ /// <paramref name="videoCodec"/> is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified video codec.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="videoCodec"/> is not valid.\n
- /// -or-\n
+ /// <paramref name="videoCodec"/> is not valid.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not valid.
/// </exception>
/// <seealso cref="GetSupportedVideoCodecs"/>
/// <param name="audioCodec">The codec for audio encoding.</param>
/// <param name="fileFormat">The format of result file.</param>
/// <exception cref="NotSupportedException">
- /// <paramref name="videoCodec"/> is not supported.\n
- /// -or-\n
- /// <paramref name="audioCodec"/> is not supported.\n
- /// -or-\n
+ /// <paramref name="videoCodec"/> is not supported.<br/>
+ /// -or-<br/>
+ /// <paramref name="audioCodec"/> is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified video codec.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not supported with the specified audio codec.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="videoCodec"/> is not valid.\n
- /// -or-\n
- /// <paramref name="audioCodec"/> is not valid.\n
- /// -or-\n
+ /// <paramref name="videoCodec"/> is not valid.<br/>
+ /// -or-<br/>
+ /// <paramref name="audioCodec"/> is not valid.<br/>
+ /// -or-<br/>
/// <paramref name="fileFormat"/> is not valid.
/// </exception>
/// <seealso cref="Recorder.GetSupportedAudioCodecs"/>
/// Gets or sets the video recording motion rate.
/// </summary>
/// <remarks>
- /// The attribute is valid only in a video recorder.\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
+ /// The attribute is valid only in a video recorder.<br/>
+ /// If the rate is in range of 0-1, the video is recorded in a slow motion mode.<br/>
+ /// If the rate is bigger than 1, the video is recorded in a fast motion mode.<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">The <paramref name="value"/> is less than or equal to 0.</exception>
/// When the server stops, <see cref="MediaControllerManager.ServerStopped"/> will be raised.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// The server is not running .\n
- /// -or-\n
+ /// The server is not running .<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <seealso cref="MediaControllerManager.ServerStopped"/>
/// <exception cref="ArgumentException"><paramref name="state"/> is not valid.</exception>
/// <exception cref="ArgumentOutOfRangeException"><paramref name="position"/> is less than zero.</exception>
/// <exception cref="InvalidOperationException">
- /// The server is not running .\n
- /// -or-\n
+ /// The server is not running .<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
public static void SetPlaybackState(MediaControlPlaybackState state, long position)
/// <param name="metadata">The metadata to update.</param>
/// <exception cref="ArgumentNullException"><paramref name="metadata"/> is null.</exception>
/// <exception cref="InvalidOperationException">
- /// The server is not running .\n
- /// -or-\n
+ /// The server is not running .<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
public static void SetMetadata(MediaControlMetadata metadata)
/// </summary>
/// <param name="enabled">A value indicating whether the shuffle mode is enabled.</param>
/// <exception cref="InvalidOperationException">
- /// The server is not running .\n
- /// -or-\n
+ /// The server is not running .<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
public static void SetShuffleModeEnabled(bool enabled)
/// </summary>
/// <param name="mode">A value indicating the repeat mode.</param>
/// <exception cref="InvalidOperationException">
- /// The server is not running .\n
- /// -or-\n
+ /// The server is not running .<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="mode"/> is invalid.</exception>
/// </summary>
/// <returns>The playback state.</returns>
/// <exception cref="InvalidOperationException">
- /// The server has already been stopped.
- /// -or-\n
+ /// The server has already been stopped.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaControllerManager"/> has already been disposed of.</exception>
/// </summary>
/// <returns>The playback position in milliseconds.</returns>
/// <exception cref="InvalidOperationException">
- /// The server has already been stopped.
- /// -or-\n
+ /// The server has already been stopped.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaControllerManager"/> has already been disposed of.</exception>
/// </summary>
/// <returns>The metadata.</returns>
/// <exception cref="InvalidOperationException">
- /// The server has already been stopped.
- /// -or-\n
+ /// The server has already been stopped.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaControllerManager"/> has already been disposed of.</exception>
/// </summary>
/// <returns>A value indicating whether the shuffle mode is enabled.</returns>
/// <exception cref="InvalidOperationException">
- /// The server has already been stopped.
- /// -or-\n
+ /// The server has already been stopped.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaControllerManager"/> has already been disposed of.</exception>
/// </summary>
/// <returns>A <see cref="MediaControlRepeatMode"/> set by the server.</returns>
/// <exception cref="InvalidOperationException">
- /// The server has already been stopped.
- /// -or-\n
+ /// The server has already been stopped.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="MediaControllerManager"/> has already been disposed of.</exception>
/// Sends playback command to the server.</summary>
/// <param name="command">A playback command.</param>
/// <exception cref="InvalidOperationException">
- /// The server has already been stopped.
- /// -or-\n
+ /// The server has already been stopped.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="command"/> is not valid.</exception>
/// Starts recording.
/// </summary>
/// <remarks>
- /// The recorder state must be <see cref="RecorderState.Ready"/> state by
- /// <see cref="Prepare(StreamRecorderOptions)"/> or
- /// <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.<br/>
+ /// The recorder state must be <see cref="RecorderState.Ready"/> state by
+ /// <see cref="Prepare(StreamRecorderOptions)"/> or
+ /// <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.<br/>
/// <br/>
/// It has no effect if the recorder is already in the <see cref="RecorderState.Recording"/> state.
/// </remarks>
/// <remarks>
/// Recording can be resumed with <see cref="Start"/>.<br/>
/// <br/>
- /// The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/> <br/>
+ /// The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/>.<br/>
/// <br/>
/// It has no effect if the recorder is already in the <see cref="RecorderState.Paused"/> state.
/// </remarks>
/// The recorder state must be <see cref="RecorderState.Recording"/> state by <see cref="Start"/> or
/// <see cref="RecorderState.Paused"/> state by <see cref="Pause"/>.<br/>
/// <br/>
- /// The recorder state will be <see cref="RecorderState.Ready"/> after commit.<br/>
+ /// The recorder state will be <see cref="RecorderState.Ready"/> after commit.
/// <para>
/// http://tizen.org/privilege/mediastorage is needed if the save path are relevant to media storage.
/// http://tizen.org/privilege/externalstorage is needed if the save path are relevant to external storage.
/// <exception cref="ArgumentException">
/// <paramref name="codec"/> is not valid.<br/>
/// -or-<br/>
- /// <paramref name="sourceFormat"/> is not valid.<br/>
+ /// <paramref name="sourceFormat"/> is not valid.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// Width or height of <paramref name="resolution"/> is less than or equal to zero.<br/>
/// -or-<br/>
- /// <paramref name="frameRate"/> is less than or equal to zero.<br/>
+ /// <paramref name="frameRate"/> is less than or equal to zero.
/// </exception>
public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution,
StreamRecorderVideoFormat sourceFormat, int frameRate) :
/// <param name="inputFilePath">The input file path from which to decode.</param>
/// <returns>A task that represents the asynchronous decoding operation.</returns>
/// <remarks>
- /// Only Graphics Interchange Format(GIF) codec returns more than one frame.\n
- /// \n
- /// http://tizen.org/privilege/mediastorage is needed if <paramref name="inputFilePath"/> is relevant to the media storage.\n
+ /// Only Graphics Interchange Format(GIF) codec returns more than one frame.<br/>
+ /// <br/>
+ /// http://tizen.org/privilege/mediastorage is needed if <paramref name="inputFilePath"/> is relevant to the media storage.<br/>
/// http://tizen.org/privilege/externalstorage is needed if <paramref name="inputFilePath"/> is relevant to the external storage.
/// </remarks>
/// <exception cref="ArgumentNullException"><paramref name="inputFilePath"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="inputFilePath"/> is an empty string.\n
- /// - or -\n
- /// <paramref name="inputFilePath"/> is not a image file.\n
- /// - or -\n
+ /// <paramref name="inputFilePath"/> is an empty string.<br/>
+ /// - or -<br/>
+ /// <paramref name="inputFilePath"/> is not a image file.<br/>
+ /// - or -<br/>
/// The format of <paramref name="inputFilePath"/> is not <see cref="InputFormat"/>.
/// </exception>
/// <exception cref="FileNotFoundException"><paramref name="inputFilePath"/> does not exists.</exception>
/// </summary>
/// <param name="inputBuffer">The image buffer from which to decode.</param>
/// <returns>A task that represents the asynchronous decoding operation.</returns>
- /// <remarks>
- /// Only Graphics Interchange Format(GIF) codec returns more than one frame.\n
- /// </remarks>
+ /// <remarks>Only Graphics Interchange Format(GIF) codec returns more than one frame.</remarks>
/// <exception cref="ArgumentNullException"><paramref name="inputBuffer"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="inputBuffer"/> is an empty array.\n
- /// - or -\n
+ /// <paramref name="inputBuffer"/> is an empty array.<br/>
+ /// - or -<br/>
/// The format of <paramref name="inputBuffer"/> is not <see cref="InputFormat"/>.
/// </exception>
/// <exception cref="FileFormatException">The format of <paramref name="inputBuffer"/> is not <see cref="InputFormat"/>.</exception>
/// </summary>
/// <param name="resolution">The target resolution.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width of <paramref name="resolution"/> is less than or equal to zero.\n
- /// - or -\n
+ /// The width of <paramref name="resolution"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// The height of <paramref name="resolution"/> is less than or equal to zero.
/// </exception>
public void SetResolution(Size resolution)
/// <param name="outStream">The stream that the image is encoded to.</param>
/// <returns>A task that represents the asynchronous encoding operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="inputBuffer"/> is null.\n
- /// - or -\n
+ /// <paramref name="inputBuffer"/> is null.<br/>
+ /// - or -<br/>
/// <paramref name="outStream"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="inputBuffer"/> is an empty array.\n
- /// - or -\n
- /// <paramref name="outStream"/> is not writable.\n
+ /// <paramref name="inputBuffer"/> is an empty array.<br/>
+ /// - or -<br/>
+ /// <paramref name="outStream"/> is not writable.
/// </exception>
/// <exception cref="InvalidOperationException">The resolution is not set.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="ImageEncoder"/> has already been disposed of.</exception>
/// <param name="quality">The quality for JPEG image encoding; from 1(lowest quality) to 100(highest quality).</param>
/// <remarks><see cref="ImageEncoder.OutputFormat"/> will be the <see cref="ImageFormat.Jpeg"/>.</remarks>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="quality"/> is less than or equal to 0.\n
- /// - or -\n
+ /// <paramref name="quality"/> is less than or equal to 0.<br/>
+ /// - or -<br/>
/// <paramref name="quality"/> is greater than 100.
/// </exception>
public JpegEncoder(int quality) :
/// Gets or sets the quality of the encoded image.
/// </summary>
/// <value>
- /// The quality of the output image. The default is 75.\n
+ /// The quality of the output image. The default is 75.<br/>
/// Valid value is from 1(lowest quality) to 100(highest quality).
/// </value>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than or equal to 0.\n
- /// - or -\n
+ /// <paramref name="value"/> is less than or equal to 0.<br/>
+ /// - or -<br/>
/// <paramref name="value"/> is greater than 100.
/// </exception>
public int Quality
/// <param name="outStream">The stream that the image is encoded to.</param>
/// <returns>A task that represents the asynchronous encoding operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="frames"/> is null.\n
- /// - or -\n
+ /// <paramref name="frames"/> is null.<br/>
+ /// - or -<br/>
/// <paramref name="outStream"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="frames"/> has no element(empty).\n
- /// - or -\n
- /// <paramref name="outStream"/> is not writable.\n
+ /// <paramref name="frames"/> has no element(empty).<br/>
+ /// - or -<br/>
+ /// <paramref name="outStream"/> is not writable.
/// </exception>
/// <exception cref="InvalidOperationException">The resolution is not set.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="ImageEncoder"/> has already been disposed of.</exception>
/// <param name="index">The zero-based index of the <see cref="ImageTransform"/> to get or set.</param>
/// <value>The <see cref="ImageTransform"/> at the specified index.</value>
/// <exception cref="ArgumentOutOfRangeException">
- /// index is less than 0.\n
- /// - or -\n
+ /// index is less than 0.<br/>
+ /// - or -<br/>
/// index is equal to or greater than Count.
/// </exception>
public ImageTransform this[int index]
/// <param name="item">The <see cref="ImageTransform"/> to insert into the collection.</param>
/// <exception cref="ArgumentNullException"><paramref name="item"/> is null.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// index is less than 0.\n
- /// -or-\n
+ /// index is less than 0.<br/>
+ /// -or-<br/>
/// index is greater than <see cref="Count"/>.
/// </exception>
public void Insert(int index, ImageTransform item)
/// </summary>
/// <param name="index">The zero-based index to remove.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// index is less than 0.\n
- /// - or -\n
+ /// index is less than 0.<br/>
+ /// - or -<br/>
/// index is equal to or greater than <see cref="Count"/>.
/// </exception>
public void RemoveAt(int index) => _list.RemoveAt(index);
/// </summary>
/// <param name="region">The crop region.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// The X-position of <paramref name="region"/> is less than zero.\n
- /// - or -\n
- /// The Y-position of <paramref name="region"/> is less than zero.\n
- /// - or -\n
- /// The width of <paramref name="region"/> is less than or equal to zero.\n
- /// - or -\n
+ /// The X-position of <paramref name="region"/> is less than zero.<br/>
+ /// - or -<br/>
+ /// The Y-position of <paramref name="region"/> is less than zero.<br/>
+ /// - or -<br/>
+ /// The width of <paramref name="region"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// The height of <paramref name="region"/> is less than or equal to zero.
/// </exception>
public CropTransform(Rectangle region)
/// Gets or sets the crop region.
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">
- /// The X-position of <paramref name="value"/> is less than zero.\n
- /// - or -\n
- /// The Y-position of <paramref name="value"/> is less than zero.\n
- /// - or -\n
- /// The width of <paramref name="value"/> is less than or equal to zero.\n
- /// - or -\n
+ /// The X-position of <paramref name="value"/> is less than zero.<br/>
+ /// - or -<br/>
+ /// The Y-position of <paramref name="value"/> is less than zero.<br/>
+ /// - or -<br/>
+ /// The width of <paramref name="value"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// The height of <paramref name="value"/> is less than or equal to zero.
/// </exception>
public Rectangle Region
/// </summary>
/// <param name="size">The size that an image is resized to.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width of <paramref name="size"/> is less than or equal to zero.\n
- /// - or -\n
+ /// The width of <paramref name="size"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// The height of <paramref name="size"/> is less than or equal to zero.
/// </exception>
public ResizeTransform(Size size)
/// Gets or sets the size that an image is resized to.
/// </summary>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width of <paramref name="value"/> is less than or equal to zero.\n
- /// - or -\n
+ /// The width of <paramref name="value"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// The height of <paramref name="value"/> is less than or equal to zero.
/// </exception>
public Size Size
/// <param name="item"><see cref="ImageTransform"/> to apply.</param>
/// <returns>A task that represents the asynchronous transforming operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// - or -\n
+ /// <paramref name="source"/> is null.<br/>
+ /// - or -<br/>
/// <paramref name="item"/> is null.
/// </exception>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTransformer"/> has already been disposed of.</exception>
/// <param name="colorSpace"><see cref="ColorSpace"/> of the image.</param>
/// <returns>The buffer size.</returns>
/// <exception cref="ArgumentOutOfRangeException">
- /// width of <paramref name="resolution"/> is less than or equal to zero.\n
- /// - or -\n
+ /// width of <paramref name="resolution"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// height of <paramref name="resolution"/> is less than or equal to zero.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="colorSpace"/> is invalid.</exception>
/// <exception cref="ArgumentNullException"><paramref name="buffer"/> is null.</exception>
/// <exception cref="ArgumentException"><paramref name="buffer"/> is empty.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// width of <paramref name="size"/> is less than or equal to zero.\n
- /// - or -\n
+ /// width of <paramref name="size"/> is less than or equal to zero.<br/>
+ /// - or -<br/>
/// height of <paramref name="size"/> is less than or equal to zero.
/// </exception>
public static Color GetColor(byte[] buffer, Size size)
/// Extracts the thumbnail for the given media with the specified path.
/// </summary>
/// <returns>A task that represents the asynchronous extracting operation.</returns>
- /// <remarks>The size of the thumbnail will be the default size(320x240).\n</remarks>
+ /// <remarks>The size of the thumbnail will be the default size(320x240).</remarks>
/// <param name="path">The path of the media file to extract the thumbnail.</param>
/// <param name="cancellationToken">The token to stop the operation.</param>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <since_tizen> 3 </since_tizen>
/// <returns>A task that represents the asynchronous extracting operation.</returns>
/// <remarks>
- /// If the width is not a multiple of 8, it can be changed by the inner process.\n
+ /// If the width is not a multiple of 8, it can be changed by the inner process.<br/>
/// The width will be a multiple of 8 greater than the set value.
/// </remarks>
/// <param name="path">The path of the media file to extract the thumbnail.</param>
/// <since_tizen> 3 </since_tizen>
/// <returns>A task that represents the asynchronous extracting operation.</returns>
/// <remarks>
- /// If the width is not a multiple of 8, it can be changed by the inner process.\n
+ /// If the width is not a multiple of 8, it can be changed by the inner process.<br/>
/// The width will be a multiple of 8 greater than the set value.
/// </remarks>
/// <param name="path">The path of the media file to extract the thumbnail.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> already has been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> already has been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> already has been disposed of.
/// </exception>
/// <seealso cref="Barcode"/>
/// <param name="qrConfig">The <see cref="QrConfiguration"/> instance.</param>
/// <returns><see cref="MediaVisionSource"/> containing the generated QR image.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="qrConfig"/> is null.\n
- /// -or-\n
+ /// <paramref name="qrConfig"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="message"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="message"/> contains characters which are illegal by the <see cref="QrMode"/>.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// because the text visibility is not supported in the QR code.
/// </remarks>
/// <exception cref="ArgumentNullException">
- /// <paramref name="qrConfig"/> is null.\n
- /// -or-\n
+ /// <paramref name="qrConfig"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="message"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="message"/> contains characters which are illegal by the <see cref="QrMode"/>.
/// </exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <see cref="BarcodeGenerationConfiguration.TextVisibility"/> is the <see cref="Visibility.Visible"/>.
/// </exception>
/// <exception cref="ObjectDisposedException"><paramref name="config"/> already has been disposed of.</exception>
/// <returns><see cref="MediaVisionSource"/> containing the generated barcode image.</returns>
/// <exception cref="ArgumentNullException"><paramref name="message"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
- /// <paramref name="type"/> is <see cref="BarcodeType.QR"/>.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
+ /// <paramref name="type"/> is <see cref="BarcodeType.QR"/>.<br/>
+ /// -or-<br/>
/// <paramref name="type"/> is invalid.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="message"/> contains illegal characters.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <returns><see cref="MediaVisionSource"/> containing the generated barcode image.</returns>
/// <exception cref="ArgumentNullException"><paramref name="message"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="type"/> is <see cref="BarcodeType.QR"/>.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="type"/> is invalid.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="message"/> contains illegal characters.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <param name="qrConfig">The <see cref="QrConfiguration"/> instance.</param>
/// <param name="imageConfig">The <see cref="BarcodeImageConfiguration"/> that contains information about the file to be generated.</param>
/// <exception cref="ArgumentNullException">
- /// <paramref name="message"/> is null.\n
- /// -or-\n
- /// <paramref name="qrConfig"/> is null.\n
- /// -or-\n
+ /// <paramref name="message"/> is null.<br/>
+ /// -or-<br/>
+ /// <paramref name="qrConfig"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="imageConfig"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="message"/> contains characters which are illegal by the <see cref="QrMode"/>.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// information about the file to be generated.</param>
/// <param name="config">The configuration of the barcode generator. This value can be null.</param>
/// <exception cref="ArgumentNullException">
- /// <paramref name="message"/> is null.\n
- /// -or-\n
- /// <paramref name="qrConfig"/> is null.\n
- /// -or-\n
+ /// <paramref name="message"/> is null.<br/>
+ /// -or-<br/>
+ /// <paramref name="qrConfig"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="imageConfig"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="message"/> contains characters which are illegal by the <see cref="QrMode"/>.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <see cref="BarcodeGenerationConfiguration.TextVisibility"/> is the <see cref="Visibility.Visible"/>.
/// </exception>
/// <exception cref="ObjectDisposedException"><paramref name="config"/> already has been disposed of.</exception>
/// <param name="imageConfig">The <see cref="BarcodeImageConfiguration"/> that contains
/// information about the file to be generated.</param>
/// <exception cref="ArgumentNullException">
- /// <paramref name="message"/> is null.\n
- /// -or-\n
+ /// <paramref name="message"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="imageConfig"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="type"/> is <see cref="BarcodeType.QR"/>.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="type"/> is invalid.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="message"/> contains illegal characters.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// information about the file to be generated.</param>
/// <param name="config">The configuration of the barcode generator. This value can be null.</param>
/// <exception cref="ArgumentNullException">
- /// <paramref name="message"/> is null.\n
- /// -or-\n
+ /// <paramref name="message"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="imageConfig"/> is null.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="message"/> is too long.\n
- /// -or-\n
+ /// <paramref name="message"/> is too long.<br/>
+ /// -or-<br/>
/// <paramref name="type"/> is <see cref="BarcodeType.QR"/>.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="type"/> is invalid.
- /// -or-\n
+ /// -or-<br/>
/// <paramref name="message"/> contains illegal characters.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to write a file.</exception>
/// Initializes a new instance of the <see cref="BarcodeImageConfiguration"/> class.
/// </summary>
/// <remarks>
- /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n
+ /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.<br/>
/// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage.
/// </remarks>
/// <param name="size">The <see cref="Size"/> of the generated image.</param>
/// <param name="path">The path to the file to be generated.</param>
/// <param name="imageFormat">The format of the output image.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width of <paramref name="size"/> is less than or equal to zero.\n
- /// -or-\n
+ /// The width of <paramref name="size"/> is less than or equal to zero.<br/>
+ /// -or-<br/>
/// The height of <paramref name="size"/> is less than or equal to zero.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// Initializes a new instance of the <see cref="BarcodeImageConfiguration"/> class.
/// </summary>
/// <remarks>
- /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n
+ /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.<br/>
/// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage.
/// </remarks>
/// <param name="width">The width of the image to be generated.</param>
/// <param name="path">The path to the file to be generated.</param>
/// <param name="imageFormat">The format of the output image.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="width"/> is less than or equal to zero.\n
- /// -or-\n
+ /// <paramref name="width"/> is less than or equal to zero.<br/>
+ /// -or-<br/>
/// <paramref name="height"/> is less than or equal to zero.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// Gets the path to the file that has to be generated.
/// </summary>
/// <remarks>
- /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.\n
+ /// The mediastorage privilege (http://tizen.org/privilege/mediastorage) is needed if the image path is relevant to media storage.<br/>
/// The externalstorage privilege (http://tizen.org/privilege/externalstorage) is needed if the image path is relevant to external storage.
/// </remarks>
/// <since_tizen> 3 </since_tizen>
/// Default value is null (the roi will be a full image), which can be changed to specify the roi for face detection.
/// </remarks>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width of <paramref name="value"/> is less than or equal to zero.\n
- /// -or-\n
- /// The height of <paramref name="value"/> is less than or equal to zero.\n
- /// -or-\n
- /// The x position of <paramref name="value"/> is less than zero.\n
- /// -or-\n
- /// The y position of <paramref name="value"/> is less than zero.\n
+ /// The width of <paramref name="value"/> is less than or equal to zero.<br/>
+ /// -or-<br/>
+ /// The height of <paramref name="value"/> is less than or equal to zero.<br/>
+ /// -or-<br/>
+ /// The x position of <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// The y position of <paramref name="value"/> is less than zero.
/// </exception>
/// <since_tizen> 3 </since_tizen>
public Rectangle? Roi
{
/// <summary>
- /// Detects faces on the source.\n
+ /// Detects faces on the source.<br/>
/// Each time when DetectAsync is called, a set of the detected faces at the media source are received asynchronously.
/// </summary>
/// <param name="source">The source of the media where faces will be detected.</param>
/// <returns>A task that represents the asynchronous detect operation.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// The format of <paramref name="source"/> is not supported.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Detects faces on the source.\n
+ /// Detects faces on the source.<br/>
/// Each time when DetectAsync is called, a set of the detected faces at the media source are received asynchronously.
/// </summary>
/// <param name="source">The source of the media where faces will be detected.</param>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// <exception cref="FileNotFoundException"><paramref name="modelPath"/> is invalid.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="modelPath"/> is not supported format.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// Has to be unique for each face.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="FaceRecognitionModel"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="FaceRecognitionModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="source"/> has already been dispose of.
/// </exception>
/// <seealso cref="Learn(FaceRecognitionConfiguration)"/>
/// <param name="area">The rectangular region of the face image at the source image.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="FaceRecognitionModel"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="FaceRecognitionModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="source"/> has already been dispose of.
/// </exception>
/// <seealso cref="Learn(FaceRecognitionConfiguration)"/>
/// </remarks>
/// <param name="config">The configuration used for learning of the recognition models. This value can be null.</param>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="FaceRecognitionModel"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="FaceRecognitionModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="InvalidOperationException">No examples added.</exception>
/// <param name="recognitionModel">The <see cref="FaceRecognitionConfiguration"/> to be used for recognition.</param>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="recognitionModel"/> is null.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <param name="bound">Rectangular box bounding face image on the source.</param>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="recognitionModel"/> is null.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <param name="config">The configuration used for recognition. This value can be null.</param>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="recognitionModel"/> is null.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="InvalidOperationException"><paramref name="recognitionModel"/> is untrained model.</exception>
/// <param name="config">The <see cref="FaceRecognitionConfiguration"/> used for recognition. This value can be null.</param>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="recognitionModel"/> is null.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="InvalidOperationException"><paramref name="recognitionModel"/> is untrained model.</exception>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// Learning process improves tracking correctness, but can decrease tracking performance.</param>
/// <returns>A task that represents the asynchronous tracking operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="trackingModel"/> is null.
/// </exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="trackingModel"/> has already been disposed of.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// <exception cref="FileNotFoundException"><paramref name="modelPath"/> is invalid.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="modelPath"/> is not supported format.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
/// If null, then tracking model will try to find previously tracked face by itself.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="FaceTrackingModel"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="FaceTrackingModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="source"/> has already bean disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Gets or sets the scale factor the image to be recognized.\n
+ /// Gets or sets the scale factor the image to be recognized.<br/>
/// The value of the factor will be used for resizing of the images (objects) for recognition.
/// The default value is 1.2.
/// </summary>
}
/// <summary>
- /// Gets or sets the maximum key points should be detected on the image.\n
+ /// Gets or sets the maximum key points should be detected on the image.<br/>
/// The maximal number of key points can be selected on the image object to calculate descriptors.
/// This key points will be used for image (object) recognition and has to be specified as integer number.
/// The default value is 1000.
/// <exception cref="ArgumentNullException"><paramref name="path"/> is null.</exception>
/// <exception cref="FileNotFoundException"><paramref name="path"/> is invalid.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="path"/> is not supported file.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
}
/// <summary>
- /// Fills the image object.\n
+ /// Fills the image object.<br/>
/// Extracts data from @a source image which will be needed for recognition of depicted object in @a location.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="ImageObject"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="ImageObject"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="source"/> has already been disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Fills the image object.\n
+ /// Fills the image object.<br/>
/// Extracts data from @a source image which will be needed for recognition of depicted object in @a location.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <param name="config">The configuration used for extract recognition data from source. This value can be null.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="ImageObject"/> has already been disposed of.\n
- /// -or-\n
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="ImageObject"/> has already been disposed of.<br/>
+ /// -or-<br/>
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Fills the image object.\n
+ /// Fills the image object.<br/>
/// Extracts data from @a source image which will be needed for recognition of depicted object in @a location.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <param name="rect">Rectangular bound of the image object on the source image.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="ImageObject"/> has already been disposed of.\n
- /// -or-\n
- /// <paramref name="source"/> has already been disposed of.\n
+ /// The <see cref="ImageObject"/> has already been disposed of.<br/>
+ /// -or-<br/>
+ /// <paramref name="source"/> has already been disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
public void Fill(MediaVisionSource source, Rectangle rect)
}
/// <summary>
- /// Fills the image object.\n
+ /// Fills the image object.<br/>
/// Extracts data from @a source image which will be needed for recognition of depicted object in @a location.
/// </summary>
/// <param name="source">The source image where image object is depicted.</param>
/// <param name="rect">Rectangular bound of the image object on the source image.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="ImageObject"/> has already been disposed of.\n
- /// -or-\n
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="ImageObject"/> has already been disposed of.<br/>
+ /// -or-<br/>
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageRecognitionConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="value"/> is greater than one.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Gets or sets the part matching error for the image recognition.\n
+ /// Gets or sets the part matching error for the image recognition.<br/>
/// Allowable error of matches number.
/// </summary>
/// <value>
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageRecognitionConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="value"/> is greater than one.
/// </exception>
/// <since_tizen> 3</since_tizen>
public static class ImageRecognizer
{
/// <summary>
- /// Recognizes the given image objects on the source image.\n
+ /// Recognizes the given image objects on the source image.<br/>
/// </summary>
/// <param name="source">The source image on which image objects will be recognized.</param>
/// <param name="imageObjects">The array of image objects which will be processed as targets of recognition.</param>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
- /// <paramref name="imageObjects"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
+ /// <paramref name="imageObjects"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="imageObjects"/> contains null reference.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="imageObjects"/> has no elements.(The length is zero.)</exception>
}
/// <summary>
- /// Recognizes the given image objects on the source image.\n
+ /// Recognizes the given image objects on the source image.<br/>
/// </summary>
/// <param name="source">The source image on which image objects will be recognized.</param>
/// <param name="imageObjects">The array of image objects which will be processed as targets of recognition.</param>
/// <param name="config">The configuration used for recognition. This value can be null.</param>
/// <returns>A task that represents the asynchronous recognition operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
- /// <paramref name="imageObjects"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
+ /// <paramref name="imageObjects"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="imageObjects"/> contains null elements.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="imageObjects"/> has no elements.(The length is zero.)</exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// <param name="trackingModel">The image tracking model which processed as target of tracking.</param>
/// <returns>A task that represents the asynchronous tracking operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="trackingModel"/> is null.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="trackingModel"/> has already been disposed of.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="trackingModel"/> has no target.</exception>
/// <param name="config">The configuration used for tracking. This value can be null.</param>
/// <returns>A task that represents the asynchronous tracking operation.</returns>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="trackingModel"/> is null.
/// </exception>
/// <exception cref="NotSupportedException">The feature is not supported.</exception>
/// <exception cref="ObjectDisposedException">
- /// <paramref name="source"/> has already been disposed of.\n
- /// -or-\n
- /// <paramref name="trackingModel"/> has already been disposed of.\n
- /// -or-\n
+ /// <paramref name="source"/> has already been disposed of.<br/>
+ /// -or-<br/>
+ /// <paramref name="trackingModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="ArgumentException"><paramref name="trackingModel"/> has no target.</exception>
/// Gets or sets the number of recognition results in the tracking history.
/// </summary>
/// <value>
- /// The number of previous recognition results, which will influence the stabilization.\n
+ /// The number of previous recognition results, which will influence the stabilization.<br/>
/// The default is 3.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// Gets or sets the expected tracking offset.
/// </summary>
/// <value>
- /// Relative offset value for which the object offset is expected (relative to the object size in the current frame).\n
+ /// Relative offset value for which the object offset is expected (relative to the object size in the current frame).<br/>
/// The default is 0.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// </summary>
/// <value>
/// Acceleration will be used for image stabilization (relative to the distance from current location to stabilized location);
- /// from 0 to 1, inclusive.\n
+ /// from 0 to 1, inclusive.<br/>
/// The default is 0.1.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="value"/> is greater than one.
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// Gets or sets the speed of the tracking stabilization.
/// </summary>
/// <value>
- /// The start speed value used for image stabilization.\n
+ /// The start speed value used for image stabilization.<br/>
/// The default is 0.3.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// It is component of tolerant shift which will be ignored by stabilization process.
/// (this value is relative to the object size in the current frame).
/// Tolerant shift will be computed like R * S + C, where R is the value set to <see cref="StabilizationTolerantShift"/>,
- /// S is the area of object location on frame, C is a constant value 1.3.\n
- /// \n
+ /// S is the area of object location on frame, C is a constant value 1.3.<br/>
+ /// <br/>
/// The default is 0.00006.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// Gets or sets the state of the contour stabilization during tracking process.
/// </summary>
/// <value>
- /// true if the contour stabilization is enabled; otherwise false.\n
+ /// true if the contour stabilization is enabled; otherwise false.<br/>
/// The default is true.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="ImageTrackingConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentNullException"><paramref name="modelPath"/> is null.</exception>
/// <exception cref="FileNotFoundException"><paramref name="modelPath"/> is invalid.</exception>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="modelPath"/> is not supported format.
/// </exception>
/// <exception cref="UnauthorizedAccessException">No permission to access the specified file.</exception>
}
/// <summary>
- /// Sets the target of the image tracking model.\n
+ /// Sets the target of the image tracking model.<br/>
/// Sets the image object which will be tracked by using tracking functionality with this tracking model.
/// </summary>
/// <param name="imageObject">Image object which will be set as the target for tracking.</param>
/// <exception cref="ArgumentNullException"><paramref name="imageObject"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="ImageTrackingModel"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="ImageTrackingModel"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="imageObject"/> has already been disposed of.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Refreshes the state of image tracking model.\n
+ /// Refreshes the state of image tracking model.<br/>
/// Clears the moving history and change state to undetected. It is usually called each time before tracking is started
/// for the new sequence of sources, which is not the direct continuation of the sequence for which tracking has been performed before.
/// Tracking algorithm will try to find image by itself.
/// <param name="height">The height of image.</param>
/// <param name="colorSpace">The image <see cref="ColorSpace"/>.</param>
/// <exception cref="NotSupportedException">
- /// The feature is not supported.\n
- /// -or-\n
+ /// The feature is not supported.<br/>
+ /// -or-<br/>
/// <paramref name="colorSpace"/> is not supported.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="buffer"/> is null.</exception>
/// <exception cref="ArgumentException">
- /// <paramref name="buffer"/> has no element.(The length is zero.)\n
- /// -or-\n
+ /// <paramref name="buffer"/> has no element.(The length is zero.)<br/>
+ /// -or-<br/>
/// <paramref name="colorSpace"/> is invalid.
/// </exception>
/// <since_tizen> 3 </since_tizen>
}
/// <summary>
- /// Gets or sets movement detection threshold.\n
+ /// Gets or sets movement detection threshold.<br/>
/// This value might be set before subscription on <see cref="MovementDetector.Detected"/> event
/// to specify the sensitivity of the movement detector.
/// </summary>
/// <value>
/// The value indicating the sensitivity of <see cref="MovementDetector"/> from 0 to 255 inclusive,
/// where 255 means that no movements will be detected and 0 means that all frame changes
- /// will be interpreted as movements.\n
+ /// will be interpreted as movements.<br/>
/// The default is 10.
/// </value>
/// <exception cref="ObjectDisposedException">The <see cref="MovementDetectionConfiguration"/> already has been disposed of.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="value"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="value"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="value"/> is greater than 255.
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// <param name="config">The config for the <paramref name="source"/>. This value can be null.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="MovementDetector"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="MovementDetector"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
}
/// <summary>
- /// Gets or sets how many frames will be skipped during push source.\n
+ /// Gets or sets how many frames will be skipped during push source.<br/>
/// </summary>
/// <value>
/// The value to specify the number of <see cref="MediaVisionSource"/> calls will be ignored by subscription
- /// of the event trigger.\n
+ /// of the event trigger.<br/>
///
/// The default is 0. It means that no frames will be skipped and all <see cref="MediaVisionSource"/> will
/// be processed.
/// <param name="config">The config for the <paramref name="source"/>. This value can be null.</param>
/// <exception cref="ArgumentNullException"><paramref name="source"/> is null.</exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="PersonAppearanceDetector"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="PersonAppearanceDetector"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <see cref="SurveillanceSource.Push(MediaVisionSource)"/>
/// <param name="source">The source used for recognition.</param>
/// <param name="config">The config for the <paramref name="source"/>.</param>
/// <exception cref="ArgumentNullException">
- /// <paramref name="source"/> is null.\n
- /// -or-\n
+ /// <paramref name="source"/> is null.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> is null.
/// </exception>
/// <exception cref="ObjectDisposedException">
- /// The <see cref="PersonRecognizer"/> has already been disposed of.\n
- /// -or-\n
+ /// The <see cref="PersonRecognizer"/> has already been disposed of.<br/>
+ /// -or-<br/>
/// <paramref name="config"/> has already been disposed of.
/// </exception>
/// <exception cref="ArgumentException">
/// var obj = new QrConfiguration(QrMode.Numeric, ErrorCorrectionLevel.Medium, 30);
/// </code>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="version"/> is less than 1.\n
- /// -or-\n
+ /// <paramref name="version"/> is less than 1.<br/>
+ /// -or-<br/>
/// <paramref name="version"/> is greater than 40.
/// </exception>
/// <exception cref="ArgumentException">
- /// <paramref name="qrMode"/> is invalid.\n
- /// -or-
+ /// <paramref name="qrMode"/> is invalid.<br/>
+ /// -or-<br/>
/// <paramref name="ecc"/> is invalid.
/// </exception>
/// <since_tizen> 3 </since_tizen>
/// Gets or sets the auto focus reacquisition.
/// </summary>
/// <value>
- /// true if the auto focus reacquisition is enabled; otherwise, false.\n
+ /// true if the auto focus reacquisition is enabled; otherwise, false.<br/>
/// The default is true.
/// </value>
/// <remarks>
/// <param name="extraInfo">The extra information for this request. This value can be null.</param>
/// <exception cref="ArgumentException"><paramref name="options"/> is zero.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="options"/> contain a invalid bit.\n
- /// -or-\n
- /// <paramref name="behaviors"/> contain a invalid bit.\n
+ /// <paramref name="options"/> contain a invalid bit.<br/>
+ /// -or-<br/>
+ /// <paramref name="behaviors"/> contain a invalid bit.
/// </exception>
/// <exception cref="InvalidOperationException">The focus has already been acquired.</exception>
/// <exception cref="AudioPolicyException">Called in <see cref="FocusStateChanged"/> raised by releasing focus.</exception>
/// <param name="extraInfo">The extra information for this request. This value can be null.</param>
/// <exception cref="ArgumentException"><paramref name="options"/> is zero.</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="options"/> contain a invalid bit.\n
- /// -or-\n
- /// <paramref name="behaviors"/> contain a invalid bit.\n
+ /// <paramref name="options"/> contain a invalid bit.<br/>
+ /// -or-<br/>
+ /// <paramref name="behaviors"/> contain a invalid bit.
/// </exception>
/// <exception cref="InvalidOperationException">The focus has not been acquired.</exception>
/// <exception cref="ObjectDisposedException">The <see cref="AudioStreamPolicy"/> has already been disposed of.</exception>
/// The available <see cref="AudioStreamType"/> is <see cref="AudioStreamType.Voip"/> and <see cref="AudioStreamType.MediaExternalOnly"/>.
/// </remarks>
/// <exception cref="InvalidOperationException">
- /// The device is not connected.\n
- /// -or-\n
+ /// The device is not connected.<br/>
+ /// -or-<br/>
/// An internal error occurs.
/// </exception>
/// <exception cref="ArgumentNullException"><paramref name="device"/> is null.</exception>
/// </summary>
/// <param name="index">The index of the value to get or set.</param>
/// <exception cref="ArgumentOutOfRangeException">
- /// <paramref name="index"/> is less than zero.\n
- /// -or-\n
+ /// <paramref name="index"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="index"/> is equal to or greater than <see cref="Length"/>.
/// </exception>
/// <exception cref="ObjectDisposedException">The object that owns the current buffer has already been disposed of.</exception>
/// <param name="bitRate">The bit rate value of the format.</param>
/// <param name="aacType">The AAC bitstream format(ADIF or ADTS).</param>
/// <exception cref="ArgumentException">
- /// <paramref name="mimeType"/> or <paramref name="aacType"/> is invalid (i.e. undefined value).\n
- /// -or-\n
+ /// <paramref name="mimeType"/> or <paramref name="aacType"/> is invalid (i.e. undefined value).<br/>
+ /// -or-<br/>
/// <paramref name="aacType"/> is not <see cref="MediaFormatAacType.None"/>, but <paramref name="mimeType"/> is one of the AAC types.
/// </exception>
/// <exception cref="ArgumentOutOfRangeException">
/// <exception cref="ArgumentOutOfRangeException">
/// The value specified for this property is less than zero or greater than the length of the <see cref="Buffer"/>.</exception>
/// <exception cref="InvalidOperationException">
- /// The MediaPacket has <see cref="VideoPlanes"/> instead of <see cref="Buffer"/>.\n
- /// -or-\n
+ /// The MediaPacket has <see cref="VideoPlanes"/> instead of <see cref="Buffer"/>.<br/>
+ /// -or-<br/>
/// The MediaPacket is not in the writable state, which means it is being used by another module.
/// </exception>
public int BufferWrittenLength
/// <param name="frameRate">The frame rate of the format.</param>
/// <exception cref="ArgumentException"><paramref name="mimeType"/> is invalid (i.e. undefined value).</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width or the height of <paramref name="size"/> is less than zero.\n
- /// -or-\n
+ /// The width or the height of <paramref name="size"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="frameRate"/> is less than zero.
/// </exception>
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size,
/// <param name="bitRate">The bit rate of the format.</param>
/// <exception cref="ArgumentException"><paramref name="mimeType"/> is invalid (i.e. undefined value).</exception>
/// <exception cref="ArgumentOutOfRangeException">
- /// The width or the height of <paramref name="size"/> is less than zero.\n
- /// -or-\n
- /// <paramref name="frameRate"/> is less than zero.\n
- /// -or-\n
+ /// The width or the height of <paramref name="size"/> is less than zero.<br/>
+ /// -or-<br/>
+ /// <paramref name="frameRate"/> is less than zero.<br/>
+ /// -or-<br/>
/// <paramref name="bitRate"/> is less than zero.
/// </exception>
public VideoMediaFormat(MediaFormatVideoMimeType mimeType, Size size,
/// The MediaView class allows application developers to display the video output on the screen.
/// </summary>
/// <remarks>
- /// This view should not be instantiated directly.\n
+ /// This view should not be instantiated directly.<br/>
/// Use <see cref="T:Tizen.Xamarin.Forms.Extension.MediaView"/> to create the view.
/// </remarks>
/// <example>
projects / platform / core / csapi / tizenfx.git / commitdiff