From: coderhyme Date: Tue, 30 May 2017 06:26:00 +0000 (+0900) Subject: Fixed comment issues. X-Git-Tag: submit/trunk/20170823.075128~94^2~54 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=dbfa211551144540e1feb98b78a322bdd14cdcfb;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git Fixed comment issues. Fixed format errors related to new line and tag. Added missing tags. Fixed typos and so on. Change-Id: I3913ad79d9a54ed71abdb906271cdd55c31ffa83 Signed-off-by: coderhyme --- diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs index 5b04996..1284919 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioCapture.cs @@ -25,7 +25,14 @@ namespace Tizen.Multimedia /// The recorder privilege(http://tizen.org/privilege/recorder) is required. public abstract class AudioCaptureBase : IDisposable { + /// + /// Specifies the minimum value allowed for the audio capture. + /// public static readonly int MinSampleRate = 8000; + + /// + /// Specifies the maximum value allowed for the audio capture. + /// public static readonly int MaxSampleRate = 48000; internal IntPtr _handle = IntPtr.Zero; @@ -146,13 +153,12 @@ namespace Tizen.Multimedia public AudioSampleType SampleType { get; } /// - /// Gets the size to be allocated for the audio input buffer. + /// Gets the size allocated for the audio input buffer. /// /// The AudioPlayback has already been disposed. public int GetBufferSize() { - int size; - AudioIOUtil.ThrowIfError(Interop.AudioIO.AudioInput.GetBufferSize(_handle, out size)); + AudioIOUtil.ThrowIfError(Interop.AudioIO.AudioInput.GetBufferSize(_handle, out var size)); return size; } @@ -160,8 +166,8 @@ namespace Tizen.Multimedia /// Prepares the AudioCapture for reading audio data by starting buffering of audio data from the device. /// /// - /// Operation failed due to internal error. - /// -or- + /// Operation failed due to internal error.\n + /// -or-\n /// The current state is not . /// /// @@ -177,8 +183,8 @@ namespace Tizen.Multimedia /// Unprepares the AudioCapture. /// /// - /// Operation failed due to internal error. - /// -or- + /// Operation failed due to internal error.\n + /// \n /// The current state is . /// /// @@ -194,8 +200,8 @@ namespace Tizen.Multimedia /// Pauses buffering of audio data from the device. /// /// - /// The current state is . - /// -or- + /// The current state is .\n + /// -or-\n /// The method is called in the event handler. /// /// @@ -213,8 +219,8 @@ namespace Tizen.Multimedia /// Resumes buffering audio data from the device. /// /// - /// The current state is . - /// -or- + /// The current state is .\n + /// -or-\n /// The method is called in the event handler. /// /// @@ -270,7 +276,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to record audio from system audio input devices in synchronous way. /// - /// The recorder privilege(http://tizen.org/privilege/recorder) is required. + /// http://tizen.org/privilege/recorder public class AudioCapture : AudioCaptureBase { /// @@ -280,14 +286,14 @@ namespace Tizen.Multimedia /// The audio channel type. /// The audio sample type. /// - /// is less than . - /// -or- + /// is less than .\n + /// -or-\n /// is greater than . /// /// - /// The value of is invalid. - /// -or- - /// The value of is invalid. + /// is invalid.\n + /// -or-\n + /// is invalid. /// /// The required privilege is not specified. /// The system does not support microphone. @@ -299,22 +305,22 @@ namespace Tizen.Multimedia /// /// Reads audio data from the audio input buffer. /// - /// - /// The buffer of audio data receiving an input + /// The number of bytes to be read. + /// The buffer of audio data captured. /// The current state is not . - /// is equal to or less than zero. - public byte[] Read(int length) + /// is equal to or less than zero. + public byte[] Read(int count) { - if (length <= 0) + if (count <= 0) { - throw new ArgumentOutOfRangeException(nameof(length), length, - $"{ nameof(length) } can't be equal to or less than zero."); + throw new ArgumentOutOfRangeException(nameof(count), count, + $"{ nameof(count) } can't be equal to or less than zero."); } ValidateState(AudioIOState.Running); - byte[] buffer = new byte[length]; + byte[] buffer = new byte[count]; - AudioIOUtil.ThrowIfError(Interop.AudioIO.AudioInput.Read(_handle, buffer, length), + AudioIOUtil.ThrowIfError(Interop.AudioIO.AudioInput.Read(_handle, buffer, count), "Failed to read"); return buffer; @@ -324,7 +330,7 @@ namespace Tizen.Multimedia /// /// Provides the ability to record audio from system audio input devices in asynchronous way. /// - /// The recorder privilege(http://tizen.org/privilege/recorder) is required. + /// http://tizen.org/privilege/recorder public class AsyncAudioCapture : AudioCaptureBase { @@ -340,14 +346,14 @@ namespace Tizen.Multimedia /// The audio channel type. /// The audio sample type. /// - /// is less than . - /// -or- + /// is less than .\n + /// -or-\n /// is greater than . /// /// - /// The value of is invalid. - /// -or- - /// The value of is invalid. + /// is invalid.\n + /// -or-\n + /// is invalid. /// /// The required privilege is not specified. /// The system does not support microphone. diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs index 0cae374..8fc7940 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioDataAvailableEventArgs.cs @@ -28,6 +28,9 @@ namespace Tizen.Multimedia Data = data; } + /// + /// Gets the audio data captured. + /// public byte[] Data { get; } } } diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs index e9cca42..5d1677d 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioIOStateChangedEventArgs.cs @@ -19,16 +19,10 @@ using System; namespace Tizen.Multimedia { /// - /// Argument for the event that is Audio State Changed. + /// Provides data for the event and . /// public class AudioIOStateChangedEventArgs : EventArgs { - /// - /// Initializes the instance of the AudioStateChangedEventArgs class. - /// - /// - /// - /// internal AudioIOStateChangedEventArgs(AudioIOState previous, AudioIOState current, bool byPolicy) { Previous = previous; @@ -36,10 +30,19 @@ namespace Tizen.Multimedia ByPolicy = byPolicy; } + /// + /// Gets the previous state. + /// public AudioIOState Previous { get; } + /// + /// Gets the current state. + /// public AudioIOState Current { get; } + /// + /// Gets the value indicating whether the state is changed by policy or not. + /// public bool ByPolicy { get; } } } diff --git a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs index 7fca3c5..1a6b8a9 100644 --- a/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs +++ b/src/Tizen.Multimedia.AudioIO/AudioIO/AudioPlayback.cs @@ -81,14 +81,14 @@ namespace Tizen.Multimedia /// The audio channel type. /// The audio sample type. /// - /// is less than . - /// -or- + /// is less than .\n + /// -or-\n /// is greater than . /// /// - /// The value of is invalid. - /// -or- - /// The value of is invalid. + /// is invalid.\n + /// -or-\n + /// is invalid. /// public AudioPlayback(int sampleRate, AudioChannel channel, AudioSampleType sampleType) { @@ -203,13 +203,12 @@ namespace Tizen.Multimedia } /// - /// Gets the size to be allocated for the audio output buffer. + /// Gets the size allocated for the audio output buffer. /// /// The AudioPlayback has already been disposed. public int GetBufferSize() { - int size = 0; - AudioIOUtil.ThrowIfError(Interop.AudioIO.AudioOutput.GetBufferSize(_handle, out size)); + AudioIOUtil.ThrowIfError(Interop.AudioIO.AudioOutput.GetBufferSize(_handle, out var size)); return size; } @@ -265,8 +264,8 @@ namespace Tizen.Multimedia /// This must be called before . /// /// - /// Operation failed due to internal error. - /// -or- + /// Operation failed due to internal error.\n + /// -or-\n /// The current state is not . /// /// The AudioPlayback has already been disposed. @@ -283,8 +282,8 @@ namespace Tizen.Multimedia /// Unprepares the AudioPlayback. /// /// - /// Operation failed due to internal error. - /// -or- + /// Operation failed due to internal error.\n + /// -or-\n /// The current state is . /// /// The AudioPlayback has already been disposed. @@ -302,8 +301,8 @@ namespace Tizen.Multimedia /// /// It has no effect if the current is the . /// - /// The current state is . - /// -or- + /// The current state is .\n + /// -or-\n /// The method is called in the event handler. /// /// The AudioPlayback has already been disposed. @@ -324,8 +323,8 @@ namespace Tizen.Multimedia /// /// It has no effect if the current is the . /// - /// The current state is . - /// -or- + /// The current state is .\n + /// -or-\n /// The method is called in an event handler. /// /// The AudioPlayback has already been disposed. @@ -361,8 +360,8 @@ namespace Tizen.Multimedia /// The to apply for the AudioPlayback. /// is null. /// - /// has already been disposed. - /// -or- + /// has already been disposed.\n + /// -or-\n /// The AudioPlayback has already been disposed. /// /// is not supported. diff --git a/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs b/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs index 9dbec8d..3286db4 100644 --- a/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs +++ b/src/Tizen.Multimedia.Camera/Camera/CameraSettings.cs @@ -65,7 +65,7 @@ namespace Tizen.Multimedia return new Range(min, max); } -#region Auto Focus + #region Auto Focus /// /// Sets auto focus area. /// @@ -144,9 +144,9 @@ namespace Tizen.Multimedia "Failed to set camera autofocus mode."); } } -#endregion Auto Focus + #endregion Auto Focus -#region Contrast + #region Contrast /// /// The contrast level of the camera. /// @@ -218,9 +218,9 @@ namespace Tizen.Multimedia return _contrastRange.Value; } } -#endregion Contrast + #endregion Contrast -#region Brightness + #region Brightness /// /// The brightness level of the camera. /// @@ -266,9 +266,9 @@ namespace Tizen.Multimedia return _brightnessRange.Value; } } -#endregion Brightness + #endregion Brightness -#region Exposure + #region Exposure /// /// The exposure value. /// @@ -341,9 +341,9 @@ namespace Tizen.Multimedia return _exposureRange.Value; } } -#endregion Exposure + #endregion Exposure -#region Zoom + #region Zoom /// /// The zoom level. /// The range for zoom level is received from ZoomRange property. @@ -390,7 +390,7 @@ namespace Tizen.Multimedia return _zoomRange.Value; } } -#endregion Zoom + #endregion Zoom /// /// The whitebalance mode. @@ -473,7 +473,7 @@ namespace Tizen.Multimedia } } -#region Resolution, Format, Fps of preview, capture + #region Resolution, Format, Fps of preview, capture /// /// The preview frame rate. /// @@ -627,9 +627,9 @@ namespace Tizen.Multimedia "Failed to set capture format."); } } -#endregion Resolution, Format, Fps of preview, capture + #endregion Resolution, Format, Fps of preview, capture -#region Encoded preview + #region Encoded preview /// /// The bit rate of encoded preview. /// @@ -675,7 +675,7 @@ namespace Tizen.Multimedia "Failed to set encoded preview gop intervals."); } } -#endregion Encoded preview + #endregion Encoded preview /// /// The theater mode. @@ -958,7 +958,7 @@ namespace Tizen.Multimedia } } -#region PTZ(Pan Tilt Zoom), Pan, Tilt + #region PTZ(Pan Tilt Zoom), Pan, Tilt /// /// Sets the type of PTZ(Pan Tilt Zoom). Mechanical or Electronic. /// @@ -1078,9 +1078,9 @@ namespace Tizen.Multimedia return _tiltRange.Value; } } -#endregion PTZ(Pan Tilt Zoom), Pan, Tilt + #endregion PTZ(Pan Tilt Zoom), Pan, Tilt -#region EXIF tag + #region EXIF tag /// /// The scene mode. /// true if EXIF tags are enabled in JPEG file, otherwise false. @@ -1224,7 +1224,7 @@ namespace Tizen.Multimedia "Failed to set camera tag orientation."); } } -#endregion EXIF tag + #endregion EXIF tag } } diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs index 7768d4d..1625af3 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodec.cs @@ -188,8 +188,8 @@ namespace Tizen.Multimedia.MediaCodec /// Prepares the MediaCodec for encoding or decoding. /// /// - /// The codec is not configured, yet. - /// -or- + /// The codec is not configured, yet.\n + /// -or-\n /// Internal error. /// public void Prepare() @@ -230,9 +230,9 @@ namespace Tizen.Multimedia.MediaCodec /// The value indicating whether the codec uses hardware acceleration. /// format is null /// - /// codecType is invalid. - /// -or- - /// format is neither audio type or video type. + /// is invalid.\n + /// -or-\n + /// is neither audio type nor video type. /// /// the mime type of the format is not supported. /// diff --git a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs index 34da665..2aaf82e 100644 --- a/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs +++ b/src/Tizen.Multimedia.MediaCodec/MediaCodec/MediaCodecType.cs @@ -27,6 +27,9 @@ namespace Tizen.Multimedia.MediaCodec /// /// Specifies types of codec. + /// + /// This enumeration has a attribute that allows a bitwise combination of its member values. + /// /// [Flags] public enum MediaCodecTypes diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs index 1c30ded..ee0493e 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/AudioEffect.cs @@ -61,11 +61,11 @@ namespace Tizen.Multimedia /// /// Gets a at the specified index. /// - /// The index of the band to get + /// The index of the band to get. /// The has already been disposed of. /// - /// index is less than zero. - /// -or- + /// index is less than zero.\n + /// -or-\n /// index is equal to or greater than . /// public EqualizerBand this[int index] diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs b/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs index c496863..d56dce6 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/DownloadProgress.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia public struct DownloadProgress { /// - /// Initialize a new instance of the DownloadProgress struct. + /// Initializes a new instance of the DownloadProgress struct. /// /// The position that downloading started in percentage. /// The position indicating the current downloading progress in percentage. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs index e4ecec7..f826ad4 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/EqualizerBand.cs @@ -56,8 +56,8 @@ namespace Tizen.Multimedia /// The value indicating new gain in decibel(dB). /// The player that this EqualizerBand belongs to has already been disposed of. /// - /// value is less than . - /// -or- + /// value is less than .\n + /// -or-\n /// value is greater than . /// public void SetLevel(int value) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs index 8ab2397..2fa4cd6 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaBufferSource.cs @@ -35,9 +35,9 @@ namespace Tizen.Multimedia /// /// The value indicating the size of the buffer. /// - /// length is zero. - /// -or- - /// length is less than zero. + /// is zero.\n + /// -or-\n + /// is less than zero. /// public MediaBufferSource(int length) { @@ -59,6 +59,7 @@ namespace Tizen.Multimedia { } + //TODO remove default parameter. /// /// Initialize a new instance of the MediaBufferSource class from the buffer /// with the specified length and the specified offset. @@ -68,11 +69,11 @@ namespace Tizen.Multimedia /// The value indicating the offset in the buffer of the first byte to copy. /// buffer is null. /// - /// offset is less than zero. - /// -or- - /// length is equal to or less than zero. - /// -or- - /// offset+length is greater than buffer.Length. + /// is less than zero.\n + /// -or-\n + /// is equal to or less than zero.\n + /// -or-\n + /// + is greater than buffer.Length. /// public MediaBufferSource(byte[] buffer, int length, int offset = 0) { diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs index 321d6cf..15d8e7a 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamBufferStatusChangedEventArgs.cs @@ -24,7 +24,7 @@ namespace Tizen.Multimedia public class MediaStreamBufferStatusChangedEventArgs : EventArgs { /// - /// Initialize a new instance of the MediaStreamBufferStatusChangedEventArgs class. + /// Initializes a new instance of the MediaStreamBufferStatusChangedEventArgs class. /// /// The value indicating the status of the stream. public MediaStreamBufferStatusChangedEventArgs(MediaStreamBufferStatus status) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs index 6bad4ec..e962250 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSeekingOccurredEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia public class MediaStreamSeekingOccurredEventArgs : EventArgs { /// - /// Initialize a new instance of the MediaStreamSeekingOccurredEventArgs class. + /// Initializes a new instance of the MediaStreamSeekingOccurredEventArgs class. /// /// The value indicating the new position to seek. public MediaStreamSeekingOccurredEventArgs(ulong offset) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs index 1c279f0..45946be 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaStreamSource.cs @@ -27,12 +27,14 @@ namespace Tizen.Multimedia /// /// The source must be set as a source to a player before pushing. /// - // TODO is this name appropriate? public sealed class MediaStreamSource : MediaSource { private readonly MediaFormat _audioMediaFormat; private readonly MediaFormat _videoMediaFormat; + /// + /// Gets all supported audio types. + /// public static IEnumerable SupportedAudioTypes { get @@ -41,6 +43,9 @@ namespace Tizen.Multimedia } } + /// + /// Gets all supported video types. + /// public static IEnumerable SupportedVideoTypes { get @@ -91,11 +96,11 @@ namespace Tizen.Multimedia /// The for this source. /// The for this source. /// AAC and H.264 are supported. - /// both and are null. + /// Both and are null. /// - /// is not supported. - /// -or- - /// is not supported. + /// is not supported.\n + /// -or-\n + /// is not supported.\n /// /// /// @@ -168,15 +173,15 @@ namespace Tizen.Multimedia /// This source must be set as a source to a player and the player must be in the , or state. /// The to decode. /// - /// This source is not set as a source to a player. - /// -or- + /// This source is not set as a source to a player.\n + /// -or-\n /// The player is not in the valid state. /// /// packet is null. /// packet has been disposed. /// - /// is neither video nor audio type. - /// -or- + /// is neither video nor audio type.\n + /// -or-\n /// The format of packet is not matched with the specified format in the constructor. /// /// the internal buffer reaches limits. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs index c9a85e3..223a10e 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/MediaUriSource.cs @@ -32,7 +32,7 @@ namespace Tizen.Multimedia { // TODO consider using Uri class. /// - /// Initialize a new instance of the MediaUriSource class with the specified uri. + /// Initializes a new instance of the MediaUriSource class with the specified uri. /// The uri string. /// For HTTP or RSTP, uri should start with "http://" or "rtsp://". /// The default protocol is "file://". diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs index 03b87d1..8fe0082 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlaybackInterruptedEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia public class PlaybackInterruptedEventArgs : EventArgs { /// - /// Initialize a new instance of the PlaybackInterruptedEventArgs class. + /// Initializes a new instance of the PlaybackInterruptedEventArgs class. /// /// The enum value indicating the reason. public PlaybackInterruptedEventArgs(PlaybackInterruptionReason reason) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs index d5dfb3c..a740ebe 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/Player.cs @@ -283,9 +283,9 @@ namespace Tizen.Multimedia /// /// A that specifies the mode. The default is . /// - /// If the mode is , + /// If the mode is , /// audio output interval can be increased so, it can keep more audio data to play. - /// But, state transition like pause or resume can be more slower than default() mode. + /// But, state transition like pause or resume can be more slower than default(). /// /// The player has already been disposed of. /// The value is not valid. @@ -588,8 +588,8 @@ namespace Tizen.Multimedia /// /// The player must be in the or state. /// - /// The player is not streaming. - /// -or- + /// The player is not streaming.\n + /// -or-\n /// The player is not in the valid state. /// /// The player has already been disposed of. @@ -617,9 +617,9 @@ namespace Tizen.Multimedia /// Valid volume range is from 0 to 1.0, inclusive. /// The player has already been disposed of. /// - /// value is less than zero. - /// -or- - /// value is greater than 1.0. + /// is less than zero.\n + /// -or-\n + /// is greater than 1.0. /// public void SetVolume(float value) { @@ -711,7 +711,7 @@ namespace Tizen.Multimedia /// The player has already been disposed of. /// /// The player is not in the valid state.\n - /// - or -\n + /// -or-\n /// No subtitle is set. /// /// @@ -737,9 +737,6 @@ namespace Tizen.Multimedia NativePlayer.Prepare(Handle).ThrowIfFailed("Failed to prepare the player"); } - /// - /// Invoked when - /// protected virtual void OnPreparing() { RegisterCallbacks(); @@ -909,8 +906,8 @@ namespace Tizen.Multimedia /// The player must be in the state. /// The player has already been disposed of. /// - /// The player is not in the valid state. - /// -or- + /// The player is not in the valid state.\n + /// -or-\n /// It is not able to assign the source to the player. /// /// @@ -1060,15 +1057,15 @@ namespace Tizen.Multimedia /// /// The player has already been disposed of. /// - /// The player is not in the valid state. - /// -or- + /// The player is not in the valid state.\n + /// -or-\n /// Streaming playback. /// /// - /// is less than 5.0. - /// -or- - /// is greater than 5.0. - /// -or- + /// is less than 5.0.\n + /// -or-\n + /// is greater than 5.0.\n + /// -or-\n /// is zero. /// public void SetPlaybackRate(float rate) @@ -1091,8 +1088,8 @@ namespace Tizen.Multimedia /// The to apply. /// The player must be in the state. /// - /// The player has already been disposed of. - /// -or- + /// The player has already been disposed of.\n + /// -or-\n /// has already been disposed of. /// /// The player is not in the valid state. @@ -1183,7 +1180,7 @@ namespace Tizen.Multimedia private NativePlayer.VideoFrameDecodedCallback _videoFrameDecodedCallback; /// - /// Occurs when a video frame is decoded + /// Occurs when a video frame is decoded. /// /// /// The event handler will be executed on an internal thread. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs index 11e16ee..8b03b54 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerDisplaySettings.cs @@ -40,12 +40,12 @@ namespace Tizen.Multimedia private PlayerDisplayMode _displayMode = PlayerDisplayMode.LetterBox; /// - /// Set/Get Display mode. + /// Gets or sets the . /// /// - /// The display is not assigned. - /// -or- - /// Operation failed; internal error. + /// The display is not assigned.\n + /// -or-\n + /// Operation failed; internal error. /// /// The player already has been disposed of. /// The specified value to set is invalid. @@ -74,13 +74,13 @@ namespace Tizen.Multimedia private bool _isVisible = true; /// - /// + /// Gets or sets the value indicating whether the display is visible. /// /// /// - /// The display is not assigned. - /// -or- - /// Operation failed; internal error. + /// The display is not assigned.\n + /// -or-\n + /// Operation failed; internal error. /// /// The player already has been disposed of. public bool IsVisible @@ -106,13 +106,16 @@ namespace Tizen.Multimedia private PlayerDisplayRotation _rotation = PlayerDisplayRotation.RotationNone; /// - /// Set/Get Display rotation. + /// Gets or sets the rotation of the display. /// - /// RotationNone, Rotation90, Rotation180, Rotation270 + /// , + /// , + /// , + /// /// - /// The display is not assigned. - /// -or- - /// Operation failed; internal error. + /// The display is not assigned.\n + /// -or-\n + /// Operation failed; internal error. /// /// The player already has been disposed of. /// The specified value to set is invalid. @@ -145,11 +148,11 @@ namespace Tizen.Multimedia /// To set roi, must be set to first. /// /// - /// The display is not assigned. - /// -or- - /// Operation failed; internal error. - /// -or- - /// is not set to + /// The display is not assigned.\n + /// -or-\n + /// Operation failed; internal error.\n + /// -or-\n + /// is not set to /// /// The player already has been disposed of. /// width or height is less than or equal to zero. diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs index 7d1e9d2..142fdac 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerEnums.cs @@ -54,13 +54,13 @@ namespace Tizen.Multimedia /// /// Initial state, unprepared. /// - /// + /// Idle = 1, /// /// Prepared. /// - /// + /// Ready, /// @@ -221,6 +221,9 @@ namespace Tizen.Multimedia /// public enum PlaybackInterruptionReason { + /// + /// Interrupted by a resource conflict and the will be unprepared, automatically. + /// ResourceConflict = 4 } @@ -230,11 +233,34 @@ namespace Tizen.Multimedia /// public enum StreamMetadataKey { + /// + /// Album. + /// Album, + + /// + /// Artists. + /// Artist, + + /// + /// Author. + /// Author, + + /// + /// Genre. + /// Genre, + + /// + /// Title. + /// Title, + + /// + /// Year. + /// Year } } diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs index 30b7a06..6e72e95 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerErrorOccurredEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia public class PlayerErrorOccurredEventArgs : EventArgs { /// - /// Initialize a new instance of the PlayerErrorOccurredEventArgs class. + /// Initializes a new instance of the PlayerErrorOccurredEventArgs class. /// /// The value indicating what kind of error occurred. public PlayerErrorOccurredEventArgs(PlayerError error) diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs index 6388437..fb68e67 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/PlayerTrackInfo.cs @@ -68,9 +68,9 @@ namespace Tizen.Multimedia /// The that this instance belongs to has been disposed. /// The that this instance belongs to is not in the valid state. /// - /// index is less than zero. - /// -or- - /// index is equal to or greater than + /// is less than zero.\n + /// -or-\n + /// is equal to or greater than /// public string GetLanguageCode(int index) { @@ -133,9 +133,9 @@ namespace Tizen.Multimedia /// The that this instance belongs to has been disposed. /// The that this instance belongs to is not in the valid state. /// - /// index is less than zero. - /// -or- - /// index is equal to or greater than + /// is less than zero.\n + /// -or-\n + /// is equal to or greater than /// public void SetSelected(int index) { diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs b/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs index 092df0f..7826f88 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/StreamInfo.cs @@ -82,7 +82,7 @@ namespace Tizen.Multimedia BitRate = bitRate; Size = size; Log.Debug(PlayerLog.Tag, "fps : " + fps + ", bitrate : " + bitRate + - ", width : " + size.Width + ", height : "+ size.Height); + ", width : " + size.Width + ", height : " + size.Height); } /// /// Initialize a new instance of the VideoStreamProperties struct with the specified fps, bit rate, width and height. @@ -128,9 +128,8 @@ namespace Tizen.Multimedia } } - /// - /// Provides means to retrieve stream information + /// Provides means to retrieve stream information. /// public class StreamInfo { @@ -149,9 +148,7 @@ namespace Tizen.Multimedia { Player.ValidatePlayerState(PlayerState.Ready, PlayerState.Playing, PlayerState.Paused); - int size; - IntPtr art; - NativePlayer.GetAlbumArt(Player.Handle, out art, out size). + NativePlayer.GetAlbumArt(Player.Handle, out var art, out var size). ThrowIfFailed("Failed to get the album art"); if (art == IntPtr.Zero || size == 0) @@ -210,7 +207,6 @@ namespace Tizen.Multimedia return GetCodecInfo(false); } - /// /// Gets the duration. /// diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs index d37ae43..0f1bee8 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/SubtitleUpdatedEventArgs.cs @@ -29,14 +29,13 @@ namespace Tizen.Multimedia } /// - /// Gets the he duration of the updated subtitle. + /// Gets the duration of the updated subtitle. /// public uint Duration { get; } /// /// Gets the text of the updated subtitle. /// - /// string public string Text { get; } public override string ToString() diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs index a68e130..daa545d 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoFrameDecodedEventArgs.cs @@ -23,7 +23,7 @@ namespace Tizen.Multimedia public class VideoFrameDecodedEventArgs : EventArgs { /// - /// Initialize a new instance of the VideoFrameDecodedEventArgs class. + /// Initializes a new instance of the VideoFrameDecodedEventArgs class. /// internal VideoFrameDecodedEventArgs(MediaPacket packet) { diff --git a/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs b/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs index db7312f..ea54f34 100644 --- a/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs +++ b/src/Tizen.Multimedia.MediaPlayer/Player/VideoStreamChangedEventArgs.cs @@ -27,7 +27,7 @@ namespace Tizen.Multimedia { /// - /// Initialize a new instance of the VideoStreamChangedEventArgs class. + /// Initializes a new instance of the VideoStreamChangedEventArgs class. /// internal VideoStreamChangedEventArgs(int height, int width, int fps, int bitRate) { diff --git a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs index ea67a8f..d27d196 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataEditor/MetadataEditor.cs @@ -53,13 +53,12 @@ namespace Tizen.Multimedia } /// - /// Metadata extractor constructor + /// Initializes a new instance of the class with the specified path. /// /// The path of the media file to edit metadata /// is null. - /// Memory allocation failed. - /// Unsupported file type - /// File not exist + /// The file is unsupported format. + /// The file does not exist. public MetadataEditor(string path) { if (path == null) @@ -371,11 +370,11 @@ namespace Tizen.Multimedia } /// - /// Append the picture to the media file + /// Appends the picture to the media file. /// - /// The path of picture for adding to the metadata - /// When internal process error is occured - /// Picture path is null + /// The path of picture for adding to the metadata. + /// Internal error occurs. + /// is null. public void AddPicture(string path) { if (path == null) @@ -388,7 +387,7 @@ namespace Tizen.Multimedia } /// - /// Remove the picture from the media file + /// Removes the picture from the media file. /// /// Index of picture to remove /// When internal process error is occured diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs index de79fd9..4dba9cf 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Artwork.cs @@ -22,7 +22,7 @@ namespace Tizen.Multimedia public class Artwork { /// - /// Initialize a new instance of the Artwork class with the specified data and mimeType. + /// Initializes a new instance of the Artwork class with the specified data and mimeType. /// /// The data of the artwork to set metadata. /// The mime type of the data of the artwork. diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs index 977e84c..c9eb9f8 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/Metadata.cs @@ -152,7 +152,7 @@ namespace Tizen.Multimedia public string StreamCount { get; } /// - /// Audio codec type + /// Gets the audio codec type. /// public string Codec { get; } diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs index c5bcdbb..2c0dc00 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/MetadataExtractor.cs @@ -52,7 +52,7 @@ namespace Tizen.Multimedia } /// - /// Initialize a new instance of the MetadataExtractor class with the specified path. + /// Initializes a new instance of the MetadataExtractor class with the specified path. /// /// The path for the file to extract metadata. /// is null. @@ -68,7 +68,7 @@ namespace Tizen.Multimedia } /// - /// Initialize a new instance of the MetadataExtractor class with the specified buffer. + /// Initializes a new instance of the MetadataExtractor class with the specified buffer. /// /// The buffer to extract metadata. /// is null. @@ -117,7 +117,7 @@ namespace Tizen.Multimedia /// /// Retrieves the . /// - /// A for the give source. + /// A for the given source. /// Internal process error is occurred. /// The has been already disposed of. public Metadata GetMetadata() diff --git a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs index d5c971d..7d9b68f 100644 --- a/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs +++ b/src/Tizen.Multimedia.Metadata/MetadataExtractor/SyncLyrics.cs @@ -33,12 +33,12 @@ namespace Tizen.Multimedia } /// - /// The lyrics of the index + /// The text representation of the lyrics. /// public string Lyrics { get; } /// - /// The time information of the index + /// The time information of the lyrics. /// public uint Timestamp { get; } } diff --git a/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailData.cs b/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailData.cs index 80e39c5..1a01ecb 100644 --- a/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailData.cs +++ b/src/Tizen.Multimedia.Util/ThumbnailExtractor/ThumbnailData.cs @@ -29,17 +29,17 @@ namespace Tizen.Multimedia Height = height; } /// - /// The thumbnail data + /// The thumbnail data. /// public byte[] Thumbnail { get; } /// - /// The width of the thumbnail + /// The width of the thumbnail. /// public int Width { get; } /// - /// The height of the thumbnail + /// The height of the thumbnail. /// public int Height { get; } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs index 3de3b18..2482c62 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetectionTarget.cs @@ -22,17 +22,17 @@ namespace Tizen.Multimedia public enum BarcodeDetectionTarget { /// - /// 1D and 2D + /// 1D and 2D. /// All, /// - /// 1D barcode only + /// 1D barcode only. /// Barcode1D, /// - /// 2D barcode only + /// 2D barcode only. /// Barcode2D, } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs index 8430537..ff41fd1 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeDetector.cs @@ -56,7 +56,7 @@ namespace Tizen.Multimedia /// The feature is not supported. /// /// already has been disposed of.\n - /// - or -\n + /// -or-\n /// already has been disposed of. /// /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs index 6ccbbb4..aa417c2 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerationConfiguration.cs @@ -57,7 +57,7 @@ namespace Tizen.Multimedia private Color _foregroundColor = Color.Black; /// - /// Sets or gets the foreground color of the barcode to be generated. + /// Gets or sets the foreground color of the barcode to be generated. /// /// /// The alpha value of the color will be ignored. @@ -79,7 +79,7 @@ namespace Tizen.Multimedia private Color _backgroundColor = Color.White; /// - /// Sets or gets the background color of the barcode to be generated. + /// Gets or sets the background color of the barcode to be generated. /// /// /// The alpha value of the color will be ignored. diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs index cec752b..2c200a3 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeGenerator.cs @@ -63,12 +63,12 @@ namespace Tizen.Multimedia /// containing the generated QR image. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// is too long.\n - /// - or -\n + /// -or-\n /// contains characters which are illegal by the . /// /// The feature is not supported. @@ -91,17 +91,17 @@ namespace Tizen.Multimedia /// /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// is too long.\n - /// - or -\n + /// -or-\n /// contains characters which are illegal by the . /// /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// is the . /// /// already has been disposed of. @@ -135,11 +135,11 @@ namespace Tizen.Multimedia /// is null. /// /// is too long.\n - /// - or -\n + /// -or-\n /// is .\n - /// - or -\n + /// -or-\n /// is invalid. - /// - or -\n + /// -or-\n /// contains illegal characters. /// /// The feature is not supported. @@ -158,11 +158,11 @@ namespace Tizen.Multimedia /// is null. /// /// is too long.\n - /// - or -\n + /// -or-\n /// is . - /// - or -\n + /// -or-\n /// is invalid. - /// - or -\n + /// -or-\n /// contains illegal characters. /// /// The feature is not supported. @@ -212,14 +212,14 @@ namespace Tizen.Multimedia /// The that contains information about the file to be generated. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// is too long.\n - /// - or -\n + /// -or-\n /// contains characters which are illegal by the . /// /// No permission to write a file. @@ -245,20 +245,20 @@ namespace Tizen.Multimedia /// The configuration of the barcode generator. This value can be null. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// is too long.\n - /// - or -\n + /// -or-\n /// contains characters which are illegal by the . /// /// No permission to write a file. /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// is the . /// /// already has been disposed of. @@ -291,16 +291,16 @@ namespace Tizen.Multimedia /// information about the file to be generated. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// is too long.\n - /// - or -\n + /// -or-\n /// is . - /// - or -\n + /// -or-\n /// is invalid. - /// - or -\n + /// -or-\n /// contains illegal characters. /// /// No permission to write a file. @@ -320,16 +320,16 @@ namespace Tizen.Multimedia /// The configuration of the barcode generator. This value can be null. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// is too long.\n - /// - or -\n + /// -or-\n /// is . - /// - or -\n + /// -or-\n /// is invalid. - /// - or -\n + /// -or-\n /// contains illegal characters. /// /// No permission to write a file. diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs index be055ee..182aa29 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageConfiguration.cs @@ -35,7 +35,7 @@ namespace Tizen.Multimedia /// The format of the output image. /// /// The width of is less than or equal to zero.\n - /// - or -\n + /// -or-\n /// The height of is less than or equal to zero. /// /// is null. @@ -82,7 +82,7 @@ namespace Tizen.Multimedia /// The format of the output image. /// /// is less than or equal to zero.\n - /// - or -\n + /// -or-\n /// is less than or equal to zero. /// /// is null. @@ -111,7 +111,7 @@ namespace Tizen.Multimedia public int Height => Size.Height; /// - /// Gets the path to the file that has to be generated + /// Gets the path to the file that has to be generated. /// /// /// The mediastorage privilege http://tizen.org/privilege/mediastorage is needed if image path is relevant to media storage.\n @@ -120,7 +120,7 @@ namespace Tizen.Multimedia public string Path { get; } /// - /// Gets the format of the output image + /// Gets the format of the output image. /// public BarcodeImageFormat Format { get; } } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs index f1cf187..21a0846 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/BarcodeImageFormat.cs @@ -23,15 +23,15 @@ namespace Tizen.Multimedia public enum BarcodeImageFormat { /// - /// BMP image format + /// BMP image format. /// Bmp, /// - /// JPEG image format + /// JPEG image format. /// Jpeg, /// - /// PNG image format + /// PNG image format. /// Png } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs index fedb11a..1a8b6ce 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetectionConfiguration.cs @@ -40,7 +40,7 @@ namespace Tizen.Multimedia } /// - /// Sets or gets the face detection haarcascade xml file for face detection. + /// Gets or sets the face detection haarcascade xml file for face detection. /// /// is null. public string ModelFilePath @@ -119,18 +119,18 @@ namespace Tizen.Multimedia private Rectangle? _roi; /// - /// Sets or gets the roi of the face detection. + /// Gets or sets the roi of the face detection. /// /// /// Default value is null (the roi will be a full image) can be changed to specify the roi for face detection. /// /// /// The width of is less than or equal to zero.\n - /// - or -\n + /// -or-\n /// The height of is less than or equal to zero.\n - /// - or -\n + /// -or-\n /// The x position of is lsss than zero.\n - /// - or -\n + /// -or-\n /// The y position of is lsss than zero.\n /// public Rectangle? Roi diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs index c04167e..64a7ef7 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceDetector.cs @@ -35,7 +35,7 @@ namespace Tizen.Multimedia /// is null. /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// The format of is not supported. /// public static async Task DetectAsync(MediaVisionSource source) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs index d482245..759fb7b 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionModel.cs @@ -49,7 +49,7 @@ namespace Tizen.Multimedia /// is invalid. /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// is not supported format. /// /// No permission to access the specified file. @@ -142,11 +142,11 @@ namespace Tizen.Multimedia /// The that contains face image. /// The label that identifies face for which example is adding. /// Specify the same labels for the face images of a single person when calling this method. - /// Has to be unique for each face + /// Has to be unique for each face. /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been dispose of. /// /// @@ -166,12 +166,12 @@ namespace Tizen.Multimedia /// The that contains face image. /// The label that identifies face for which example is adding. /// Specify the same labels for the face images of a single person when calling this method. - /// Has to be unique for each face + /// Has to be unique for each face. /// The rectangular region of the face image at the source image. /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been dispose of. /// /// @@ -246,7 +246,7 @@ namespace Tizen.Multimedia /// The configuration used for learning of the recognition models. This value can be null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// No examples added. diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs index b3af289..3a58bde 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognitionResult.cs @@ -45,7 +45,7 @@ namespace Tizen.Multimedia public Rectangle? Area { get; } /// - /// The confidence of the recognition_model that face has been recognized correctly (value from 0.0 to 1.0). + /// The confidence of the recognition model that face has been recognized correctly (value from 0.0 to 1.0). /// No faces were recognized if confidence was 0.0. When model has been learned on large amount of examples, /// threshold for this value can be high (0.85-0.95). If model was learned for small amount of examples, /// then threshold can be reduced (0.5-0.85). diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs index d00ffb3..3595f0e 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceRecognizer.cs @@ -35,7 +35,7 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous recognition operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// The feature is not supported. @@ -56,7 +56,7 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous recognition operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// The feature is not supported. @@ -77,13 +77,13 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous recognition operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// The feature is not supported. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// is untrained model. @@ -105,13 +105,13 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous recognition operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// The feature is not supported. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// is untrained model. @@ -222,7 +222,7 @@ namespace Tizen.Multimedia /// is null. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// The feature is not supported. @@ -280,7 +280,7 @@ namespace Tizen.Multimedia /// is null. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// The feature is not supported. diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs index e83a932..2dbb541 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTracker.cs @@ -34,16 +34,16 @@ namespace Tizen.Multimedia /// The model will be used for tracking. /// The value indicating whether model learning while tracking. If it is true then model will try to learn /// (if it supports learning feature), otherwise model will be not learned during the invoking tracking iteration. - /// Learning process improves tracking correctness, but can decrease tracking performance + /// Learning process improves tracking correctness, but can decrease tracking performance. /// A task that represents the asynchronous tracking operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// The feature is not supported. diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs index 07816cc..aa5bc8d 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingModel.cs @@ -48,7 +48,7 @@ namespace Tizen.Multimedia /// is invalid. /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// is not supported format. /// /// No permission to access the specified file. @@ -98,7 +98,7 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already bean disposed of. /// public void Prepare(MediaVisionSource source, Quadrangle region) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs index f7b4a74..bffb513 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/FaceTrackingResult.cs @@ -39,7 +39,7 @@ namespace Tizen.Multimedia public Quadrangle Region { get; } /// - /// The confidence of the tracking_model that new location of the face was determined correctly + /// The confidence of the tracking model that new location of the face was determined correctly /// (value from 0.0 to 1.0). If no location was determined during last track iteration, then value is 0.0. /// public double Confidence { get; } diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs index d66effc..998f55d 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageObject.cs @@ -48,7 +48,7 @@ namespace Tizen.Multimedia /// is invalid. /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// is not supported file. /// /// No permission to access the specified file. @@ -80,13 +80,15 @@ namespace Tizen.Multimedia /// /// The has already been disposed of. /// - /// + /// + /// + /// + /// public double RecognitionRate { get { - double rate = 0; - InteropImage.GetRecognitionRate(Handle, out rate).Validate("Failed to get recognition rate"); + InteropImage.GetRecognitionRate(Handle, out var rate).Validate("Failed to get recognition rate"); return rate; } } @@ -96,14 +98,13 @@ namespace Tizen.Multimedia /// Gets the label for the image object. /// /// - /// The label value; or null if the has no label. + /// The label value if the has label, otherwise null. /// /// The has already been disposed of. /// public int? GetLabel() { - int label = 0; - var ret = InteropImage.GetLabel(Handle, out label); + var ret = InteropImage.GetLabel(Handle, out var label); if (ret == MediaVisionError.NoData) { @@ -131,7 +132,7 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// public void Fill(MediaVisionSource source) @@ -148,9 +149,9 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// public void Fill(MediaVisionSource source, ImageFillConfiguration config) @@ -167,7 +168,7 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of.\n /// public void Fill(MediaVisionSource source, Rectangle rect) @@ -185,9 +186,9 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// public void Fill(MediaVisionSource source, ImageFillConfiguration config, Rectangle rect) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs index e75cf6c..9f4c85f 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognitionConfiguration.cs @@ -149,7 +149,7 @@ namespace Tizen.Multimedia /// The already has been disposed of. /// /// is less than zero.\n - /// - or -\n + /// -or-\n /// is greater than one. /// public double RequiredMatchingPart @@ -179,7 +179,7 @@ namespace Tizen.Multimedia /// The already has been disposed of. /// /// is less than zero.\n - /// - or -\n + /// -or-\n /// is greater than one. /// public double TolerantPartMatchError diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs index 169da6a..aa0954a 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageRecognizer.cs @@ -34,9 +34,9 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous recognition operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null.\n - /// - or -\n + /// -or-\n /// contains null reference. /// /// has no elements.(The length is zero.) @@ -57,16 +57,16 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous recognition operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null.\n - /// - or -\n + /// -or-\n /// contains null elements. /// /// has no elements.(The length is zero.) /// The feature is not supported. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// public static async Task> RecognizeAsync(MediaVisionSource source, diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs index 01c22c3..4127b26 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTracker.cs @@ -34,13 +34,13 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous tracking operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// The feature is not supported. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// has no target. @@ -60,15 +60,15 @@ namespace Tizen.Multimedia /// A task that represents the asynchronous tracking operation. /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// The feature is not supported. /// /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// has no target. diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs index 50b3b7f..587cbe5 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingConfiguration.cs @@ -99,7 +99,7 @@ namespace Tizen.Multimedia /// /// /// Relative offset value, for which the object offset is expected (relative to the object size in the current frame).\n - /// the default is 0. + /// The default is 0. /// /// The already has been disposed of. public double ExpectedOffset @@ -125,7 +125,7 @@ namespace Tizen.Multimedia /// The already has been disposed of. /// /// is less than zero.\n - /// - or -\n + /// -or-\n /// is greater than one. /// public double StabilizationAccelaration @@ -171,8 +171,8 @@ namespace Tizen.Multimedia /// /// 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 - value set to MV_IMAGE_TRACKING_STABLIZATION_TOLERANT_SHIFT, - /// S - area of object location on frame, C - constant value equal 1.3.\n + /// Tolerant shift will be computed like R * S + C, where R is the value set to , + /// S is the area of object location on frame, C is a constant value 1.3.\n /// \n /// The default is 0.00006. /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs index 6b9c1e9..d1c1bd5 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/ImageTrackingModel.cs @@ -48,7 +48,7 @@ namespace Tizen.Multimedia /// is invalid. /// /// The feature is not supported.\n - /// - or -\n + /// -or-\n /// is not supported format. /// /// No permission to access the specified file. @@ -75,7 +75,7 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// public void SetTarget(ImageObject imageObject) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs index a0581c0..aa7d285 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MediaVisionSource.cs @@ -109,7 +109,7 @@ namespace Tizen.Multimedia /// is null. /// /// has no element.(The length is zero.)\n - /// - or -\n + /// -or-\n /// is invalid. /// public MediaVisionSource(byte[] buffer, uint width, uint height, Colorspace colorspace) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs index bb7db95..6292394 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetectionConfiguration.cs @@ -19,14 +19,14 @@ using System; namespace Tizen.Multimedia { /// - /// Represents concrete EngineConfig for creation of video surveillance systems. + /// Represents a configuration of . /// public class MovementDetectionConfiguration : SurveillanceEngineConfiguration { private const string KeyThreshold = "MV_SURVEILLANCE_MOVEMENT_DETECTION_THRESHOLD"; /// - /// Represents a configuration of . + /// A read-only field that represents the default value of . /// public static readonly int DefaultThreshold = 10; @@ -53,7 +53,7 @@ namespace Tizen.Multimedia /// The already has been disposed of. /// /// is less than zero.\n - /// - or -\n + /// -or-\n /// is greater than 255. /// public int Threshold diff --git a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs index d03072c..cd9994b 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/MovementDetector.cs @@ -100,7 +100,7 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs index 51fbd22..3599383 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonAppearanceDetector.cs @@ -105,7 +105,7 @@ namespace Tizen.Multimedia /// is null. /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs index f6cd077..da4a82d 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/PersonRecognizer.cs @@ -96,12 +96,12 @@ namespace Tizen.Multimedia /// The config for the . /// /// is null.\n - /// - or -\n + /// -or-\n /// is null. /// /// /// The has already been disposed of.\n - /// - or -\n + /// -or-\n /// has already been disposed of. /// /// diff --git a/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs b/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs index 817dedb..fdcf571 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/QrConfiguration.cs @@ -34,12 +34,12 @@ namespace Tizen.Multimedia /// /// /// is less than 1.\n - /// - or -\n + /// -or-\n /// is greater than 40. /// /// /// is invalid.\n - /// - or - + /// -or- /// is invalid. /// public QrConfiguration(QrMode qrMode, ErrorCorrectionLevel ecc, int version) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs index ec0e562..4e2bd61 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/Quadrangle.cs @@ -23,10 +23,11 @@ namespace Tizen.Multimedia /// public class Quadrangle { + /// - /// The constructor of the Quadrangle class + /// Initialize a new instance of the class with an array of . /// - /// must have 4 elements + /// must have 4 elements. /// four points that define object bounding quadrangle. /// The Length of is not 4. public Quadrangle(Point[] points) diff --git a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs index 47b189f..a71d382 100644 --- a/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs +++ b/src/Tizen.Multimedia.Vision/MediaVision/SurveillanceEngine.cs @@ -59,7 +59,7 @@ namespace Tizen.Multimedia } /// - /// Sets and gets ROI (Region Of Interest) to the event trigger + /// Sets and gets ROI (Region Of Interest). /// /// The has already been disposed of. public Point[] Roi diff --git a/src/Tizen.Multimedia/Common/Display.cs b/src/Tizen.Multimedia/Common/Display.cs index e093386..8c77d94 100644 --- a/src/Tizen.Multimedia/Common/Display.cs +++ b/src/Tizen.Multimedia/Common/Display.cs @@ -66,7 +66,7 @@ namespace Tizen.Multimedia } /// - /// Initialize a new instance of the class with a class. + /// Initializes a new instance of the class with a class. /// /// http://tizen.org/feature/multimedia.raw_video /// The required feature is not supported. @@ -76,7 +76,7 @@ namespace Tizen.Multimedia } /// - /// Initialize a new instance of the class with a class. + /// Initializes a new instance of the class with a class. /// public Display(Window window) : this(DisplayType.Overlay, window) { diff --git a/src/Tizen.Multimedia/Common/IMediaBuffer.cs b/src/Tizen.Multimedia/Common/IMediaBuffer.cs index ddca032..f1f3f72 100644 --- a/src/Tizen.Multimedia/Common/IMediaBuffer.cs +++ b/src/Tizen.Multimedia/Common/IMediaBuffer.cs @@ -20,6 +20,9 @@ using System.Runtime.InteropServices; namespace Tizen.Multimedia { + /// + /// Provides functionality to read a media buffer. + /// public interface IReadOnlyBuffer { /// @@ -27,8 +30,8 @@ namespace Tizen.Multimedia /// /// The index of the value to get or set. /// - /// index is less than zero. - /// -or- + /// index is less than zero.\n + /// -or-\n /// index is equal to or greater than . /// /// The object that owns the current buffer already has been disposed of. @@ -49,7 +52,7 @@ namespace Tizen.Multimedia /// /// Copies data from a byte array to the buffer. /// - /// The array to copy from. + /// The array to copy to. /// The zero-based index in the source array where copying should start. /// The number of array elements to copy. /// startIndex or length is not valid. @@ -59,7 +62,7 @@ namespace Tizen.Multimedia /// /// Copies data from a byte array to the buffer. /// - /// The array to copy from. + /// The array to copy to. /// The zero-based index in the source array where copying should start. /// The number of array elements to copy. /// The zero-based index in the buffer where copying should start. @@ -68,12 +71,15 @@ namespace Tizen.Multimedia void CopyTo(byte[] dest, int startIndex, int length, int offset); } + /// + /// Provides functionality to read and write a media buffer. + /// public interface IMediaBuffer : IReadOnlyBuffer { /// /// Copies data from the buffer to a byte array. /// - /// The array to copy to. + /// The array to copy from. /// The zero-based index in the dest array where copying should start. /// The number of elements to copy. /// startIndex or length is not valid. @@ -85,7 +91,7 @@ namespace Tizen.Multimedia /// /// Copies data from the buffer to a byte array. /// - /// The array to copy to. + /// The array to copy from. /// The zero-based index in the dest array where copying should start. /// The number of elements to copy. /// The zero-based index in the buffer where copying should start. @@ -142,8 +148,8 @@ namespace Tizen.Multimedia /// /// /// - /// offset + length is greater than . - /// -or- + /// offset + length is greater than .\n + /// -or-\n /// offset or length is less than zero. /// private void ValidateRange(int offset, int length) diff --git a/src/Tizen.Multimedia/Common/Visibility.cs b/src/Tizen.Multimedia/Common/Visibility.cs index 11d19c6..97e6d07 100644 --- a/src/Tizen.Multimedia/Common/Visibility.cs +++ b/src/Tizen.Multimedia/Common/Visibility.cs @@ -17,16 +17,16 @@ namespace Tizen.Multimedia { /// - /// Enumeration to text attribute + /// Specifies visibilities. /// public enum Visibility { /// - /// Invisible + /// Invisible. /// Invisible, /// - /// Visible + /// Visible. /// Visible } diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormat.cs b/src/Tizen.Multimedia/MediaTool/MediaFormat.cs index d4225cd..5a2092b 100755 --- a/src/Tizen.Multimedia/MediaTool/MediaFormat.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaFormat.cs @@ -210,7 +210,7 @@ namespace Tizen.Multimedia } /// - /// Initializes a new instance of the VideoMediaFormat class with the specified mime type, width and height. + /// Initializes a new instance of the VideoMediaFormat class with the specified mime type and size. /// /// The mime type of the format. /// The size of the format. @@ -271,7 +271,7 @@ namespace Tizen.Multimedia /// /// Initializes a new instance of the VideoMediaFormat class with the specified mime type, - /// width, height, frame rate and bit rate. + /// size, frame rate and bit rate. /// /// The mime type of the format. /// The size of the format. @@ -454,9 +454,10 @@ namespace Tizen.Multimedia /// The sample rate value of the format. /// The bit value of the format. /// The bit rate value of the format. - /// mimeType is invalid(i.e. undefined value). + /// is invalid(i.e. undefined value). /// - /// channel, sampleRate, bit or bitRate is less than zero. + /// , , or is less than zero. + /// public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate) : this(mimeType, channel, sampleRate, bit, bitRate, MediaFormatAacType.None) @@ -474,12 +475,13 @@ namespace Tizen.Multimedia /// The bit rate value of the format. /// The AAC bitstream format(ADIF or ADTS). /// - /// mimeType or aacType is invalid(i.e. undefined value). - /// - or - - /// aacType is not , but mimeType is one of aac types. + /// or is invalid(i.e. undefined value).\n + /// -or-\n + /// is not , but is one of aac types. /// /// - /// channel, sampleRate, bit or bitRate is less than zero. + /// , , or is less than zero. + /// public AudioMediaFormat(MediaFormatAudioMimeType mimeType, int channel, int sampleRate, int bit, int bitRate, MediaFormatAacType aacType) : base(MediaFormatType.Audio) diff --git a/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs b/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs index 4008484..55196a4 100755 --- a/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaFormatMimeType.cs @@ -65,21 +65,6 @@ namespace Tizen.Multimedia public enum MediaFormatAudioMimeType { /// - /// L16, Audio. - /// . - //L16 = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1010), - - /// - /// ALAW, Audio. - /// - //ALaw = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1020), - - /// - /// ULAW, Audio. - /// - //ULaw = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1030), - - /// /// AMR, Alias for . /// Amr = (MediaFormatType.Audio | MediaFormatDataType.Encoded | 0x1040), @@ -158,56 +143,6 @@ namespace Tizen.Multimedia /// PCM. /// Pcm = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1510), - - /// - /// PCM signed 16-bit little-endian, Audio - /// - //PcmS16LE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1510), - - /// - /// PCM signed 24-bit little-endian, Audio - /// - //PcmS24LE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1511), - - /// - /// PCM signed 32-bit little-endian, Audio - /// - //Pcm32LE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1512), - - /// - /// PCM signed 16-bit big-endian, Audio - /// - //PcmS16BE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1513), - - /// - /// PCM signed 24-bit big-endian, Audio - /// - //PcmS24BE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1514), - - /// - /// PCM signed 32-bit big-endian, Audio - /// - //PcmS32BE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1515), - - /// - /// PCM 32-bit floating point little-endian, Audio - /// - //PcmF32LE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1516), - - /// - /// PCM 32-bit floating point big-endian, Audio - /// - //PcmF32BE = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1517), - - /// - /// PCM A-law, Audio - /// - //PcmALaw = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1520), - - /// - /// PCM U-law, Audio - /// - //PcmULaw = (MediaFormatType.Audio | MediaFormatDataType.Raw | 0x1530), } /// @@ -231,52 +166,7 @@ namespace Tizen.Multimedia H263P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2021), /// - /// H263 Baseline Profile - /// - //H263BP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2022), - - /// - /// H263 H.320 Coding Efficiency Profile - /// - //H263H320Cep = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2023), - - /// - /// H263 Backward-Compatibility Profile - /// - //H263Bcp = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2024), - - /// - /// H263 Interactive and Streaming Wireless Profile - /// - //H263Isw2p = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2025), - - /// - /// H263 Interactive and Streaming Wireless Profile - /// - //H263Isw3p = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2026), - - /// - /// H263 Conversation High Compression Profile - /// - //H263Chcp = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2027), - - /// - /// H263 Conversational Internet Profile - /// - //H263CInternetP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2028), - - /// - /// H263 Conversational Interlace Profile - /// - //H263CInterlaceP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2029), - - /// - /// H263 High Latency Profile - /// - //H263Hlp = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x202A), - - /// - /// H264_SP. + /// H264_SP /// H264SP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2030), @@ -291,32 +181,7 @@ namespace Tizen.Multimedia H264HP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2032), /// - /// H264 Extended Profile - /// - //H264XP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2033), - - /// - /// H264 High10 Profile - /// - //H264H10P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2034), - - /// - /// H264 High422 Profile - /// - //H264H422P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2035), - - /// - /// H264 High444 Profile - /// - //H264H444P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2036), - - /// - /// H264 CAVLC444 Profile - /// - //H264C444P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2037), - - /// - /// MJPEG. + /// MJPEG /// MJpeg = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2040), @@ -351,37 +216,7 @@ namespace Tizen.Multimedia Mpeg4Asp = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2071), /// - /// HEVC - /// - //Hevc = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2080), - - /// - /// HEVC Main Profile - /// - //HevcMP = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2081), - - /// - /// HEVC Main10 Profile - /// - //HevcM10P = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2082), - - /// - /// VP8 - /// - //VP8 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x2090), - - /// - /// VP9 - /// - //VP9 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x20A0), - - /// - /// VC1 - /// - //VC1 = (MediaFormatType.Video | MediaFormatDataType.Encoded | 0x20B0), - - /// - /// I420. + /// I420 /// I420 = (MediaFormatType.Video | MediaFormatDataType.Raw | 0x2510), diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacket.cs b/src/Tizen.Multimedia/MediaTool/MediaPacket.cs index 8705e40..ffecc12 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacket.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacket.cs @@ -282,8 +282,8 @@ namespace Tizen.Multimedia /// /// The value specified for this property is less than zero or greater than . /// - /// The MediaPacket has instead of . - /// -or- + /// The MediaPacket has instead of .\n + /// -or-\n /// The MediaPacket is not in writable state which means it being used by another module. /// public int BufferWrittenLength diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacketBuffer.cs b/src/Tizen.Multimedia/MediaTool/MediaPacketBuffer.cs index d85c0d8..49b9caf 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacketBuffer.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacketBuffer.cs @@ -45,8 +45,8 @@ namespace Tizen.Multimedia /// /// The index of the value to get or set. /// - /// index is less than zero. - /// -or- + /// index is less than zero.\n + /// -or-\n /// index is equal to or greater than . /// /// The MediaPacket that owns the current buffer already has been disposed of. @@ -78,8 +78,8 @@ namespace Tizen.Multimedia /// /// /// - /// offset + length is greater than . - /// -or- + /// offset + length is greater than .\n + /// -or-\n /// offset or length is less than zero. /// private void ValidateRange(int offset, int length) diff --git a/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs b/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs index 14c26c8..7c1bf05 100644 --- a/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs +++ b/src/Tizen.Multimedia/MediaTool/MediaPacketBufferFlags.cs @@ -28,7 +28,7 @@ namespace Tizen.Multimedia public enum MediaPacketBufferFlags { /// - /// The buffer contains codec initialization or codec specific data instead of media data + /// The buffer contains codec initialization or codec specific data instead of media data. /// CodecConfig = 0x1,