-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.Multimedia.StreamRecorder</name>
- </assembly>
- <members>
- <member name="T:Tizen.Multimedia.StreamRecorder">
- <summary>
- Provides the ability to record user buffer from application.
- </summary>
- <seealso cref="T:Tizen.Multimedia.Recorder"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedFileFormats">
- <summary>
- Gets the file formats that the current device supports.
- </summary>
- <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderFileFormat"/> representing the supported file formats.</returns>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedAudioCodecs">
- <summary>
- Gets the audio codecs that the current device supports.
- </summary>
- <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> representing the supported audio codecs.</returns>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoCodecs">
- <summary>
- Gets the video codecs that the current device supports.
- </summary>
- <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> representing the supported video codecs.</returns>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoResolutions">
- <summary>
- Gets the video resolutions that the current device supports.
- </summary>
- <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.Size"/> representing the supported resolutions.</returns>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.#ctor">
- <summary>
- Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorder"/> class.
- </summary>
- <exception cref="T:System.NotSupportedException">The feature is not supported.</exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorder.State">
- <summary>
- Gets the current state of the stream recorder.
- </summary>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)">
- <summary>
- Prepares the stream recorder with the specified options.
- </summary>
- <remarks>The recorder must be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/>.</remarks>
- <param name="options">The options for recording.</param>
- <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
- <exception cref="T:System.ArgumentException">Both <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> and
- <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> are null.
- </exception>
- <exception cref="T:System.NotSupportedException"><paramref name="options"/> contains a value which is not supported.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Unprepare"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Unprepare">
- <summary>
- Unprepares the stream recorder.
- </summary>
- <remarks>
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state by
- <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>, <see cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/> and <see cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>.\n
- The recorder state will be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/>.\n
- \n
- It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Idle"/> state.
- </remarks>
- <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Start">
- <summary>
- Starts recording.
- </summary>
- <remarks>
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state by
- <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/> or
- <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\n
- \n
- It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state.
- </remarks>
- <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
- <exception cref="T:System.UnauthorizedAccessException">The access of the resources can not be granted.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Pause">
- <summary>
- Pauses recording.
- </summary>
- <remarks>
- Recording can be resumed with <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.\n
- \n
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> \n
- \n
- It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state.
- </remarks>
- <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Commit">
- <summary>
- Stops recording and saves the result.
- </summary>
- <remarks>
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or
- <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\n
- \n
- The recorder state will be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> after commit.\n
- <para>
- http://tizen.org/privilege/mediastorage is needed if the save path are relevant to media storage.
- http://tizen.org/privilege/externalstorage is needed if the save path are relevant to external storage.
- </para>
- </remarks>
- <privilege>http://tizen.org/privilege/mediastorage</privilege>
- <privilege>http://tizen.org/privilege/externalstorage</privilege>
- <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
- <exception cref="T:System.UnauthorizedAccessException">The access to the resources can not be granted.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Cancel">
- <summary>
- Cancels recording.
- The recording data is discarded and not written.
- </summary>
- <remarks>
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or
- <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.
- </remarks>
- <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.PushBuffer(Tizen.Multimedia.MediaPacket)">
- <summary>
- Pushes a packet as recording raw data.
- </summary>
- <param name="packet">An audio or video packet to record.</param>
- <remarks>
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- The recorder is not in the valid state.\n
- -or-\n
- <paramref name="packet"/> is an audio packet but audio recording is not enabled(See <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>).\n
- -or-\n
- <paramref name="packet"/> is a video packet but video recording is not enabled(See <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>).\n
- -or-\n
- <paramref name="packet"/> is a video packet but the <see cref="P:Tizen.Multimedia.VideoMediaFormat.MimeType"/> does not match the video source format.\n
- -or-\n
- An internal error occurs.
- </exception>
- <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
- <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderVideoOptions.SourceFormat"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Dispose">
- <summary>
- Release any unmanaged resources used by this object.
- </summary>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorder.Dispose(System.Boolean)">
- <summary>
- Releases the resources used by the StreamRecorder.
- </summary>
- <param name="disposing">
- true to release both managed and unmanaged resources; false to release only unmanaged resources.
- </param>
- </member>
- <member name="E:Tizen.Multimedia.StreamRecorder.StateChanged">
- <summary>
- Occurs when <see cref="T:Tizen.Multimedia.StreamRecorder"/> state is changed.
- </summary>
- </member>
- <member name="E:Tizen.Multimedia.StreamRecorder.BufferConsumed">
- <summary>
- Occurs when a buffer had consumed completely.
- </summary>
- </member>
- <member name="E:Tizen.Multimedia.StreamRecorder.RecordingStatusChanged">
- <summary>
- Occurs when recording status is changed.
- </summary>
- </member>
- <member name="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached">
- <summary>
- Occurs when recording limit is reached.
- </summary>
- </member>
- <member name="E:Tizen.Multimedia.StreamRecorder.ErrorOccurred">
- <summary>
- Occurs when an error occurred during a recorder operation.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderAudioOptions">
- <summary>
- Specifies the options associated with audio recording.
- </summary>
- <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorderAudioOptions.#ctor(Tizen.Multimedia.RecorderAudioCodec)">
- <summary>
- Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/> class with the specified codec.
- </summary>
- <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> for encoding audio stream.</param>
- <remarks>
- <see cref="P:Tizen.Multimedia.StreamRecorderAudioOptions.SampleRate"/>, <see cref="P:Tizen.Multimedia.StreamRecorderAudioOptions.BitRate"/> and <see cref="P:Tizen.Multimedia.StreamRecorderAudioOptions.Channels"/> will be set as default.
- </remarks>
- <exception cref="T:System.ArgumentException"><paramref name="codec"/> is not valid.</exception>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorderAudioOptions.#ctor(Tizen.Multimedia.RecorderAudioCodec,System.Int32,System.Int32,System.Int32)">
- <summary>
- Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/> class with the specified
- codec, sample rate, bit rate and channel value.
- </summary>
- <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> for encoding audio stream.</param>
- <param name="sampleRate">The sample rate for encoding audio stream.</param>
- <param name="bitRate">The bit rate for encoding audio stream.</param>
- <param name="channels">The number of channels for encoding audio stream.</param>
- <exception cref="T:System.ArgumentException"><paramref name="codec"/> is not valid.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="sampleRate"/> is less than zero.\n
- -or-\n
- <paramref name="bitRate"/> is less than or equal to zero.\n
- -or-\n
- <paramref name="channels"/> is less than or equal to zero.
- </exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.Codec">
- <summary>
- Gets or sets the audio codec for encoding an audio stream.
- </summary>
- <value>The codec for audio stream recording.</value>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedAudioCodecs"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.SampleRate">
- <summary>
- Gets or sets the sampling rate of the audio stream in hertz.
- </summary>
- <remarks>If the value is zero, the sample rate will be decided based on input buffers.</remarks>
- <value>The sample rate value for stream recorder. The default is zero.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.BitRate">
- <summary>
- Gets or sets the bit rate of the audio encoder in bits per second.
- </summary>
- <value>The bit rate value for audio stream recording. The default is 128000.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.Channels">
- <summary>
- Gets or sets the number of audio channels.
- </summary>
- <value>The number of audio channels for audio stream recording. The default is 2.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderBufferConsumedEventArgs">
- <summary>
- Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.BufferConsumed"/> event.
- </summary>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderBufferConsumedEventArgs.Packet">
- <summary>
- Gets the packet that has consumed.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderError">
- <summary>
- Specifies errors for <see cref="T:Tizen.Multimedia.StreamRecorder"/>/
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderError.InternalError">
- <summary>
- Internal error.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderError.OutOfStorage">
- <summary>
- Out of storage.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderVideoFormat">
- <summary>
- Specifies the video source formats for <see cref="T:Tizen.Multimedia.StreamRecorder"/>.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.Nv12">
- <summary>
- Nv12 format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.Nv21">
- <summary>
- Nv21 format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.I420">
- <summary>
- I420 format.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderAudioCodec">
- <summary>
- Enumeration for Audio Codec.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Amr">
- <summary>
- AMR codec.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Aac">
- <summary>
- AAC codec.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Pcm">
- <summary>
- PCM codec.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderFileFormat">
- <summary>
- Enumeration for the file container format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.ThreeGp">
- <summary>
- 3GP file format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Mp4">
- <summary>
- MP4 file format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Amr">
- <summary>
- AMR file format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Adts">
- <summary>
- ADTS file format.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Wav">
- <summary>
- WAV file format.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderNotify">
- <summary>
- Enumeration for the recorder notify type.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderNotify.None">
- <summary>
- None.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderNotify.StateChanged">
- <summary>
- State changed.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderVideoCodec">
- <summary>
- Enumeration for video codec.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.H263">
- <summary>
- H263 codec.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.Mpeg4">
- <summary>
- MPEG4 codec.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderSourceType">
- <summary>
- Enumeration for source type.
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Video">
- <summary>
- Video source
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Audio">
- <summary>
- Audio source
- </summary>
- </member>
- <member name="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio">
- <summary>
- Audio/Video both
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs">
- <summary>
- Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.ErrorOccurred"/> event.
- </summary>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs.Error">
- <summary>
- Gets the error code.
- </summary>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs.State">
- <summary>
- Gets the state of the recorder.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderOptions">
- <summary>
- Specifies the options associated with <see cref="T:Tizen.Multimedia.StreamRecorder"/>.
- </summary>
- <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorderOptions.#ctor(System.String,Tizen.Multimedia.RecorderFileFormat)">
- <summary>
- Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderOptions"/> class with the specified
- save path and file format.
- </summary>
- <param name="savePath">The path that the recording result is saved.</param>
- <param name="fileFormat">The file format of output file.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="savePath"/>is null.</exception>
- <exception cref="T:System.ArgumentException">
- <paramref name="savePath"/>is an empty string.\n
- -or-\n
- <paramref name="fileFormat"/> is not valid.
- </exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderOptions.SavePath">
- <summary>
- Gets or sets the file path to record.
- </summary>
- <remarks>
- If the same file already exists in the file system, then old file will be overwritten.
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/>is null.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="value"/>is an empty string.</exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderOptions.FileFormat">
- <summary>
- Gets or sets the file format for recording media stream.
- </summary>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedFileFormats"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderOptions.TimeLimit">
- <summary>
- Gets or sets the time limit of recording.
- </summary>
- <value>
- The maximum time of recording in seconds, or 0 for unlimited time.
- </value>
- <remarks>
- After reaching the limitation, the data which is being recorded will
- be discarded and not written to the file.
- The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/> state.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- <seealso cref="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached"/>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.SizeLimit"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderOptions.SizeLimit">
- <summary>
- Gets or sets the maximum size of a recording file.
- </summary>
- <value>
- The maximum size of a recording file in kilobytes, or 0 for unlimited size.
- </value>
- <remarks>
- After reaching the limitation, the data which is being recorded will
- be discarded and not written to the file.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- <seealso cref="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached"/>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.TimeLimit"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderOptions.Audio">
- <summary>
- Gets or sets the options for audio recording.
- </summary>
- <remarks>
- <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> or <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> must be set for recording.
- </remarks>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderOptions.Video">
- <summary>
- Gets or sets the options for video recording.
- </summary>
- <remarks>
- <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> or <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> must be set for recording.
- </remarks>
- <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderStateChangedEventArgs">
- <summary>
- Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.StateChanged"/> event.
- </summary>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderStateChangedEventArgs.Previous">
- <summary>
- Gets the previous state of the stream recorder.
- </summary>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderStateChangedEventArgs.Current">
- <summary>
- Gets the current state of the stream recorder.
- </summary>
- </member>
- <member name="T:Tizen.Multimedia.StreamRecorderVideoOptions">
- <summary>
- Specifies the options associated with video recording.
- </summary>
- <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>
- <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorderVideoOptions.#ctor(Tizen.Multimedia.RecorderVideoCodec,Tizen.Multimedia.Size,Tizen.Multimedia.StreamRecorderVideoFormat,System.Int32)">
- <summary>
- Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/> class with the specified
- codec, resolution, source format and frame rate.
- </summary>
- <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> for encoding video stream.</param>
- <param name="resolution">The resolution of video recording.</param>
- <param name="sourceFormat">The format of source stream.</param>
- <param name="frameRate">The frame rate for encoding video stream.</param>
- <remarks>
- <see cref="P:Tizen.Multimedia.StreamRecorderVideoOptions.BitRate"/> will be set as default.
- </remarks>
- <exception cref="T:System.ArgumentException">
- <paramref name="codec"/> is not valid.\n
- -or-\n
- <paramref name="sourceFormat"/> is not valid.\n
- </exception>
- <exception cref="T:System.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
- </exception>
- </member>
- <member name="M:Tizen.Multimedia.StreamRecorderVideoOptions.#ctor(Tizen.Multimedia.RecorderVideoCodec,Tizen.Multimedia.Size,Tizen.Multimedia.StreamRecorderVideoFormat,System.Int32,System.Int32)">
- <summary>
- Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/> class with the specified
- codec, resolution, source format, frame rate and bit rate.
- </summary>
- <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> for encoding video stream.</param>
- <param name="resolution">The resolution of video recording.</param>
- <param name="sourceFormat">The format of source stream.</param>
- <param name="frameRate">The frame rate for encoding video stream.</param>
- <param name="bitRate">The bit rate for encoding video stream.</param>
- <exception cref="T:System.ArgumentException">
- <paramref name="codec"/> is not valid.\n
- -or-\n
- <paramref name="sourceFormat"/> is not valid.\n
- </exception>
- <exception cref="T:System.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
- <paramref name="bitRate"/> is less than zero.
- </exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.Codec">
- <summary>
- Gets or sets the video codec for encoding video stream.
- </summary>
- <value>The codec for video stream recording.</value>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoCodecs"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.Resolution">
- <summary>
- Gets or sets the resolution of the video recording.
- </summary>
- <value>The output resolution for video stream recording.</value>
- <exception cref="T:System.ArgumentOutOfRangeException">
- Width or height of <paramref name="value"/> is less than or equal to zero.
- </exception>
- <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoResolutions"/>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.FrameRate">
- <summary>
- Gets or sets the frame rate for recording media stream.
- </summary>
- <value>The frame rate value for video stream recording.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.SourceFormat">
- <summary>
- Gets or sets the video source format for recording media stream.
- </summary>
- <value>The source format of buffers for video stream recording.</value>
- <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
- </member>
- <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.BitRate">
- <summary>
- The bit rate of the video encoder in bits per second.
- </summary>
- <value>The bit rate value for video stream recording. The default is 0.</value>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.Multimedia.StreamRecorder</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Tizen.Multimedia.StreamRecorder">\r
+ <summary>\r
+ Provides the ability to record user buffer from application.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Multimedia.Recorder"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedFileFormats">\r
+ <summary>\r
+ Gets the file formats that the current device supports.\r
+ </summary>\r
+ <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderFileFormat"/> representing the supported file formats.</returns>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedAudioCodecs">\r
+ <summary>\r
+ Gets the audio codecs that the current device supports.\r
+ </summary>\r
+ <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> representing the supported audio codecs.</returns>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoCodecs">\r
+ <summary>\r
+ Gets the video codecs that the current device supports.\r
+ </summary>\r
+ <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> representing the supported video codecs.</returns>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoResolutions">\r
+ <summary>\r
+ Gets the video resolutions that the current device supports.\r
+ </summary>\r
+ <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.Size"/> representing the supported resolutions.</returns>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.#ctor">\r
+ <summary>\r
+ Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorder"/> class.\r
+ </summary>\r
+ <exception cref="T:System.NotSupportedException">The feature is not supported.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorder.State">\r
+ <summary>\r
+ Gets the current state of the stream recorder.\r
+ </summary>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)">\r
+ <summary>\r
+ Prepares the stream recorder with the specified options.\r
+ </summary>\r
+ <remarks>The recorder must be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/>.</remarks>\r
+ <param name="options">The options for recording.</param>\r
+ <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>\r
+ <exception cref="T:System.ArgumentException">Both <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> and\r
+ <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> are null.\r
+ </exception>\r
+ <exception cref="T:System.NotSupportedException"><paramref name="options"/> contains a value which is not supported.</exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Unprepare"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Unprepare">\r
+ <summary>\r
+ Unprepares the stream recorder.\r
+ </summary>\r
+ <remarks>\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state by\r
+ <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>, <see cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/> and <see cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>.\n\r
+ The recorder state will be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/>.\n\r
+ \n\r
+ It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Idle"/> state.\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Start">\r
+ <summary>\r
+ Starts recording.\r
+ </summary>\r
+ <remarks>\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state by\r
+ <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/> or\r
+ <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\n\r
+ \n\r
+ It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state.\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">The access of the resources can not be granted.</exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Pause">\r
+ <summary>\r
+ Pauses recording.\r
+ </summary>\r
+ <remarks>\r
+ Recording can be resumed with <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.\n\r
+ \n\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> \n\r
+ \n\r
+ It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state.\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Commit">\r
+ <summary>\r
+ Stops recording and saves the result.\r
+ </summary>\r
+ <remarks>\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or\r
+ <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\n\r
+ \n\r
+ The recorder state will be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> after commit.\n\r
+ <para>\r
+ http://tizen.org/privilege/mediastorage is needed if the save path are relevant to media storage.\r
+ http://tizen.org/privilege/externalstorage is needed if the save path are relevant to external storage.\r
+ </para>\r
+ </remarks>\r
+ <privilege>http://tizen.org/privilege/mediastorage</privilege>\r
+ <privilege>http://tizen.org/privilege/externalstorage</privilege>\r
+ <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">The access to the resources can not be granted.</exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Cancel">\r
+ <summary>\r
+ Cancels recording.\r
+ The recording data is discarded and not written.\r
+ </summary>\r
+ <remarks>\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or\r
+ <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.PushBuffer(Tizen.Multimedia.MediaPacket)">\r
+ <summary>\r
+ Pushes a packet as recording raw data.\r
+ </summary>\r
+ <param name="packet">An audio or video packet to record.</param>\r
+ <remarks>\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.\r
+ </remarks>\r
+ <exception cref="T:System.InvalidOperationException">\r
+ The recorder is not in the valid state.\n\r
+ -or-\n\r
+ <paramref name="packet"/> is an audio packet but audio recording is not enabled(See <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>).\n\r
+ -or-\n\r
+ <paramref name="packet"/> is a video packet but video recording is not enabled(See <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>).\n\r
+ -or-\n\r
+ <paramref name="packet"/> is a video packet but the <see cref="P:Tizen.Multimedia.VideoMediaFormat.MimeType"/> does not match the video source format.\n\r
+ -or-\n\r
+ An internal error occurs.\r
+ </exception>\r
+ <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>\r
+ <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderVideoOptions.SourceFormat"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Dispose">\r
+ <summary>\r
+ Release any unmanaged resources used by this object.\r
+ </summary>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorder.Dispose(System.Boolean)">\r
+ <summary>\r
+ Releases the resources used by the StreamRecorder.\r
+ </summary>\r
+ <param name="disposing">\r
+ true to release both managed and unmanaged resources; false to release only unmanaged resources.\r
+ </param>\r
+ </member>\r
+ <member name="E:Tizen.Multimedia.StreamRecorder.StateChanged">\r
+ <summary>\r
+ Occurs when <see cref="T:Tizen.Multimedia.StreamRecorder"/> state is changed.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Tizen.Multimedia.StreamRecorder.BufferConsumed">\r
+ <summary>\r
+ Occurs when a buffer had consumed completely.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Tizen.Multimedia.StreamRecorder.RecordingStatusChanged">\r
+ <summary>\r
+ Occurs when recording status is changed.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached">\r
+ <summary>\r
+ Occurs when recording limit is reached.\r
+ </summary>\r
+ </member>\r
+ <member name="E:Tizen.Multimedia.StreamRecorder.ErrorOccurred">\r
+ <summary>\r
+ Occurs when an error occurred during a recorder operation.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderAudioOptions">\r
+ <summary>\r
+ Specifies the options associated with audio recording.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorderAudioOptions.#ctor(Tizen.Multimedia.RecorderAudioCodec)">\r
+ <summary>\r
+ Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/> class with the specified codec.\r
+ </summary>\r
+ <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> for encoding audio stream.</param>\r
+ <remarks>\r
+ <see cref="P:Tizen.Multimedia.StreamRecorderAudioOptions.SampleRate"/>, <see cref="P:Tizen.Multimedia.StreamRecorderAudioOptions.BitRate"/> and <see cref="P:Tizen.Multimedia.StreamRecorderAudioOptions.Channels"/> will be set as default.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentException"><paramref name="codec"/> is not valid.</exception>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorderAudioOptions.#ctor(Tizen.Multimedia.RecorderAudioCodec,System.Int32,System.Int32,System.Int32)">\r
+ <summary>\r
+ Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/> class with the specified\r
+ codec, sample rate, bit rate and channel value.\r
+ </summary>\r
+ <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> for encoding audio stream.</param>\r
+ <param name="sampleRate">The sample rate for encoding audio stream.</param>\r
+ <param name="bitRate">The bit rate for encoding audio stream.</param>\r
+ <param name="channels">The number of channels for encoding audio stream.</param>\r
+ <exception cref="T:System.ArgumentException"><paramref name="codec"/> is not valid.</exception>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ <paramref name="sampleRate"/> is less than zero.\n\r
+ -or-\n\r
+ <paramref name="bitRate"/> is less than or equal to zero.\n\r
+ -or-\n\r
+ <paramref name="channels"/> is less than or equal to zero.\r
+ </exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.Codec">\r
+ <summary>\r
+ Gets or sets the audio codec for encoding an audio stream.\r
+ </summary>\r
+ <value>The codec for audio stream recording.</value>\r
+ <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedAudioCodecs"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.SampleRate">\r
+ <summary>\r
+ Gets or sets the sampling rate of the audio stream in hertz.\r
+ </summary>\r
+ <remarks>If the value is zero, the sample rate will be decided based on input buffers.</remarks>\r
+ <value>The sample rate value for stream recorder. The default is zero.</value>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.BitRate">\r
+ <summary>\r
+ Gets or sets the bit rate of the audio encoder in bits per second.\r
+ </summary>\r
+ <value>The bit rate value for audio stream recording. The default is 128000.</value>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.Channels">\r
+ <summary>\r
+ Gets or sets the number of audio channels.\r
+ </summary>\r
+ <value>The number of audio channels for audio stream recording. The default is 2.</value>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderBufferConsumedEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.BufferConsumed"/> event.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderBufferConsumedEventArgs.Packet">\r
+ <summary>\r
+ Gets the packet that has consumed.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderError">\r
+ <summary>\r
+ Specifies errors for <see cref="T:Tizen.Multimedia.StreamRecorder"/>/\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderError.InternalError">\r
+ <summary>\r
+ Internal error.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderError.OutOfStorage">\r
+ <summary>\r
+ Out of storage.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderVideoFormat">\r
+ <summary>\r
+ Specifies the video source formats for <see cref="T:Tizen.Multimedia.StreamRecorder"/>.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.Nv12">\r
+ <summary>\r
+ Nv12 format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.Nv21">\r
+ <summary>\r
+ Nv21 format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.I420">\r
+ <summary>\r
+ I420 format.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderAudioCodec">\r
+ <summary>\r
+ Enumeration for Audio Codec.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Amr">\r
+ <summary>\r
+ AMR codec.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Aac">\r
+ <summary>\r
+ AAC codec.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Pcm">\r
+ <summary>\r
+ PCM codec.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderFileFormat">\r
+ <summary>\r
+ Enumeration for the file container format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.ThreeGp">\r
+ <summary>\r
+ 3GP file format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Mp4">\r
+ <summary>\r
+ MP4 file format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Amr">\r
+ <summary>\r
+ AMR file format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Adts">\r
+ <summary>\r
+ ADTS file format.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Wav">\r
+ <summary>\r
+ WAV file format.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderNotify">\r
+ <summary>\r
+ Enumeration for the recorder notify type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderNotify.None">\r
+ <summary>\r
+ None.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderNotify.StateChanged">\r
+ <summary>\r
+ State changed.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderVideoCodec">\r
+ <summary>\r
+ Enumeration for video codec.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.H263">\r
+ <summary>\r
+ H263 codec.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.Mpeg4">\r
+ <summary>\r
+ MPEG4 codec.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderSourceType">\r
+ <summary>\r
+ Enumeration for source type.\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Video">\r
+ <summary>\r
+ Video source\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Audio">\r
+ <summary>\r
+ Audio source\r
+ </summary>\r
+ </member>\r
+ <member name="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio">\r
+ <summary>\r
+ Audio/Video both\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.ErrorOccurred"/> event.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs.Error">\r
+ <summary>\r
+ Gets the error code.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs.State">\r
+ <summary>\r
+ Gets the state of the recorder.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderOptions">\r
+ <summary>\r
+ Specifies the options associated with <see cref="T:Tizen.Multimedia.StreamRecorder"/>.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorderOptions.#ctor(System.String,Tizen.Multimedia.RecorderFileFormat)">\r
+ <summary>\r
+ Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderOptions"/> class with the specified\r
+ save path and file format.\r
+ </summary>\r
+ <param name="savePath">The path that the recording result is saved.</param>\r
+ <param name="fileFormat">The file format of output file.</param>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="savePath"/>is null.</exception>\r
+ <exception cref="T:System.ArgumentException">\r
+ <paramref name="savePath"/>is an empty string.\n\r
+ -or-\n\r
+ <paramref name="fileFormat"/> is not valid.\r
+ </exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderOptions.SavePath">\r
+ <summary>\r
+ Gets or sets the file path to record.\r
+ </summary>\r
+ <remarks>\r
+ If the same file already exists in the file system, then old file will be overwritten.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentNullException"><paramref name="value"/>is null.</exception>\r
+ <exception cref="T:System.ArgumentException"><paramref name="value"/>is an empty string.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderOptions.FileFormat">\r
+ <summary>\r
+ Gets or sets the file format for recording media stream.\r
+ </summary>\r
+ <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedFileFormats"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderOptions.TimeLimit">\r
+ <summary>\r
+ Gets or sets the time limit of recording.\r
+ </summary>\r
+ <value>\r
+ The maximum time of recording in seconds, or 0 for unlimited time.\r
+ </value>\r
+ <remarks>\r
+ After reaching the limitation, the data which is being recorded will\r
+ be discarded and not written to the file.\r
+ The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/> state.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>\r
+ <seealso cref="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached"/>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.SizeLimit"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderOptions.SizeLimit">\r
+ <summary>\r
+ Gets or sets the maximum size of a recording file.\r
+ </summary>\r
+ <value>\r
+ The maximum size of a recording file in kilobytes, or 0 for unlimited size.\r
+ </value>\r
+ <remarks>\r
+ After reaching the limitation, the data which is being recorded will\r
+ be discarded and not written to the file.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>\r
+ <seealso cref="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached"/>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.TimeLimit"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderOptions.Audio">\r
+ <summary>\r
+ Gets or sets the options for audio recording.\r
+ </summary>\r
+ <remarks>\r
+ <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> or <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> must be set for recording.\r
+ </remarks>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderOptions.Video">\r
+ <summary>\r
+ Gets or sets the options for video recording.\r
+ </summary>\r
+ <remarks>\r
+ <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> or <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> must be set for recording.\r
+ </remarks>\r
+ <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderStateChangedEventArgs">\r
+ <summary>\r
+ Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.StateChanged"/> event.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderStateChangedEventArgs.Previous">\r
+ <summary>\r
+ Gets the previous state of the stream recorder.\r
+ </summary>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderStateChangedEventArgs.Current">\r
+ <summary>\r
+ Gets the current state of the stream recorder.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.Multimedia.StreamRecorderVideoOptions">\r
+ <summary>\r
+ Specifies the options associated with video recording.\r
+ </summary>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>\r
+ <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorderVideoOptions.#ctor(Tizen.Multimedia.RecorderVideoCodec,Tizen.Multimedia.Size,Tizen.Multimedia.StreamRecorderVideoFormat,System.Int32)">\r
+ <summary>\r
+ Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/> class with the specified\r
+ codec, resolution, source format and frame rate.\r
+ </summary>\r
+ <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> for encoding video stream.</param>\r
+ <param name="resolution">The resolution of video recording.</param>\r
+ <param name="sourceFormat">The format of source stream.</param>\r
+ <param name="frameRate">The frame rate for encoding video stream.</param>\r
+ <remarks>\r
+ <see cref="P:Tizen.Multimedia.StreamRecorderVideoOptions.BitRate"/> will be set as default.\r
+ </remarks>\r
+ <exception cref="T:System.ArgumentException">\r
+ <paramref name="codec"/> is not valid.\n\r
+ -or-\n\r
+ <paramref name="sourceFormat"/> is not valid.\n\r
+ </exception>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ Width or height of <paramref name="resolution"/> is less than or equal to zero.\n\r
+ -or-\n\r
+ <paramref name="frameRate"/> is less than or equal to zero.\n\r
+ </exception>\r
+ </member>\r
+ <member name="M:Tizen.Multimedia.StreamRecorderVideoOptions.#ctor(Tizen.Multimedia.RecorderVideoCodec,Tizen.Multimedia.Size,Tizen.Multimedia.StreamRecorderVideoFormat,System.Int32,System.Int32)">\r
+ <summary>\r
+ Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/> class with the specified\r
+ codec, resolution, source format, frame rate and bit rate.\r
+ </summary>\r
+ <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> for encoding video stream.</param>\r
+ <param name="resolution">The resolution of video recording.</param>\r
+ <param name="sourceFormat">The format of source stream.</param>\r
+ <param name="frameRate">The frame rate for encoding video stream.</param>\r
+ <param name="bitRate">The bit rate for encoding video stream.</param>\r
+ <exception cref="T:System.ArgumentException">\r
+ <paramref name="codec"/> is not valid.\n\r
+ -or-\n\r
+ <paramref name="sourceFormat"/> is not valid.\n\r
+ </exception>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ Width or height of <paramref name="resolution"/> is less than or equal to zero.\n\r
+ -or-\n\r
+ <paramref name="frameRate"/> is less than or equal to zero.\n\r
+ -or-\n\r
+ <paramref name="bitRate"/> is less than zero.\r
+ </exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.Codec">\r
+ <summary>\r
+ Gets or sets the video codec for encoding video stream.\r
+ </summary>\r
+ <value>The codec for video stream recording.</value>\r
+ <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoCodecs"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.Resolution">\r
+ <summary>\r
+ Gets or sets the resolution of the video recording.\r
+ </summary>\r
+ <value>The output resolution for video stream recording.</value>\r
+ <exception cref="T:System.ArgumentOutOfRangeException">\r
+ Width or height of <paramref name="value"/> is less than or equal to zero.\r
+ </exception>\r
+ <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoResolutions"/>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.FrameRate">\r
+ <summary>\r
+ Gets or sets the frame rate for recording media stream.\r
+ </summary>\r
+ <value>The frame rate value for video stream recording.</value>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.SourceFormat">\r
+ <summary>\r
+ Gets or sets the video source format for recording media stream.\r
+ </summary>\r
+ <value>The source format of buffers for video stream recording.</value>\r
+ <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>\r
+ </member>\r
+ <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.BitRate">\r
+ <summary>\r
+ The bit rate of the video encoder in bits per second.\r
+ </summary>\r
+ <value>The bit rate value for video stream recording. The default is 0.</value>\r
+ <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff