From: Haesu Gwon Date: Tue, 4 Jul 2017 06:38:59 +0000 (+0900) Subject: [Recorder] Add public API/Propertyes level tag X-Git-Tag: submit/trunk/20170823.075128~94^2~37^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=eaf0ac2fbd842e7d5f51762713e3ee022416620b;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git [Recorder] Add public API/Propertyes level tag Change-Id: I1b67fb544d8317f680a51e9682dc190b1b033a2a Signed-off-by: Haesu Gwon --- diff --git a/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamDeliveredEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamDeliveredEventArgs.cs old mode 100644 new mode 100755 index 0d04461..f774918 --- a/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamDeliveredEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/AudioStreamDeliveredEventArgs.cs @@ -37,26 +37,31 @@ namespace Tizen.Multimedia /// /// The audio stream data. /// + /// 3 public byte[] Stream { get; } /// /// The length of audio stream data. /// + /// 3 public int StreamLength { get; } /// /// The audio format type. /// + /// 3 public AudioSampleType Type { get; } /// /// The number of channels. /// + /// 3 public int Channel { get; } /// /// The recording time of the stream buffer in milliseconds. /// + /// 3 public uint RecordingTime { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamEventArgs.cs old mode 100644 new mode 100755 index b38d5ca..7c6ea85 --- a/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/MuxedStreamEventArgs.cs @@ -35,16 +35,19 @@ namespace Tizen.Multimedia /// /// The muexed stream data. /// + /// 3 public byte[] Stream { get; } /// /// The length of muxed stream data. /// + /// 3 public int StreamLength { get; } /// /// The offset of the stream data. /// + /// 3 public ulong Offset { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs index 6fcd1bc..1013fb7 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/Recorder.cs @@ -86,10 +86,11 @@ namespace Tizen.Multimedia return _handle; } -#region Dispose support + #region Dispose support /// /// Release any unmanaged resources used by this object. /// + /// 3 public void Dispose() { Dispose(true); @@ -141,66 +142,76 @@ namespace Tizen.Multimedia { _state = state; } -#endregion Check recorder state + #endregion Check recorder state -#region EventHandlers + #region EventHandlers /// /// Event that occurs when an error occurs during recorder operation. /// + /// 3 public event EventHandler ErrorOccurred; private Native.RecorderErrorCallback _errorOccuredCallback; /// /// Event that occurs when recorder is interrupted. /// + /// 3 public event EventHandler Interrupted; private Native.InterruptedCallback _interruptedCallback; /// /// This event occurs when recorder state is changed. /// + /// 3 public event EventHandler StateChanged; private Native.StatechangedCallback _stateChangedCallback; /// /// Event that occurs when recording information changes. /// + /// 3 public event EventHandler RecordingProgress; private Native.RecordingProgressCallback _recordingProgressCallback; /// /// Event that occurs when audio stream data is being delivered. /// + /// 3 public event EventHandler AudioStreamDelivered; private Native.AudioStreamCallback _audioStreamCallback; /// /// Event that occurs when recording limit is reached. /// + /// 3 public event EventHandler RecordingLimitReached; private Native.RecordingLimitReachedCallback _recordingLimitReachedCallback; /// /// Event that occurs when muxed stream data is being delivered. /// + /// 3 public event EventHandler MuxedStreamDelivered; private Native.MuxedStreamCallback _muxedStreamCallback; -#endregion EventHandlers + #endregion EventHandlers -#region Properties + #region Properties /// /// Gets the various recorder features. /// + /// 3 public RecorderFeatures Feature { get; } /// /// Get/Set the various recorder settings. /// + /// 3 public RecorderSettings Setting { get; } /// /// The current state of the recorder. /// + /// 3 /// A that specifies the state of recorder. /// The camera already has been disposed. public RecorderState State @@ -217,15 +228,16 @@ namespace Tizen.Multimedia return val; } } -#endregion Properties + #endregion Properties -#region Methods + #region Methods /// /// Prepare the media recorder for recording. /// The recorder must be in the state. /// After this method is finished without any exception, /// The state of recorder will be changed to state. /// + /// 3 /// /// Before calling the function, it is required to set AudioEncoder, /// videoencoder and fileformat properties of recorder. @@ -248,6 +260,7 @@ namespace Tizen.Multimedia /// After this method is finished without any exception, /// The state of recorder will be changed to state. /// + /// 3 /// In case of any invalid operations. /// The camera already has been disposed. public void Unprepare() @@ -266,6 +279,7 @@ namespace Tizen.Multimedia /// After this method is finished without any exception, /// The state of recorder will be changed to state. /// + /// 3 /// /// If file path has been set to an existing file, this file is removed automatically and updated by new one. /// In the video recorder, some preview format does not support record mode. It will return InvalidOperation error. @@ -294,6 +308,7 @@ namespace Tizen.Multimedia /// After this method is finished without any exception, /// The state of recorder will be changed to state. /// + /// 3 /// /// Recording can be resumed with Start(). /// @@ -319,6 +334,7 @@ namespace Tizen.Multimedia /// After this method is finished without any exception, /// The state of recorder will be changed to state. /// + /// 3 /// /// http://tizen.org/privilege/recorder /// @@ -342,6 +358,7 @@ namespace Tizen.Multimedia /// After this method is finished without any exception, /// The state of recorder will be changed to state. /// + /// 3 /// /// http://tizen.org/privilege/recorder /// @@ -361,6 +378,7 @@ namespace Tizen.Multimedia /// /// Sets the audio stream policy. /// + /// 3 /// Policy. /// The camera already has been disposed. public void SetAudioStreamPolicy(AudioStreamPolicy policy) diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs old mode 100644 new mode 100755 index 3adaeeb..308d080 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderEnums.cs @@ -21,6 +21,7 @@ namespace Tizen.Multimedia /// /// Enumeration for Audio Codec. /// + /// 3 public enum RecorderAudioCodec { /// @@ -52,6 +53,7 @@ namespace Tizen.Multimedia /// /// Enumeration for Audio capture devices. /// + /// 3 public enum RecorderAudioDevice { /// @@ -67,6 +69,7 @@ namespace Tizen.Multimedia /// /// Enumeration for the file container format. /// + /// 3 public enum RecorderFileFormat { /// @@ -102,6 +105,7 @@ namespace Tizen.Multimedia /// /// Enumeration for the recorder policy. /// + /// 3 public enum RecorderPolicy { /// @@ -121,6 +125,7 @@ namespace Tizen.Multimedia /// /// Enumeration for the recording limit. /// + /// 3 public enum RecordingLimitType { /// @@ -140,6 +145,7 @@ namespace Tizen.Multimedia /// /// Enumeration for the recorder rotation type. /// + /// 3 public enum RecorderOrientation { /// @@ -163,6 +169,7 @@ namespace Tizen.Multimedia /// /// Enumeration for recorder states. /// + /// 3 public enum RecorderState { /// @@ -191,6 +198,7 @@ namespace Tizen.Multimedia /// /// Enumeration for video codec. /// + /// 3 public enum RecorderVideoCodec { /// @@ -214,6 +222,7 @@ namespace Tizen.Multimedia /// /// Enumeration for recorder failure error. /// + /// 3 public enum RecorderErrorCode { /// diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderFeatures.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderFeatures.cs old mode 100644 new mode 100755 index afe3f46..f1efa79 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderFeatures.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderFeatures.cs @@ -42,6 +42,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the file formats supported by the recorder. /// + /// 3 /// /// It returns a list containing all the supported . /// @@ -78,6 +79,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the audio encoders supported by the recorder. /// + /// 3 /// /// It returns a list containing all the supported . /// @@ -114,6 +116,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the video encoders supported by the recorder. /// + /// 3 /// /// It returns a list containing all the supported . /// by recorder. @@ -151,6 +154,7 @@ namespace Tizen.Multimedia /// /// Retrieves all the video resolutions supported by the recorder. /// + /// 3 /// /// It returns videoresolution list containing the width and height of /// different resolutions supported by recorder. diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs old mode 100644 new mode 100755 index 15540f0..71392fc --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderInterruptedEventArgs.cs @@ -35,16 +35,19 @@ namespace Tizen.Multimedia /// /// The policy that interrupted the recorder. /// + /// 3 public RecorderPolicy Policy { get; } /// /// The previous state of the recorder. /// + /// 3 public RecorderState Previous { get; } /// /// The current state of the recorder. /// + /// 3 public RecorderState Current { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderSettings.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderSettings.cs old mode 100644 new mode 100755 index 5f50b94..344c6d5 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderSettings.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderSettings.cs @@ -38,6 +38,7 @@ namespace Tizen.Multimedia /// /// The number of audio channel. /// + /// 3 /// /// For mono recording, set channel to 1. /// For stereo recording, set channel to 2. @@ -65,6 +66,7 @@ namespace Tizen.Multimedia /// /// The audio device for recording. /// + /// 3 /// A that specifies the type of audio device. /// The camera already has been disposed. public RecorderAudioDevice AudioDevice @@ -89,6 +91,7 @@ namespace Tizen.Multimedia /// /// Get the peak audio input level in dB /// + /// 3 /// /// 0dB indicates maximum input level, -300dB indicates minimum input level. /// @@ -109,6 +112,7 @@ namespace Tizen.Multimedia /// /// The sampling rate of an audio stream in hertz. /// + /// 3 /// The camera already has been disposed. public int AudioSampleRate { @@ -132,6 +136,7 @@ namespace Tizen.Multimedia /// /// The bitrate of an audio encoder in bits per second. /// + /// 3 /// The camera already has been disposed. public int AudioBitRate { @@ -155,6 +160,7 @@ namespace Tizen.Multimedia /// /// The bitrate of an video encoder in bits per second. /// + /// 3 /// The camera already has been disposed. public int VideoBitRate { @@ -178,6 +184,7 @@ namespace Tizen.Multimedia /// /// The audio codec for encoding an audio stream. /// + /// 3 /// A that specifies the type of audio codec. /// The camera already has been disposed. public RecorderAudioCodec AudioCodec @@ -202,6 +209,7 @@ namespace Tizen.Multimedia /// /// The video codec for encoding video stream. /// + /// 3 /// A that specifies the type of video codec. /// The camera already has been disposed. public RecorderVideoCodec VideoCodec @@ -226,6 +234,7 @@ namespace Tizen.Multimedia /// /// The file format for recording media stream. /// + /// 3 /// A that specifies the file format. /// The camera already has been disposed. public RecorderFileFormat FileFormat @@ -250,6 +259,7 @@ namespace Tizen.Multimedia /// /// The file path to record. /// + /// 3 /// /// If the same file already exists in the file system, then old file /// will be overwritten. @@ -281,6 +291,7 @@ namespace Tizen.Multimedia /// The maximum size of a recording file in KB(kilobytes). If 0, means /// unlimited recording size. /// + /// 3 /// /// After reaching the limitation, the data which is being recorded will /// be discarded and not written to the file. @@ -310,6 +321,7 @@ namespace Tizen.Multimedia /// The time limit of a recording file in Seconds. If 0, means unlimited recording /// time. /// + /// 3 /// /// After reaching the limitation, the data which is being recorded will /// be discarded and not written to the file. @@ -338,6 +350,7 @@ namespace Tizen.Multimedia /// /// The mute state of a recorder. /// + /// 3 /// The camera already has been disposed. public bool Mute { @@ -356,6 +369,7 @@ namespace Tizen.Multimedia /// /// The video recording motion rate /// + /// 3 /// /// The attribute is valid only in a video recorder. /// If the rate is in range of 0-1, video is recorded in a slow motion mode. @@ -384,6 +398,7 @@ namespace Tizen.Multimedia /// /// The orientation in a video metadata tag. /// + /// 3 /// A that specifies the type of orientation. /// The camera already has been disposed. public RecorderOrientation OrientationTag @@ -408,6 +423,7 @@ namespace Tizen.Multimedia /// /// Resolution of the video. /// + /// 3 /// In case of invalid parameters /// The camera already has been disposed. public Size VideoResolution diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs old mode 100644 new mode 100755 index ad5af93..42e3af0 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecorderStateChangedEventArgs.cs @@ -34,17 +34,20 @@ namespace Tizen.Multimedia /// /// Previous state of the recorder. /// + /// 3 public RecorderState Previous { get; } /// /// Current state of the recorder. /// + /// 3 public RecorderState Current { get; } /// /// true if the state changed by policy such as Resource Conflict or Security, otherwise false /// in normal state change. /// + /// 3 public bool IsStateChangedByPolicy { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs old mode 100644 new mode 100755 index 95c0dfa..80b6070 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecordingErrorOccurredEventArgs.cs @@ -33,11 +33,13 @@ namespace Tizen.Multimedia /// /// The error code. /// + /// 3 public RecorderErrorCode Error { get; } /// /// The state of the recorder. /// + /// 3 public RecorderState State { get; } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs old mode 100644 new mode 100755 index a6e0567..8606748 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecordingLimitReachedEventArgs.cs @@ -31,6 +31,7 @@ namespace Tizen.Multimedia /// /// The limitation type. /// + /// 3 public RecordingLimitType Type { get; } } } diff --git a/src/Tizen.Multimedia.Recorder/Recorder/RecordingProgressEventArgs.cs b/src/Tizen.Multimedia.Recorder/Recorder/RecordingProgressEventArgs.cs index 619bdcd..f059fc7 100755 --- a/src/Tizen.Multimedia.Recorder/Recorder/RecordingProgressEventArgs.cs +++ b/src/Tizen.Multimedia.Recorder/Recorder/RecordingProgressEventArgs.cs @@ -32,11 +32,13 @@ namespace Tizen.Multimedia /// /// The time of recording in milliseconds. /// + /// 3 public ulong ElapsedTime { get; } /// /// The size of the recording file in Kilobyte. /// + /// 3 public ulong FileSize { get; } } }