4 <name>Tizen.Multimedia.StreamRecorder</name>
7 <member name="T:Tizen.Multimedia.StreamRecorder">
9 Provides methods to control stream recorder.
12 StreamRecorder class provides functions to record raw image frame
13 also provides recording start, stop and save the content etc.
16 <member name="F:Tizen.Multimedia.StreamRecorder._recordingStatusChanged">
18 Occurred when recording is progressing for recording status.
21 <member name="F:Tizen.Multimedia.StreamRecorder._recordingLimitReached">
23 Occurred when recording time or size reach limit.
26 <member name="F:Tizen.Multimedia.StreamRecorder._bufferConsumed">
28 Occurred when streamrecorder complete to use pushed buffer.
31 <member name="F:Tizen.Multimedia.StreamRecorder._recorderNotified">
33 Occurred when streamrecorder state is changed.
36 <member name="F:Tizen.Multimedia.StreamRecorder._recordingErrorOccurred">
38 Occurred when error is occured.
41 <member name="M:Tizen.Multimedia.StreamRecorder.#ctor">
43 Stream recorder constructor.
46 <member name="M:Tizen.Multimedia.StreamRecorder.Finalize">
48 Stream recorder destructor.
51 <member name="E:Tizen.Multimedia.StreamRecorder.RecorderNotified">
53 Event that occurs when streamrecorder state is changed.
56 <member name="E:Tizen.Multimedia.StreamRecorder.BufferConsumed">
58 Event that occurs when buffer had comsumed completely.
61 <member name="E:Tizen.Multimedia.StreamRecorder.RecordingStatusChanged">
63 Event that occurs when recording status changed.
66 <member name="E:Tizen.Multimedia.StreamRecorder.RecordingLimitReached">
68 Event that occurs when recording limit is reached.
71 <member name="E:Tizen.Multimedia.StreamRecorder.RecordingErrorOccurred">
73 Event that occurs when an error occured during recorder operation.
76 <member name="P:Tizen.Multimedia.StreamRecorder.FilePath">
78 The file path to record.
81 If the same file already exists in the file system, then old file
85 <!-- Badly formed XML comment ignored for member "P:Tizen.Multimedia.StreamRecorder.State" -->
86 <member name="P:Tizen.Multimedia.StreamRecorder.FileFormat">
88 Get/Set the file format for recording media stream.
91 Must set <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>.
92 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
94 <exception cref="T:System.ArgumentException">The format does not valid.</exception>
95 <seealso cref="P:Tizen.Multimedia.StreamRecorder.SupportedFileFormats"/>
97 <member name="P:Tizen.Multimedia.StreamRecorder.AudioCodec">
99 The audio codec for encoding an audio stream.
102 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Audio"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
103 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>
105 <exception cref="T:System.ArgumentException">The codec does not valid.</exception>
106 <seealso cref="P:Tizen.Multimedia.StreamRecorder.SupportedAudioEncodings"/>
108 <member name="P:Tizen.Multimedia.StreamRecorder.VideoCodec">
110 The video codec for encoding video stream.
113 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Video"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
114 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>
116 <exception cref="T:System.ArgumentException">The codec does not valid.</exception>
117 <seealso cref="P:Tizen.Multimedia.StreamRecorder.SupportedVideoEncodings"/>
119 <member name="P:Tizen.Multimedia.StreamRecorder.SizeLimit">
121 The maximum size of a recording file in KB(kilobytes). If 0, means
122 unlimited recording size.
125 After reaching the limitation, the data which is being recorded will
126 be discarded and not written to the file.
127 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
129 <exception cref="T:System.ArgumentException">The value set to below 0.</exception>
130 <seealso cref="T:Tizen.Multimedia.StreamRecordingLimitReachedEventArgs"/>
132 <member name="P:Tizen.Multimedia.StreamRecorder.TimeLimit">
134 The time limit of a recording file in Seconds. If 0, means unlimited recording
138 After reaching the limitation, the data which is being recorded will
139 be discarded and not written to the file.
140 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
142 <exception cref="T:System.ArgumentException">The value set to below 0.</exception>
143 <seealso cref="T:Tizen.Multimedia.StreamRecordingLimitReachedEventArgs"/>
145 <member name="P:Tizen.Multimedia.StreamRecorder.AudioSampleRate">
147 The sampling rate of an audio stream in hertz.
150 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
151 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Audio"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
152 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>.
154 <exception cref="T:System.ArgumentException">The value set to below 0.</exception>
156 <member name="P:Tizen.Multimedia.StreamRecorder.AudioBitRate">
158 The bitrate of an audio encoder in bits per second.
161 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
162 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Audio"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
163 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>
165 <exception cref="T:System.ArgumentException">The value set to below 0.</exception>
167 <member name="P:Tizen.Multimedia.StreamRecorder.VideoBitRate">
169 The bitrate of an video encoder in bits per second.
172 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
173 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Video"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
174 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>
176 <exception cref="T:System.ArgumentException">The value set to below 0.</exception>
178 <member name="P:Tizen.Multimedia.StreamRecorder.VideoFrameRate">
180 The video frame rate for recording media stream.
183 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
184 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Video"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
185 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>
187 <exception cref="T:System.NotSupportedException">The value set to below 0.</exception>
189 <member name="P:Tizen.Multimedia.StreamRecorder.VideoSourceFormat">
191 Get or Set the video source format for recording media stream.
193 <exception cref="T:System.ArgumentException">The value set to a invalid value.</exception>
194 <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoSourceFormat"/>
196 <member name="P:Tizen.Multimedia.StreamRecorder.AudioChannel">
198 The number of audio channel.
201 The attribute is applied only in Created state.
202 For mono recording, set channel to 1.
203 For stereo recording, set channel to 2.
204 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
206 <exception cref="T:System.ArgumentException">The value set to a invalid value.</exception>
208 <member name="P:Tizen.Multimedia.StreamRecorder.Resolution">
210 Video resolution of the video recording.
213 Must set <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.Video"/> or <see cref="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio"/>
214 by <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>
215 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/> state.
217 <exception cref="T:System.ArgumentException">The value set to a invalid value.</exception>
218 <seealso cref="P:Tizen.Multimedia.StreamRecorder.SupportedVideoResolutions"/>
220 <member name="P:Tizen.Multimedia.StreamRecorder.SupportedFileFormats">
222 Retrieves all the file formats supported by the stream recorder.
225 It returns a list containing all the supported file
226 formats by Stream recorder.
228 <seealso cref="T:Tizen.Multimedia.StreamRecorderFileFormat"/>
230 <member name="P:Tizen.Multimedia.StreamRecorder.SupportedAudioEncodings">
232 Retrieves all the audio encoders supported by the recorder.
235 It returns a list containing all the supported audio encoders
238 <seealso cref="T:Tizen.Multimedia.StreamRecorderAudioCodec"/>
240 <member name="P:Tizen.Multimedia.StreamRecorder.SupportedVideoEncodings">
242 Retrieves all the video encoders supported by the recorder.
245 It returns a list containing all the supported video encoders
248 <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoCodec"/>
250 <member name="P:Tizen.Multimedia.StreamRecorder.SupportedVideoResolutions">
252 Retrieves all the video resolutions supported by the recorder.
255 It returns videoresolution list containing the width and height of
256 different resolutions supported by recorder.
258 <seealso cref="T:Tizen.Multimedia.StreamRecorderVideoResolution"/>
260 <member name="M:Tizen.Multimedia.StreamRecorder.Prepare">
262 Prepare the stream recorder.
265 Before calling the function, it is required to set <see cref="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)"/>,
266 <see cref="T:Tizen.Multimedia.StreamRecorderAudioCodec"/>, <see cref="T:Tizen.Multimedia.StreamRecorderVideoCodec"/> and <see cref="T:Tizen.Multimedia.StreamRecorderFileFormat"/> properties of recorder.
268 <exception cref="T:System.InvalidOperationException">The streamrecorder is not in the valid state.</exception>
269 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Unprepare"/>
271 <member name="M:Tizen.Multimedia.StreamRecorder.Unprepare">
273 Resets the stream recorder.
276 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Prepared"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare"/>, <see cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/> and <see cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>.
277 The StreamRecorder state will be <see cref="F:Tizen.Multimedia.StreamRecorderState.Created"/>.
279 <exception cref="T:System.InvalidOperationException">The streamrecorder is not in the valid state.</exception>
280 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Prepare"/>
282 <member name="M:Tizen.Multimedia.StreamRecorder.Start">
284 Starts the recording.
287 If file path has been set to an existing file, this file is removed automatically and updated by new one.
288 The filename should be set before this function is invoked.
289 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Prepared"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Prepare"/> or
290 <see cref="F:Tizen.Multimedia.StreamRecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>.
291 The filename shuild be set by <see cref="P:Tizen.Multimedia.StreamRecorder.FilePath"/>
293 <exception cref="T:System.InvalidOperationException">The streamrecorder is not in the valid state.</exception>
294 <exception cref="T:System.UnauthorizedAccessException">The access ot the resources can not be granted.</exception>
295 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
296 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>
297 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>
298 <seealso cref="P:Tizen.Multimedia.StreamRecorder.FilePath"/>
299 <seealso cref="P:Tizen.Multimedia.StreamRecorder.FileFormat"/>
301 <member name="M:Tizen.Multimedia.StreamRecorder.Pause">
306 Recording can be resumed with <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/>.
308 <exception cref="T:System.InvalidOperationException">The streamrecorder is not in the valid state.</exception>
309 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
310 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Commit"/>
311 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Cancel"/>
313 <member name="M:Tizen.Multimedia.StreamRecorder.Commit">
315 Stops recording and saves the result.
318 The recorder state must be <see cref="F:Tizen.Multimedia.StreamRecorderState.Recording"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Start"/> or
319 <see cref="F:Tizen.Multimedia.StreamRecorderState.Paused"/> state by <see cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
320 When you want to record audio or video file, you need to add privilege according to rules below additionally.
322 http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage.
323 http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage.
326 <exception cref="T:System.InvalidOperationException">The streamrecorder is not in the valid state.</exception>
327 <exception cref="T:System.UnauthorizedAccessException">The access ot the resources can not be granted.</exception>
328 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
329 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
331 <member name="M:Tizen.Multimedia.StreamRecorder.Cancel">
333 Cancels the recording.
334 The recording data is discarded and not written in the recording file.
336 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Start"/>
337 <seealso cref="M:Tizen.Multimedia.StreamRecorder.Pause"/>
339 <member name="M:Tizen.Multimedia.StreamRecorder.PushBuffer(Tizen.Multimedia.MediaPacket)">
341 Push stream buffer as recording raw data.
344 <member name="M:Tizen.Multimedia.StreamRecorder.EnableSourceBuffer(Tizen.Multimedia.StreamRecorderSourceType)">
346 Set the source type of pushed data.
349 <member name="M:Tizen.Multimedia.StreamRecorder.Dispose">
351 Release any unmanaged resources used by this object.
354 <member name="T:Tizen.Multimedia.StreamRecorderAudioCodec">
356 Enumeration for Audio Codec.
359 <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Amr">
364 <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Aac">
369 <member name="F:Tizen.Multimedia.StreamRecorderAudioCodec.Pcm">
374 <member name="T:Tizen.Multimedia.StreamRecorderFileFormat">
376 Enumeration for the file container format.
379 <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.ThreeGp">
384 <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Mp4">
389 <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Amr">
394 <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Adts">
399 <member name="F:Tizen.Multimedia.StreamRecorderFileFormat.Wav">
404 <member name="T:Tizen.Multimedia.StreamRecorderNotify">
406 Enumeration for the recorder notify type.
409 <member name="F:Tizen.Multimedia.StreamRecorderNotify.None">
414 <member name="F:Tizen.Multimedia.StreamRecorderNotify.StateChanged">
419 <member name="T:Tizen.Multimedia.StreamRecordingLimitType">
421 Enumeration for the recording limit type.
424 <member name="F:Tizen.Multimedia.StreamRecordingLimitType.Time">
426 Time limit in seconds of recording file
429 <member name="F:Tizen.Multimedia.StreamRecordingLimitType.Size">
431 Size limit in KB(KiloBytes) of recording file.
434 <member name="T:Tizen.Multimedia.StreamRecorderState">
436 Enumeration for stream recorder states.
439 <member name="F:Tizen.Multimedia.StreamRecorderState.None">
441 Stream recorder is not created.
444 <member name="F:Tizen.Multimedia.StreamRecorderState.Created">
446 Stream recorder is created, but not prepared.
449 <member name="F:Tizen.Multimedia.StreamRecorderState.Prepared">
451 Stream recorder is ready to record.
454 <member name="F:Tizen.Multimedia.StreamRecorderState.Recording">
456 Stream recorder is recording pushed packet.
459 <member name="F:Tizen.Multimedia.StreamRecorderState.Paused">
461 Stream recorder is paused.
464 <member name="T:Tizen.Multimedia.StreamRecorderVideoCodec">
466 Enumeration for video codec.
469 <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.H263">
474 <member name="F:Tizen.Multimedia.StreamRecorderVideoCodec.Mpeg4">
479 <member name="T:Tizen.Multimedia.StreamRecorderSourceType">
481 Enumeration for source type.
484 <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Video">
489 <member name="F:Tizen.Multimedia.StreamRecorderSourceType.Audio">
494 <member name="F:Tizen.Multimedia.StreamRecorderSourceType.VideoAudio">
499 <member name="T:Tizen.Multimedia.StreamRecorderVideoSourceFormat">
501 Enumeration for video source format.
504 <member name="F:Tizen.Multimedia.StreamRecorderVideoSourceFormat.Nv12">
506 Nv12 Video source format
509 <member name="F:Tizen.Multimedia.StreamRecorderVideoSourceFormat.Nv21">
511 Nv21 video source format
514 <member name="F:Tizen.Multimedia.StreamRecorderVideoSourceFormat.I420">
516 I420 video source format
519 <member name="T:Tizen.Multimedia.StreamRecorderErrorCode">
521 Enumeration for stream recorder failure error.
524 <member name="F:Tizen.Multimedia.StreamRecorderErrorCode.None">
529 <member name="F:Tizen.Multimedia.StreamRecorderErrorCode.InvalidParameter">
534 <member name="F:Tizen.Multimedia.StreamRecorderErrorCode.InvalidOperation">
539 <member name="F:Tizen.Multimedia.StreamRecorderErrorCode.OutOfMemory">
544 <member name="T:Tizen.Multimedia.StreamRecorderNotifiedEventArgs">
546 An extended Eventargs class which contains interrupted policy details, previous and current
547 state of the recorder.
550 <member name="P:Tizen.Multimedia.StreamRecorderNotifiedEventArgs.Previous">
552 The previous state of the stream recorder.
555 <member name="P:Tizen.Multimedia.StreamRecorderNotifiedEventArgs.Current">
557 The current state of the stream recorder.
560 <member name="P:Tizen.Multimedia.StreamRecorderNotifiedEventArgs.Notify">
562 The notify of the event.
565 <member name="T:Tizen.Multimedia.StreamRecorderVideoResolution">
567 Resolution for stream recorder.
570 <member name="P:Tizen.Multimedia.StreamRecorderVideoResolution.Width">
574 <value>The width.</value>
576 <member name="P:Tizen.Multimedia.StreamRecorderVideoResolution.Height">
580 <value>The height.</value>
582 <member name="T:Tizen.Multimedia.StreamRecordingBufferConsumedEventArgs">
584 An extended EventArgs.
587 <member name="P:Tizen.Multimedia.StreamRecordingBufferConsumedEventArgs.Buffer">
592 <member name="T:Tizen.Multimedia.StreamRecordingErrorOccurredEventArgs">
594 An extended EventArgs class which contains details about error status and
595 state of the recorder when it failed.
598 <member name="P:Tizen.Multimedia.StreamRecordingErrorOccurredEventArgs.Error">
603 <member name="P:Tizen.Multimedia.StreamRecordingErrorOccurredEventArgs.State">
605 The state of the recorder.
608 <member name="T:Tizen.Multimedia.StreamRecordingLimitReachedEventArgs">
610 An extended EventArgs class containing details about the recording limit.
613 <member name="P:Tizen.Multimedia.StreamRecordingLimitReachedEventArgs.Type">