[StreamRecorder] Deprecate StreamRecorder module (#4424)

[platform/core/csapi/tizenfx.git] / src / Tizen.Multimedia.StreamRecorder / StreamRecorder / StreamRecorderVideoOptions.cs

diff --git a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
index 3460532..ae443bb 100644 (file)
--- a/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
+++ b/src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs
@@ -25,13 +25,15 @@ namespace Tizen.Multimedia
     /// <seealso cref="StreamRecorder"/>
     /// <seealso cref="StreamRecorderOptions"/>
     /// <seealso cref="StreamRecorderAudioOptions"/>
+    /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public class StreamRecorderVideoOptions
     {
         private const int DefaultBitRate = 0;
 
         /// <summary>
         /// Initialize a new instance of the <see cref="StreamRecorderVideoOptions"/> class with the specified
-        /// codec, resolution, source format and frame rate.
+        /// codec, resolution, source format, and frame rate.
         /// </summary>
         /// <param name="codec">The <see cref="RecorderVideoCodec"/> for encoding video stream.</param>
         /// <param name="resolution">The resolution of video recording.</param>
@@ -41,15 +43,17 @@ namespace Tizen.Multimedia
         /// <see cref="BitRate"/> will be set as default.
         /// </remarks>
         /// <exception cref="ArgumentException">
-        ///     <paramref name="codec"/> is not valid.\n
-        ///     -or-\n
-        ///     <paramref name="sourceFormat"/> is not valid.\n
+        ///     <paramref name="codec"/> is not valid.<br/>
+        ///     -or-<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.\n
-        ///     -or-\n
-        ///     <paramref name="frameRate"/> is less than or equal to zero.\n
+        ///     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.
         /// </exception>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution,
             StreamRecorderVideoFormat sourceFormat, int frameRate) :
             this(codec, resolution, sourceFormat, frameRate, DefaultBitRate)
@@ -58,7 +62,7 @@ namespace Tizen.Multimedia
 
         /// <summary>
         /// Initialize a new instance of the <see cref="StreamRecorderVideoOptions"/> class with the specified
-        /// codec, resolution, source format, frame rate and bit rate.
+        /// codec, resolution, source format, frame rate, and bit rate.
         /// </summary>
         /// <param name="codec">The <see cref="RecorderVideoCodec"/> for encoding video stream.</param>
         /// <param name="resolution">The resolution of video recording.</param>
@@ -66,17 +70,19 @@ namespace Tizen.Multimedia
         /// <param name="frameRate">The frame rate for encoding video stream.</param>
         /// <param name="bitRate">The bit rate for encoding video stream.</param>
         /// <exception cref="ArgumentException">
-        ///     <paramref name="codec"/> is not valid.\n
-        ///     -or-\n
-        ///     <paramref name="sourceFormat"/> is not valid.\n
+        ///     <paramref name="codec"/> is not valid.<br/>
+        ///     -or-<br/>
+        ///     <paramref name="sourceFormat"/> is not valid.<br/>
         /// </exception>
         /// <exception cref="ArgumentOutOfRangeException">
-        ///     Width or height of <paramref name="resolution"/> is less than or equal to zero.\n
-        ///     -or-\n
-        ///     <paramref name="frameRate"/> is less than or equal to zero.\n
-        ///     -or-\n
+        ///     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/>
+        ///     -or-<br/>
         ///     <paramref name="bitRate"/> is less than zero.
         /// </exception>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderVideoOptions(RecorderVideoCodec codec, Size resolution,
             StreamRecorderVideoFormat sourceFormat, int frameRate, int bitRate)
         {
@@ -95,6 +101,8 @@ namespace Tizen.Multimedia
         /// <value>The codec for video stream recording.</value>
         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
         /// <seealso cref="StreamRecorder.GetSupportedVideoCodecs"/>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderVideoCodec Codec
         {
             get => _codec;
@@ -116,6 +124,8 @@ namespace Tizen.Multimedia
         ///     Width or height of <paramref name="value"/> is less than or equal to zero.
         /// </exception>
         /// <seealso cref="StreamRecorder.GetSupportedVideoResolutions"/>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public Size Resolution
         {
             get => _resolution;
@@ -138,6 +148,8 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <value>The frame rate value for video stream recording.</value>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public int FrameRate
         {
             get => _frameRate;
@@ -159,6 +171,8 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <value>The source format of buffers for video stream recording.</value>
         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderVideoFormat SourceFormat
         {
             get => _sourceFormat;
@@ -177,6 +191,8 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <value>The bit rate value for video stream recording. The default is 0.</value>
         /// <exception cref="ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
+        /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public int BitRate
         {
             get => _bitRate;