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