[StreamRecorder] Deprecate StreamRecorder module (#4424)
authorHaesu Gwon <haesu.gwon@samsung.com>
Thu, 25 Aug 2022 03:20:29 +0000 (12:20 +0900)
committerGitHub <noreply@github.com>
Thu, 25 Aug 2022 03:20:29 +0000 (12:20 +0900)
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Capabilities.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.Events.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorder.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderAudioOptions.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderBufferConsumedEventArgs.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderEnums.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderErrorOccurredEventArgs.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderOptions.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderStateChangedEventArgs.cs
src/Tizen.Multimedia.StreamRecorder/StreamRecorder/StreamRecorderVideoOptions.cs

index 308caa4..5b10eb8 100644 (file)
@@ -94,6 +94,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <returns>An IEnumerable of <see cref="RecorderFileFormat"/> representing the supported file formats.</returns>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public IEnumerable<RecorderFileFormat> GetSupportedFileFormats() => _fileFormats;
 
         private IEnumerable<RecorderAudioCodec> _audioCodecs;
@@ -103,6 +104,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <returns>An IEnumerable of <see cref="RecorderAudioCodec"/> representing the supported audio codecs.</returns>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public IEnumerable<RecorderAudioCodec> GetSupportedAudioCodecs() => _audioCodecs;
 
         private IEnumerable<RecorderVideoCodec> _videoCodecs;
@@ -112,6 +114,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <returns>An IEnumerable of <see cref="RecorderVideoCodec"/> representing the supported video codecs.</returns>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public IEnumerable<RecorderVideoCodec> GetSupportedVideoCodecs() => _videoCodecs;
 
         private IEnumerable<Size> _videoResolutions;
@@ -121,6 +124,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <returns>An IEnumerable of <see cref="Size"/> representing the supported resolutions.</returns>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public IEnumerable<Size> GetSupportedVideoResolutions() => _videoResolutions;
 
         internal void ValidateFileFormat(RecorderFileFormat format)
index 57d9c14..f548233 100644 (file)
@@ -27,6 +27,7 @@ namespace Tizen.Multimedia
         /// Occurs when <see cref="StreamRecorder"/> state is changed.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public event EventHandler<StreamRecorderStateChangedEventArgs> StateChanged;
 
 
@@ -34,24 +35,28 @@ namespace Tizen.Multimedia
         /// Occurs when a buffer had consumed completely.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public event EventHandler<StreamRecorderBufferConsumedEventArgs> BufferConsumed;
 
         /// <summary>
         /// Occurs when recording status is changed.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public event EventHandler<RecordingStatusChangedEventArgs> RecordingStatusChanged;
 
         /// <summary>
         /// Occurs when recording limit is reached.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public event EventHandler<RecordingLimitReachedEventArgs> RecordingLimitReached;
 
         /// <summary>
         /// Occurs when an error occurred during a recorder operation.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public event EventHandler<StreamRecorderErrorOccurredEventArgs> ErrorOccurred;
 
         private Native.RecordingLimitReachedCallback _recordingLimitReachedCallback;
index 14e7fca..3eb215d 100755 (executable)
@@ -26,6 +26,7 @@ namespace Tizen.Multimedia
     /// Provides the ability to record user buffer from application.
     /// </summary>
     /// <seealso cref="Recorder"/>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public partial class StreamRecorder : IDisposable
     {
         private NativeHandle _handle;
@@ -47,6 +48,7 @@ namespace Tizen.Multimedia
         /// <exception cref="NotSupportedException">The feature is not supported.</exception>
         /// <since_tizen> 3 </since_tizen>
         /// <feature> http://tizen.org/feature/multimedia.stream_recorder </feature>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorder()
         {
             if (IsSupported() == false)
@@ -91,6 +93,7 @@ namespace Tizen.Multimedia
         /// </summary>
         /// <exception cref="ObjectDisposedException">The <see cref="StreamRecorder"/> has already been disposed.</exception>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderState State
         {
             get
@@ -131,6 +134,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="StreamRecorderAudioOptions"/>
         /// <seealso cref="StreamRecorderVideoOptions"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Prepare(StreamRecorderOptions options)
         {
             if (options == null)
@@ -167,6 +171,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ObjectDisposedException">The <see cref="StreamRecorder"/> has already been disposed.</exception>
         /// <seealso cref="Prepare"/>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Unprepare()
         {
             if (State == RecorderState.Idle)
@@ -196,6 +201,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="Commit"/>
         /// <seealso cref="Cancel"/>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Start()
         {
             if (State == RecorderState.Recording)
@@ -224,6 +230,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="Commit"/>
         /// <seealso cref="Cancel"/>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Pause()
         {
             if (State == RecorderState.Paused)
@@ -257,6 +264,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="Start"/>
         /// <seealso cref="Pause"/>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Commit()
         {
             ValidateState(RecorderState.Paused, RecorderState.Recording);
@@ -277,6 +285,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="Start"/>
         /// <seealso cref="Pause"/>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Cancel()
         {
             ValidateState(RecorderState.Paused, RecorderState.Recording);
@@ -315,6 +324,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="StreamRecorderOptions.Video"/>
         /// <seealso cref="StreamRecorderVideoOptions.SourceFormat"/>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void PushBuffer(MediaPacket packet)
         {
             if (packet == null)
@@ -361,6 +371,7 @@ namespace Tizen.Multimedia
         /// Release any unmanaged resources used by this object.
         /// </summary>
         /// <since_tizen> 3 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public void Dispose()
         {
             Dispose(true);
index daf7286..c890259 100644 (file)
@@ -26,6 +26,7 @@ namespace Tizen.Multimedia
     /// <seealso cref="StreamRecorderOptions"/>
     /// <seealso cref="StreamRecorderVideoOptions"/>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public class StreamRecorderAudioOptions
     {
         private const int DefaultSampleRate = 0;
@@ -41,6 +42,7 @@ namespace Tizen.Multimedia
         /// </remarks>
         /// <exception cref="ArgumentException"><paramref name="codec"/> is not valid.</exception>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderAudioOptions(RecorderAudioCodec codec) :
             this(codec, DefaultSampleRate, DefaultBitRate, DefaultChannels)
         {
@@ -63,6 +65,7 @@ namespace Tizen.Multimedia
         ///     <paramref name="channels"/> is less than or equal to zero.
         /// </exception>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderAudioOptions(RecorderAudioCodec codec, int sampleRate, int bitRate, int channels)
         {
             Codec = codec;
@@ -80,6 +83,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
         /// <seealso cref="StreamRecorder.GetSupportedAudioCodecs"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderAudioCodec Codec
         {
             get => _codec;
@@ -105,6 +109,7 @@ namespace Tizen.Multimedia
         /// <value>The sample rate value for stream recorder. The default is zero.</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 SampleRate
         {
             get => _sampleRate;
@@ -128,6 +133,7 @@ namespace Tizen.Multimedia
         /// <value>The bit rate value for audio stream recording. The default is 128000.</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 BitRate
         {
             get => _bitRate;
@@ -151,6 +157,7 @@ namespace Tizen.Multimedia
         /// <value>The number of audio channels for audio stream recording. The default is 2.</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 Channels
         {
             get => _channels;
index 96795d3..44bd6d1 100644 (file)
@@ -23,6 +23,7 @@ namespace Tizen.Multimedia
     /// Provides data for the <see cref="StreamRecorder.BufferConsumed"/> event.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public class StreamRecorderBufferConsumedEventArgs : EventArgs
     {
         internal StreamRecorderBufferConsumedEventArgs(MediaPacket packet)
@@ -34,6 +35,7 @@ namespace Tizen.Multimedia
         /// Gets the packet that has consumed.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public MediaPacket Packet { get; }
     }
 }
index 6c246c9..5b62ee0 100644 (file)
@@ -24,6 +24,7 @@ namespace Tizen.Multimedia
     /// Specifies errors for <see cref="StreamRecorder"/>/
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public enum StreamRecorderError
     {
         /// <summary>
@@ -40,6 +41,7 @@ namespace Tizen.Multimedia
     /// Specifies the video source formats for <see cref="StreamRecorder"/>.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public enum StreamRecorderVideoFormat
     {
         /// <summary>
index 52b744b..fcd9f72 100644 (file)
@@ -22,6 +22,7 @@ namespace Tizen.Multimedia
     /// Provides data for the <see cref="StreamRecorder.ErrorOccurred"/> event.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public class StreamRecorderErrorOccurredEventArgs : EventArgs
     {
         internal StreamRecorderErrorOccurredEventArgs(StreamRecorderError error, RecorderState state)
@@ -34,12 +35,14 @@ namespace Tizen.Multimedia
         /// Gets the error code.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderError Error { get; }
 
         /// <summary>
         /// Gets the state of the recorder.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderState State { get; }
 
     }
index 30ec282..0fe0286 100644 (file)
@@ -28,6 +28,7 @@ namespace Tizen.Multimedia
     /// <seealso cref="StreamRecorderAudioOptions"/>
     /// <seealso cref="StreamRecorderVideoOptions"/>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public class StreamRecorderOptions
     {
         /// <summary>
@@ -43,6 +44,7 @@ namespace Tizen.Multimedia
         ///     <paramref name="fileFormat"/> is not valid.
         /// </exception>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderOptions(string savePath, RecorderFileFormat fileFormat)
         {
             SavePath = savePath;
@@ -60,6 +62,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentNullException"><paramref name="value"/>is null.</exception>
         /// <exception cref="ArgumentException"><paramref name="value"/>is an empty string.</exception>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public string SavePath
         {
             get => _savePath;
@@ -87,6 +90,7 @@ namespace Tizen.Multimedia
         /// <exception cref="ArgumentException"><paramref name="value"/> is not valid.</exception>
         /// <seealso cref="StreamRecorder.GetSupportedFileFormats"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderFileFormat FileFormat
         {
             get => _fileFormat;
@@ -114,6 +118,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="StreamRecorder.RecordingLimitReached"/>
         /// <seealso cref="SizeLimit"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public int TimeLimit
         {
             get => _timeLimit;
@@ -145,6 +150,7 @@ namespace Tizen.Multimedia
         /// <seealso cref="StreamRecorder.RecordingLimitReached"/>
         /// <seealso cref="TimeLimit"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public int SizeLimit
         {
             get => _sizeLimit;
@@ -168,6 +174,7 @@ namespace Tizen.Multimedia
         /// </remarks>
         /// <seealso cref="Video"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderAudioOptions Audio { get; set; }
 
         /// <summary>
@@ -178,6 +185,7 @@ namespace Tizen.Multimedia
         /// </remarks>
         /// <seealso cref="Audio"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public StreamRecorderVideoOptions Video { get; set; }
 
         private StreamRecorderSourceType GetSourceType()
index 6c18aaa..3a16e7e 100644 (file)
@@ -22,6 +22,7 @@ namespace Tizen.Multimedia
     /// Provides data for the <see cref="StreamRecorder.StateChanged"/> event.
     /// </summary>
     /// <since_tizen> 4 </since_tizen>
+    [Obsolete("Deprecated in API10; Will be removed in API12")]
     public class StreamRecorderStateChangedEventArgs : EventArgs
     {
         internal StreamRecorderStateChangedEventArgs(RecorderState previous, RecorderState current)
@@ -34,12 +35,14 @@ namespace Tizen.Multimedia
         /// Gets the previous state of the stream recorder.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderState Previous { get; }
 
         /// <summary>
         /// Gets the current state of the stream recorder.
         /// </summary>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public RecorderState Current { get; }
     }
 }
index dcd2b3b..ae443bb 100644 (file)
@@ -26,6 +26,7 @@ namespace Tizen.Multimedia
     /// <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;
@@ -52,6 +53,7 @@ namespace Tizen.Multimedia
         ///     <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)
@@ -80,6 +82,7 @@ namespace Tizen.Multimedia
         ///     <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)
         {
@@ -99,6 +102,7 @@ namespace Tizen.Multimedia
         /// <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;
@@ -121,6 +125,7 @@ namespace Tizen.Multimedia
         /// </exception>
         /// <seealso cref="StreamRecorder.GetSupportedVideoResolutions"/>
         /// <since_tizen> 4 </since_tizen>
+        [Obsolete("Deprecated in API10; Will be removed in API12")]
         public Size Resolution
         {
             get => _resolution;
@@ -144,6 +149,7 @@ namespace Tizen.Multimedia
         /// <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;
@@ -166,6 +172,7 @@ namespace Tizen.Multimedia
         /// <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;
@@ -185,6 +192,7 @@ namespace Tizen.Multimedia
         /// <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;