Artifacts/bin/public/Tizen.Multimedia.StreamRecorder.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.Multimedia.StreamRecorder</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.Multimedia.StreamRecorder">
   8             <summary>
   9             Provides the ability to record user buffer from application.
  10             </summary>
  11             <seealso cref="T:Tizen.Multimedia.Recorder"/>
  12         </member>
  13         <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedFileFormats">
  14             <summary>
  15             Gets the file formats that the current device supports.
  16             </summary>
  17             <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderFileFormat"/> representing the supported file formats.</returns>
  18         </member>
  19         <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedAudioCodecs">
  20             <summary>
  21             Gets the audio codecs that the current device supports.
  22             </summary>
  23             <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> representing the supported audio codecs.</returns>
  24         </member>
  25         <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoCodecs">
  26             <summary>
  27             Gets the video codecs that the current device supports.
  28             </summary>
  29             <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> representing the supported video codecs.</returns>
  30         </member>
  31         <member name="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoResolutions">
  32             <summary>
  33             Gets the video resolutions that the current device supports.
  34             </summary>
  35             <returns>An IEnumerable of <see cref="T:Tizen.Multimedia.Size"/> representing the supported resolutions.</returns>
  36         </member>
  37         <member name="M:Tizen.Multimedia.StreamRecorder.#ctor">
  38             <summary>
  39             Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorder"/> class.
  40             </summary>
  41             <exception cref="T:System.NotSupportedException">The feature is not supported.</exception>
  42         </member>
  43         <member name="P:Tizen.Multimedia.StreamRecorder.State">
  44             <summary>
  45             Gets the current state of the stream recorder.
  46             </summary>
  47             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
  48         </member>
  49         <member name="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)">
  50             <summary>
  51             Prepares the stream recorder with the specified options.
  52             </summary>
  53             <remarks>The recorder must be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/>.</remarks>
  54             <param name="options">The options for recording.</param>
  55             <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
  56             <exception cref="T:System.ArgumentException">Both <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> and
  57                 <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> are null.
  58             </exception>
  59             <exception cref="T:System.NotSupportedException"><paramref name="options"/> contains a value which is not supported.</exception>
  60             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
  61             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Unprepare"/>
  62             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
  63             <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>
  64             <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>
  65             <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>
  66         </member>
  67         <member name="M:Tizen.Multimedia.StreamRecorder.Unprepare">
  68             <summary>
  69             Unprepares the stream recorder.
  70             </summary>
  71             <remarks>
  72             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state by
  73             <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
  74             The recorder state will be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/>.\n
  75             \n
  76             It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Idle"/> state.
  77             </remarks>
  78             <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
  79             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
  80             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>
  81         </member>
  82         <member name="M:Tizen.Multimedia.StreamRecorder.Start">
  83             <summary>
  84             Starts recording.
  85             </summary>
  86             <remarks>
  87             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state by
  88             <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/> or
  89             <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\n
  90             \n
  91             It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state.
  92             </remarks>
  93             <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
  94             <exception cref="T:System.UnauthorizedAccessException">The access of the resources can not be granted.</exception>
  95             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
  96             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
  97             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>
  98             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>
  99         </member>
 100         <member name="M:Tizen.Multimedia.StreamRecorder.Pause">
 101             <summary>
 102             Pauses recording.
 103             </summary>
 104             <remarks>
 105             Recording can be resumed with <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.\n
 106             \n
 107             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> \n
 108             \n
 109             It has no effect if the recorder is already in the <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state.
 110             </remarks>
 111             <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
 112             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
 113             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
 114             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>
 115             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>
 116         </member>
 117         <member name="M:Tizen.Multimedia.StreamRecorder.Commit">
 118             <summary>
 119             Stops recording and saves the result.
 120             </summary>
 121             <remarks>
 122             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or
 123             <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.\n
 124             \n
 125             The recorder state will be <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> after commit.\n
 126             <para>
 127             http://tizen.org/privilege/mediastorage is needed if the save path are relevant to media storage.
 128             http://tizen.org/privilege/externalstorage is needed if the save path are relevant to external storage.
 129             </para>
 130             </remarks>
 131             <privilege>http://tizen.org/privilege/mediastorage</privilege>
 132             <privilege>http://tizen.org/privilege/externalstorage</privilege>
 133             <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
 134             <exception cref="T:System.UnauthorizedAccessException">The access to the resources can not be granted.</exception>
 135             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
 136             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
 137             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
 138         </member>
 139         <member name="M:Tizen.Multimedia.StreamRecorder.Cancel">
 140             <summary>
 141             Cancels recording.
 142             The recording data is discarded and not written.
 143             </summary>
 144             <remarks>
 145             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or
 146             <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.
 147             </remarks>
 148             <exception cref="T:System.InvalidOperationException">The recorder is not in the valid state.</exception>
 149             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
 150             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
 151             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
 152         </member>
 153         <member name="M:Tizen.Multimedia.StreamRecorder.PushBuffer(Tizen.Multimedia.MediaPacket)">
 154             <summary>
 155             Pushes a packet as recording raw data.
 156             </summary>
 157             <param name="packet">An audio or video packet to record.</param>
 158             <remarks>
 159             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.
 160             </remarks>
 161             <exception cref="T:System.InvalidOperationException">
 162                 The recorder is not in the valid state.\n
 163                 -or-\n
 164                 <paramref name="packet"/> is an audio packet but audio recording is not enabled(See <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>).\n
 165                 -or-\n
 166                 <paramref name="packet"/> is a video packet but video recording is not enabled(See <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>).\n
 167                 -or-\n
 168                 <paramref name="packet"/> is a video packet but the <see cref="P:Tizen.Multimedia.VideoMediaFormat.MimeType"/> does not match the video source format.\n
 169                 -or-\n
 170                 An internal error occurs.
 171             </exception>
 172             <exception cref="T:System.ObjectDisposedException">The <see cref="T:Tizen.Multimedia.StreamRecorder"/> has already been disposed.</exception>
 173             <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>
 174             <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>
 175             <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>
 176             <seealso cref="P:Tizen.Multimedia.StreamRecorderVideoOptions.SourceFormat"/>
 177         </member>
 178         <member name="M:Tizen.Multimedia.StreamRecorder.Dispose">
 179             <summary>
 180             Release any unmanaged resources used by this object.
 181             </summary>
 182         </member>
 183         <member name="M:Tizen.Multimedia.StreamRecorder.Dispose(System.Boolean)">
 184             <summary>
 185             Releases the resources used by the StreamRecorder.
 186             </summary>
 187             <param name="disposing">
 188             true to release both managed and unmanaged resources; false to release only unmanaged resources.
 189             </param>
 190         </member>
 191         <member name="E:Tizen.Multimedia.StreamRecorder.StateChanged">
 192             <summary>
 193             Occurs when <see cref="T:Tizen.Multimedia.StreamRecorder"/> state is changed.
 194             </summary>
 195         </member>
 196         <member name="E:Tizen.Multimedia.StreamRecorder.BufferConsumed">
 197             <summary>
 198             Occurs when a buffer had consumed completely.
 199             </summary>
 200         </member>
 201         <member name="E:Tizen.Multimedia.StreamRecorder.RecordingStatusChanged">
 202             <summary>
 203             Occurs when recording status is changed.
 204             </summary>
 205         </member>
 206         <member name="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached">
 207             <summary>
 208             Occurs when recording limit is reached.
 209             </summary>
 210         </member>
 211         <member name="E:Tizen.Multimedia.StreamRecorder.ErrorOccurred">
 212             <summary>
 213             Occurs when an error occurred during a recorder operation.
 214             </summary>
 215         </member>
 216         <member name="T:Tizen.Multimedia.StreamRecorderAudioOptions">
 217             <summary>
 218             Specifies the options associated with audio recording.
 219             </summary>
 220             <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>
 221             <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>
 222             <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>
 223         </member>
 224         <member name="M:Tizen.Multimedia.StreamRecorderAudioOptions.#ctor(Tizen.Multimedia.RecorderAudioCodec)">
 225             <summary>
 226             Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/> class with the specified codec.
 227             </summary>
 228             <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> for encoding audio stream.</param>
 229             <remarks>
 230             <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.
 231             </remarks>
 232             <exception cref="T:System.ArgumentException"><paramref name="codec"/> is not valid.</exception>
 233         </member>
 234         <member name="M:Tizen.Multimedia.StreamRecorderAudioOptions.#ctor(Tizen.Multimedia.RecorderAudioCodec,System.Int32,System.Int32,System.Int32)">
 235             <summary>
 236             Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/> class with the specified
 237             codec, sample rate, bit rate and channel value.
 238             </summary>
 239             <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> for encoding audio stream.</param>
 240             <param name="sampleRate">The sample rate for encoding audio stream.</param>
 241             <param name="bitRate">The bit rate for encoding audio stream.</param>
 242             <param name="channels">The number of channels for encoding audio stream.</param>
 243             <exception cref="T:System.ArgumentException"><paramref name="codec"/> is not valid.</exception>
 244             <exception cref="T:System.ArgumentOutOfRangeException">
 245                 <paramref name="sampleRate"/> is less than zero.\n
 246                 -or-\n
 247                 <paramref name="bitRate"/> is less than or equal to zero.\n
 248                 -or-\n
 249                 <paramref name="channels"/> is less than or equal to zero.
 250             </exception>
 251         </member>
 252         <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.Codec">
 253             <summary>
 254             Gets or sets the audio codec for encoding an audio stream.
 255             </summary>
 256             <value>The codec for audio stream recording.</value>
 257             <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
 258             <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedAudioCodecs"/>
 259         </member>
 260         <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.SampleRate">
 261             <summary>
 262             Gets or sets the sampling rate of the audio stream in hertz.
 263             </summary>
 264             <remarks>If the value is zero, the sample rate will be decided based on input buffers.</remarks>
 265             <value>The sample rate value for stream recorder. The default is zero.</value>
 266             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
 267         </member>
 268         <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.BitRate">
 269             <summary>
 270             Gets or sets the bit rate of the audio encoder in bits per second.
 271             </summary>
 272             <value>The bit rate value for audio stream recording. The default is 128000.</value>
 273             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
 274         </member>
 275         <member name="P:Tizen.Multimedia.StreamRecorderAudioOptions.Channels">
 276             <summary>
 277             Gets or sets the number of audio channels.
 278             </summary>
 279             <value>The number of audio channels for audio stream recording. The default is 2.</value>
 280             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
 281         </member>
 282         <member name="T:Tizen.Multimedia.StreamRecorderBufferConsumedEventArgs">
 283             <summary>
 284             Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.BufferConsumed"/> event.
 285             </summary>
 286         </member>
 287         <member name="P:Tizen.Multimedia.StreamRecorderBufferConsumedEventArgs.Packet">
 288             <summary>
 289             Gets the packet that has consumed.
 290             </summary>
 291         </member>
 292         <member name="T:Tizen.Multimedia.StreamRecorderError">
 293             <summary>
 294             Specifies errors for <see cref="T:Tizen.Multimedia.StreamRecorder"/>/
 295             </summary>
 296         </member>
 297         <member name="F:Tizen.Multimedia.StreamRecorderError.InternalError">
 298             <summary>
 299             Internal error.
 300             </summary>
 301         </member>
 302         <member name="F:Tizen.Multimedia.StreamRecorderError.OutOfStorage">
 303             <summary>
 304             Out of storage.
 305             </summary>
 306         </member>
 307         <member name="T:Tizen.Multimedia.StreamRecorderVideoFormat">
 308             <summary>
 309             Specifies the video source formats for <see cref="T:Tizen.Multimedia.StreamRecorder"/>.
 310             </summary>
 311         </member>
 312         <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.Nv12">
 313             <summary>
 314             Nv12 format.
 315             </summary>
 316         </member>
 317         <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.Nv21">
 318             <summary>
 319             Nv21 format.
 320             </summary>
 321         </member>
 322         <member name="F:Tizen.Multimedia.StreamRecorderVideoFormat.I420">
 323             <summary>
 324             I420 format.
 325             </summary>
 326         </member>
 327         <member name="T:Tizen.Multimedia.StreamRecorderAudioCodec">
 328             <summary>
 329             Enumeration for Audio Codec.
 330             </summary>
 331         </member>
 332         <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Amr">
 333             <summary>
 334             AMR codec.
 335             </summary>
 336         </member>
 337         <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Aac">
 338             <summary>
 339             AAC codec.
 340             </summary>
 341         </member>
 342         <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Pcm">
 343             <summary>
 344             PCM codec.
 345             </summary>
 346         </member>
 347         <member name="T:Tizen.Multimedia.StreamRecorderFileFormat">
 348             <summary>
 349             Enumeration for the file container format.
 350             </summary>
 351         </member>
 352         <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.ThreeGp">
 353             <summary>
 354             3GP file format.
 355             </summary>
 356         </member>
 357         <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Mp4">
 358             <summary>
 359             MP4 file format.
 360             </summary>
 361         </member>
 362         <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Amr">
 363             <summary>
 364             AMR file format.
 365             </summary>
 366         </member>
 367         <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Adts">
 368             <summary>
 369             ADTS file format.
 370             </summary>
 371         </member>
 372         <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Wav">
 373             <summary>
 374             WAV file format.
 375             </summary>
 376         </member>
 377         <member name="T:Tizen.Multimedia.StreamRecorderNotify">
 378             <summary>
 379             Enumeration for the recorder notify type.
 380             </summary>
 381         </member>
 382         <member name="F:Tizen.Multimedia.StreamRecorderNotify.None">
 383             <summary>
 384             None.
 385             </summary>
 386         </member>
 387         <member name="F:Tizen.Multimedia.StreamRecorderNotify.StateChanged">
 388             <summary>
 389             State changed.
 390             </summary>
 391         </member>
 392         <member name="T:Tizen.Multimedia.StreamRecorderVideoCodec">
 393             <summary>
 394             Enumeration for video codec.
 395             </summary>
 396         </member>
 397         <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.H263">
 398             <summary>
 399             H263 codec.
 400             </summary>
 401         </member>
 402         <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.Mpeg4">
 403             <summary>
 404             MPEG4 codec.
 405             </summary>
 406         </member>
 407         <member name="T:Tizen.Multimedia.StreamRecorderSourceType">
 408             <summary>
 409             Enumeration for source type.
 410             </summary>
 411         </member>
 412         <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Video">
 413             <summary>
 414             Video source
 415             </summary>
 416         </member>
 417         <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Audio">
 418             <summary>
 419             Audio source
 420             </summary>
 421         </member>
 422         <member name="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio">
 423             <summary>
 424             Audio/Video both
 425             </summary>
 426         </member>
 427         <member name="T:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs">
 428             <summary>
 429             Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.ErrorOccurred"/> event.
 430             </summary>
 431         </member>
 432         <member name="P:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs.Error">
 433             <summary>
 434             Gets the error code.
 435             </summary>
 436         </member>
 437         <member name="P:Tizen.Multimedia.StreamRecorderErrorOccurredEventArgs.State">
 438             <summary>
 439             Gets the state of the recorder.
 440             </summary>
 441         </member>
 442         <member name="T:Tizen.Multimedia.StreamRecorderOptions">
 443             <summary>
 444             Specifies the options associated with <see cref="T:Tizen.Multimedia.StreamRecorder"/>.
 445             </summary>
 446             <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>
 447             <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare(Tizen.Multimedia.StreamRecorderOptions)"/>
 448             <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>
 449             <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/>
 450         </member>
 451         <member name="M:Tizen.Multimedia.StreamRecorderOptions.#ctor(System.String,Tizen.Multimedia.RecorderFileFormat)">
 452             <summary>
 453             Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderOptions"/> class with the specified
 454             save path and file format.
 455             </summary>
 456             <param name="savePath">The path that the recording result is saved.</param>
 457             <param name="fileFormat">The file format of output file.</param>
 458             <exception cref="T:System.ArgumentNullException"><paramref name="savePath"/>is null.</exception>
 459             <exception cref="T:System.ArgumentException">
 460                 <paramref name="savePath"/>is an empty string.\n
 461                 -or-\n
 462                 <paramref name="fileFormat"/> is not valid.
 463             </exception>
 464         </member>
 465         <member name="P:Tizen.Multimedia.StreamRecorderOptions.SavePath">
 466             <summary>
 467             Gets or sets the file path to record.
 468             </summary>
 469             <remarks>
 470             If the same file already exists in the file system, then old file will be overwritten.
 471             </remarks>
 472             <exception cref="T:System.ArgumentNullException"><paramref name="value"/>is null.</exception>
 473             <exception cref="T:System.ArgumentException"><paramref name="value"/>is an empty string.</exception>
 474         </member>
 475         <member name="P:Tizen.Multimedia.StreamRecorderOptions.FileFormat">
 476             <summary>
 477             Gets or sets the file format for recording media stream.
 478             </summary>
 479             <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
 480             <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedFileFormats"/>
 481         </member>
 482         <member name="P:Tizen.Multimedia.StreamRecorderOptions.TimeLimit">
 483             <summary>
 484             Gets or sets the time limit of recording.
 485             </summary>
 486             <value>
 487             The maximum time of recording in seconds, or 0 for unlimited time.
 488             </value>
 489             <remarks>
 490             After reaching the limitation, the data which is being recorded will
 491             be discarded and not written to the file.
 492             The recorder state must be <see cref="F:Tizen.Multimedia.RecorderState.Idle"/> state.
 493             </remarks>
 494             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
 495             <seealso cref="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached"/>
 496             <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.SizeLimit"/>
 497         </member>
 498         <member name="P:Tizen.Multimedia.StreamRecorderOptions.SizeLimit">
 499             <summary>
 500             Gets or sets the maximum size of a recording file.
 501             </summary>
 502             <value>
 503             The maximum size of a recording file in kilobytes, or 0 for unlimited size.
 504             </value>
 505             <remarks>
 506             After reaching the limitation, the data which is being recorded will
 507             be discarded and not written to the file.
 508             </remarks>
 509             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
 510             <seealso cref="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached"/>
 511             <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.TimeLimit"/>
 512         </member>
 513         <member name="P:Tizen.Multimedia.StreamRecorderOptions.Audio">
 514             <summary>
 515             Gets or sets the options for audio recording.
 516             </summary>
 517             <remarks>
 518             <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> or <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> must be set for recording.
 519             </remarks>
 520             <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/>
 521         </member>
 522         <member name="P:Tizen.Multimedia.StreamRecorderOptions.Video">
 523             <summary>
 524             Gets or sets the options for video recording.
 525             </summary>
 526             <remarks>
 527             <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/> or <see cref="P:Tizen.Multimedia.StreamRecorderOptions.Video"/> must be set for recording.
 528             </remarks>
 529             <seealso cref="P:Tizen.Multimedia.StreamRecorderOptions.Audio"/>
 530         </member>
 531         <member name="T:Tizen.Multimedia.StreamRecorderStateChangedEventArgs">
 532             <summary>
 533             Provides data for the <see cref="E:Tizen.Multimedia.StreamRecorder.StateChanged"/> event.
 534             </summary>
 535         </member>
 536         <member name="P:Tizen.Multimedia.StreamRecorderStateChangedEventArgs.Previous">
 537             <summary>
 538             Gets the previous state of the stream recorder.
 539             </summary>
 540         </member>
 541         <member name="P:Tizen.Multimedia.StreamRecorderStateChangedEventArgs.Current">
 542             <summary>
 543             Gets the current state of the stream recorder.
 544             </summary>
 545         </member>
 546         <member name="T:Tizen.Multimedia.StreamRecorderVideoOptions">
 547             <summary>
 548             Specifies the options associated with video recording.
 549             </summary>
 550             <seealso cref="T:Tizen.Multimedia.StreamRecorder"/>
 551             <seealso cref="T:Tizen.Multimedia.StreamRecorderOptions"/>
 552             <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioOptions"/>
 553         </member>
 554         <member name="M:Tizen.Multimedia.StreamRecorderVideoOptions.#ctor(Tizen.Multimedia.RecorderVideoCodec,Tizen.Multimedia.Size,Tizen.Multimedia.StreamRecorderVideoFormat,System.Int32)">
 555             <summary>
 556             Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/> class with the specified
 557             codec, resolution, source format and frame rate.
 558             </summary>
 559             <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> for encoding video stream.</param>
 560             <param name="resolution">The resolution of video recording.</param>
 561             <param name="sourceFormat">The format of source stream.</param>
 562             <param name="frameRate">The frame rate for encoding video stream.</param>
 563             <remarks>
 564             <see cref="P:Tizen.Multimedia.StreamRecorderVideoOptions.BitRate"/> will be set as default.
 565             </remarks>
 566             <exception cref="T:System.ArgumentException">
 567                 <paramref name="codec"/> is not valid.\n
 568                 -or-\n
 569                 <paramref name="sourceFormat"/> is not valid.\n
 570             </exception>
 571             <exception cref="T:System.ArgumentOutOfRangeException">
 572                 Width or height of <paramref name="resolution"/> is less than or equal to zero.\n
 573                 -or-\n
 574                 <paramref name="frameRate"/> is less than or equal to zero.\n
 575             </exception>
 576         </member>
 577         <member name="M:Tizen.Multimedia.StreamRecorderVideoOptions.#ctor(Tizen.Multimedia.RecorderVideoCodec,Tizen.Multimedia.Size,Tizen.Multimedia.StreamRecorderVideoFormat,System.Int32,System.Int32)">
 578             <summary>
 579             Initialize a new instance of the <see cref="T:Tizen.Multimedia.StreamRecorderVideoOptions"/> class with the specified
 580             codec, resolution, source format, frame rate and bit rate.
 581             </summary>
 582             <param name="codec">The <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> for encoding video stream.</param>
 583             <param name="resolution">The resolution of video recording.</param>
 584             <param name="sourceFormat">The format of source stream.</param>
 585             <param name="frameRate">The frame rate for encoding video stream.</param>
 586             <param name="bitRate">The bit rate for encoding video stream.</param>
 587             <exception cref="T:System.ArgumentException">
 588                 <paramref name="codec"/> is not valid.\n
 589                 -or-\n
 590                 <paramref name="sourceFormat"/> is not valid.\n
 591             </exception>
 592             <exception cref="T:System.ArgumentOutOfRangeException">
 593                 Width or height of <paramref name="resolution"/> is less than or equal to zero.\n
 594                 -or-\n
 595                 <paramref name="frameRate"/> is less than or equal to zero.\n
 596                 -or-\n
 597                 <paramref name="bitRate"/> is less than zero.
 598             </exception>
 599         </member>
 600         <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.Codec">
 601             <summary>
 602             Gets or sets the video codec for encoding video stream.
 603             </summary>
 604             <value>The codec for video stream recording.</value>
 605             <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
 606             <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoCodecs"/>
 607         </member>
 608         <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.Resolution">
 609             <summary>
 610             Gets or sets the resolution of the video recording.
 611             </summary>
 612             <value>The output resolution for video stream recording.</value>
 613             <exception cref="T:System.ArgumentOutOfRangeException">
 614                 Width or height of <paramref name="value"/> is less than or equal to zero.
 615             </exception>
 616             <seealso cref="M:Tizen.Multimedia.StreamRecorder.GetSupportedVideoResolutions"/>
 617         </member>
 618         <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.FrameRate">
 619             <summary>
 620             Gets or sets the frame rate for recording media stream.
 621             </summary>
 622             <value>The frame rate value for video stream recording.</value>
 623             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than or equal to zero.</exception>
 624         </member>
 625         <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.SourceFormat">
 626             <summary>
 627             Gets or sets the video source format for recording media stream.
 628             </summary>
 629             <value>The source format of buffers for video stream recording.</value>
 630             <exception cref="T:System.ArgumentException"><paramref name="value"/> is not valid.</exception>
 631         </member>
 632         <member name="P:Tizen.Multimedia.StreamRecorderVideoOptions.BitRate">
 633             <summary>
 634             The bit rate of the video encoder in bits per second.
 635             </summary>
 636             <value>The bit rate value for video stream recording. The default is 0.</value>
 637             <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> is less than zero.</exception>
 638         </member>
 639     </members>
 640 </doc>