4 <name>Tizen.Multimedia.Recorder</name>
7 <member name="T:Tizen.Multimedia.AudioStreamDeliveredEventArgs">
9 An extended EventArgs class containing details of audio stream.
12 <member name="P:Tizen.Multimedia.AudioStreamDeliveredEventArgs.Stream">
14 The audio stream data.
16 <since_tizen> 3 </since_tizen>
18 <member name="P:Tizen.Multimedia.AudioStreamDeliveredEventArgs.StreamLength">
20 The length of audio stream data.
22 <since_tizen> 3 </since_tizen>
24 <member name="P:Tizen.Multimedia.AudioStreamDeliveredEventArgs.Type">
26 The audio format type.
28 <since_tizen> 3 </since_tizen>
30 <member name="P:Tizen.Multimedia.AudioStreamDeliveredEventArgs.Channel">
32 The number of channels.
34 <since_tizen> 3 </since_tizen>
36 <member name="P:Tizen.Multimedia.AudioStreamDeliveredEventArgs.RecordingTime">
38 The recording time of the stream buffer in milliseconds.
40 <since_tizen> 3 </since_tizen>
42 <member name="T:Tizen.Multimedia.MuxedStreamDeliveredEventArgs">
44 An extended EventArgs class containing details of muxed stream(Audio + Video).
47 <member name="P:Tizen.Multimedia.MuxedStreamDeliveredEventArgs.Stream">
49 The muexed stream data.
51 <since_tizen> 3 </since_tizen>
53 <member name="P:Tizen.Multimedia.MuxedStreamDeliveredEventArgs.StreamLength">
55 The length of muxed stream data.
57 <since_tizen> 3 </since_tizen>
59 <member name="P:Tizen.Multimedia.MuxedStreamDeliveredEventArgs.Offset">
61 The offset of the stream data.
63 <since_tizen> 3 </since_tizen>
65 <member name="T:Tizen.Multimedia.Recorder">
67 The recorder class provides methods to create audio/video recorder,
68 to start, stop and save the recorded content. It also provides methods
69 to get/set various attributes and capabilities of recorder.
72 <member name="M:Tizen.Multimedia.Recorder.#ctor">
74 Audio recorder constructor.
77 <member name="M:Tizen.Multimedia.Recorder.#ctor(Tizen.Multimedia.Camera)">
79 Video recorder constructor.
85 <member name="M:Tizen.Multimedia.Recorder.Finalize">
90 <member name="M:Tizen.Multimedia.Recorder.Dispose(System.Boolean)">
92 Releases the unmanaged resources used by the Recorder.
94 <param name="disposing">true to release both managed and unmanaged resources; false to release only unmanaged resources.</param>
96 <member name="M:Tizen.Multimedia.Recorder.Dispose">
98 Releases all resources used by the Recorder.
100 <since_tizen> 3 </since_tizen>
102 <member name="E:Tizen.Multimedia.Recorder.ErrorOccurred">
104 Event that occurs when an error occurs during recorder operation.
106 <since_tizen> 3 </since_tizen>
108 <member name="E:Tizen.Multimedia.Recorder.Interrupted">
110 Event that occurs when recorder is interrupted.
112 <since_tizen> 3 </since_tizen>
114 <member name="E:Tizen.Multimedia.Recorder.StateChanged">
116 This event occurs when recorder state is changed.
118 <since_tizen> 3 </since_tizen>
120 <member name="E:Tizen.Multimedia.Recorder.RecordingProgress">
122 Event that occurs when recording information changes.
124 <since_tizen> 3 </since_tizen>
126 <member name="E:Tizen.Multimedia.Recorder.AudioStreamDelivered">
128 Event that occurs when audio stream data is being delivered.
130 <since_tizen> 3 </since_tizen>
132 <member name="E:Tizen.Multimedia.Recorder.RecordingLimitReached">
134 Event that occurs when recording limit is reached.
136 <since_tizen> 3 </since_tizen>
138 <member name="E:Tizen.Multimedia.Recorder.MuxedStreamDelivered">
140 Event that occurs when muxed stream data is being delivered.
142 <since_tizen> 3 </since_tizen>
144 <member name="P:Tizen.Multimedia.Recorder.Feature">
146 Gets the various recorder features.
148 <since_tizen> 3 </since_tizen>
150 <member name="P:Tizen.Multimedia.Recorder.Setting">
152 Get/Set the various recorder settings.
154 <since_tizen> 3 </since_tizen>
156 <member name="P:Tizen.Multimedia.Recorder.State">
158 The current state of the recorder.
160 <since_tizen> 3 </since_tizen>
161 <value>A <see cref="T:Tizen.Multimedia.RecorderState"/> that specifies the state of recorder.</value>
162 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
164 <member name="M:Tizen.Multimedia.Recorder.Prepare">
166 Prepare the media recorder for recording.
167 The recorder must be in the <see cref="F:Tizen.Multimedia.RecorderState.Created"/> state.
168 After this method is finished without any exception,
169 The state of recorder will be changed to <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state.
171 <since_tizen> 3 </since_tizen>
173 Before calling the function, it is required to set AudioEncoder,
174 videoencoder and fileformat properties of recorder.
176 <exception cref="T:System.InvalidOperationException">In case of any invalid operations.</exception>
177 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
179 <member name="M:Tizen.Multimedia.Recorder.Unprepare">
181 Resets the media recorder.
182 The recorder must be in the <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state.
183 After this method is finished without any exception,
184 The state of recorder will be changed to <see cref="F:Tizen.Multimedia.RecorderState.Created"/> state.
186 <since_tizen> 3 </since_tizen>
187 <exception cref="T:System.InvalidOperationException">In case of any invalid operations.</exception>
188 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
190 <member name="M:Tizen.Multimedia.Recorder.Start">
192 Starts the recording.
193 The recorder must be in the <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state.
194 After this method is finished without any exception,
195 The state of recorder will be changed to <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state.
197 <since_tizen> 3 </since_tizen>
199 If file path has been set to an existing file, this file is removed automatically and updated by new one.
200 In the video recorder, some preview format does not support record mode. It will return InvalidOperation error.
201 You should use default preview format or CameraPixelFormatNv12 in the record mode.
202 The filename should be set before this function is invoked.
205 http://tizen.org/privilege/recorder
207 <exception cref="T:System.InvalidOperationException">In case of any invalid operations.</exception>
208 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
209 <exception cref="T:System.UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
211 <member name="M:Tizen.Multimedia.Recorder.Pause">
214 The recorder must be in the <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> state.
215 After this method is finished without any exception,
216 The state of recorder will be changed to <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state.
218 <since_tizen> 3 </since_tizen>
220 Recording can be resumed with Start().
223 http://tizen.org/privilege/recorder
225 <exception cref="T:System.InvalidOperationException">In case of any invalid operations.</exception>
226 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
227 <exception cref="T:System.UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
229 <member name="M:Tizen.Multimedia.Recorder.Commit">
231 Stops recording and saves the result.
232 The recorder must be in the <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> or <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state.
233 After this method is finished without any exception,
234 The state of recorder will be changed to <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state.
236 <since_tizen> 3 </since_tizen>
238 http://tizen.org/privilege/recorder
240 <exception cref="T:System.InvalidOperationException">In case of any invalid operations.</exception>
241 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
242 <exception cref="T:System.UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
244 <member name="M:Tizen.Multimedia.Recorder.Cancel">
246 Cancels the recording.
247 The recording data is discarded and not written in the recording file.
248 The recorder must be in the <see cref="F:Tizen.Multimedia.RecorderState.Recording"/> or <see cref="F:Tizen.Multimedia.RecorderState.Paused"/> state.
249 After this method is finished without any exception,
250 The state of recorder will be changed to <see cref="F:Tizen.Multimedia.RecorderState.Ready"/> state.
252 <since_tizen> 3 </since_tizen>
254 http://tizen.org/privilege/recorder
256 <exception cref="T:System.InvalidOperationException">In case of any invalid operations.</exception>
257 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
258 <exception cref="T:System.UnauthorizedAccessException">In case of access to the resources cannot be granted.</exception>
260 <member name="M:Tizen.Multimedia.Recorder.SetAudioStreamPolicy(Tizen.Multimedia.AudioStreamPolicy)">
262 Sets the audio stream policy.
264 <since_tizen> 3 </since_tizen>
265 <param name="policy">Policy.</param>
266 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
268 <member name="T:Tizen.Multimedia.RecorderAudioCodec">
270 Enumeration for Audio Codec.
272 <since_tizen> 3 </since_tizen>
274 <member name="F:Tizen.Multimedia.RecorderAudioCodec.Disable">
279 <member name="F:Tizen.Multimedia.RecorderAudioCodec.Amr">
284 <member name="F:Tizen.Multimedia.RecorderAudioCodec.Aac">
289 <member name="F:Tizen.Multimedia.RecorderAudioCodec.Vorbis">
294 <member name="F:Tizen.Multimedia.RecorderAudioCodec.Pcm">
299 <member name="F:Tizen.Multimedia.RecorderAudioCodec.Mp3">
304 <member name="T:Tizen.Multimedia.RecorderAudioDevice">
306 Enumeration for Audio capture devices.
308 <since_tizen> 3 </since_tizen>
310 <member name="F:Tizen.Multimedia.RecorderAudioDevice.Mic">
312 Capture audio from Mic device.
315 <member name="F:Tizen.Multimedia.RecorderAudioDevice.Modem">
317 Capture audio from modem.
320 <member name="T:Tizen.Multimedia.RecorderFileFormat">
322 Enumeration for the file container format.
324 <since_tizen> 3 </since_tizen>
326 <member name="F:Tizen.Multimedia.RecorderFileFormat.ThreeGp">
331 <member name="F:Tizen.Multimedia.RecorderFileFormat.Mp4">
336 <member name="F:Tizen.Multimedia.RecorderFileFormat.Amr">
341 <member name="F:Tizen.Multimedia.RecorderFileFormat.Adts">
346 <member name="F:Tizen.Multimedia.RecorderFileFormat.Wav">
351 <member name="F:Tizen.Multimedia.RecorderFileFormat.Ogg">
356 <member name="F:Tizen.Multimedia.RecorderFileFormat.M2ts">
361 <member name="T:Tizen.Multimedia.RecorderPolicy">
363 Enumeration for the recorder policy.
365 <since_tizen> 3 </since_tizen>
367 <member name="F:Tizen.Multimedia.RecorderPolicy.None">
372 <member name="F:Tizen.Multimedia.RecorderPolicy.Security">
377 <member name="F:Tizen.Multimedia.RecorderPolicy.ResourceConflict">
379 Resource conflict policy.
382 <member name="T:Tizen.Multimedia.RecordingLimitType">
384 Enumeration for the recording limit.
386 <since_tizen> 3 </since_tizen>
388 <member name="F:Tizen.Multimedia.RecordingLimitType.Time">
390 Time limit in seconds of recording file
393 <member name="F:Tizen.Multimedia.RecordingLimitType.Size">
395 Size limit in KB(KiloBytes) of recording file.
398 <member name="F:Tizen.Multimedia.RecordingLimitType.Space">
400 No free space in storage.
403 <member name="T:Tizen.Multimedia.RecorderState">
405 Enumeration for recorder states.
407 <since_tizen> 3 </since_tizen>
409 <member name="F:Tizen.Multimedia.RecorderState.None">
411 Recorder is not created.
414 <member name="F:Tizen.Multimedia.RecorderState.Created">
416 Recorder is created, but not prepared.
419 <member name="F:Tizen.Multimedia.RecorderState.Ready">
421 Recorder is ready to record. In case of video recorder,
422 preview display will be shown.
425 <member name="F:Tizen.Multimedia.RecorderState.Recording">
427 Recorder is recording media.
430 <member name="F:Tizen.Multimedia.RecorderState.Paused">
432 Recorder is paused while recording media.
435 <member name="T:Tizen.Multimedia.RecorderVideoCodec">
437 Enumeration for video codec.
439 <since_tizen> 3 </since_tizen>
441 <member name="F:Tizen.Multimedia.RecorderVideoCodec.H263">
446 <member name="F:Tizen.Multimedia.RecorderVideoCodec.H264">
451 <member name="F:Tizen.Multimedia.RecorderVideoCodec.Mpeg4">
456 <member name="F:Tizen.Multimedia.RecorderVideoCodec.Theora">
461 <member name="T:Tizen.Multimedia.RecorderErrorCode">
463 Enumeration for recorder failure error.
465 <since_tizen> 3 </since_tizen>
467 <member name="F:Tizen.Multimedia.RecorderErrorCode.DeviceError">
472 <member name="F:Tizen.Multimedia.RecorderErrorCode.InvalidOperation">
477 <member name="F:Tizen.Multimedia.RecorderErrorCode.OutOfMemory">
482 <member name="T:Tizen.Multimedia.RecorderFeatures">
484 The camera setting class provides methods/properties to get and
485 set basic camera attributes.
488 <member name="P:Tizen.Multimedia.RecorderFeatures.SupportedFileFormats">
490 Retrieves all the file formats supported by the recorder.
492 <since_tizen> 3 </since_tizen>
494 It returns a list containing all the supported <see cref="T:Tizen.Multimedia.RecorderFileFormat"/>.
496 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
498 <member name="P:Tizen.Multimedia.RecorderFeatures.SupportedAudioEncodings">
500 Retrieves all the audio encoders supported by the recorder.
502 <since_tizen> 3 </since_tizen>
504 It returns a list containing all the supported <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/>.
506 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
508 <member name="P:Tizen.Multimedia.RecorderFeatures.SupportedVideoEncodings">
510 Retrieves all the video encoders supported by the recorder.
512 <since_tizen> 3 </since_tizen>
514 It returns a list containing all the supported <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/>.
517 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
519 <member name="P:Tizen.Multimedia.RecorderFeatures.SupportedVideoResolutions">
521 Retrieves all the video resolutions supported by the recorder.
523 <since_tizen> 3 </since_tizen>
525 It returns videoresolution list containing the width and height of
526 different resolutions supported by recorder.
528 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
530 <member name="T:Tizen.Multimedia.RecorderInterruptedEventArgs">
532 An extended Eventargs class which contains interrupted policy details, previous and current
533 state of the recorder.
536 <member name="P:Tizen.Multimedia.RecorderInterruptedEventArgs.Policy">
538 The policy that interrupted the recorder.
540 <since_tizen> 3 </since_tizen>
542 <member name="P:Tizen.Multimedia.RecorderInterruptedEventArgs.Previous">
544 The previous state of the recorder.
546 <since_tizen> 3 </since_tizen>
548 <member name="P:Tizen.Multimedia.RecorderInterruptedEventArgs.Current">
550 The current state of the recorder.
552 <since_tizen> 3 </since_tizen>
554 <member name="T:Tizen.Multimedia.RecorderSettings">
556 The camera setting class provides methods/properties to get and
557 set basic camera attributes.
560 <member name="P:Tizen.Multimedia.RecorderSettings.AudioChannel">
562 The number of audio channel.
564 <since_tizen> 3 </since_tizen>
566 For mono recording, set channel to 1.
567 For stereo recording, set channel to 2.
569 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
571 <member name="P:Tizen.Multimedia.RecorderSettings.AudioDevice">
573 The audio device for recording.
575 <since_tizen> 3 </since_tizen>
576 <value>A <see cref="T:Tizen.Multimedia.RecorderAudioDevice"/> that specifies the type of audio device.</value>
577 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
579 <member name="P:Tizen.Multimedia.RecorderSettings.AudioLevel">
581 Get the peak audio input level in dB
583 <since_tizen> 3 </since_tizen>
585 0dB indicates maximum input level, -300dB indicates minimum input level.
587 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
589 <member name="P:Tizen.Multimedia.RecorderSettings.AudioSampleRate">
591 The sampling rate of an audio stream in hertz.
593 <since_tizen> 3 </since_tizen>
594 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
596 <member name="P:Tizen.Multimedia.RecorderSettings.AudioBitRate">
598 The bitrate of an audio encoder in bits per second.
600 <since_tizen> 3 </since_tizen>
601 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
603 <member name="P:Tizen.Multimedia.RecorderSettings.VideoBitRate">
605 The bitrate of an video encoder in bits per second.
607 <since_tizen> 3 </since_tizen>
608 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
610 <member name="P:Tizen.Multimedia.RecorderSettings.AudioCodec">
612 The audio codec for encoding an audio stream.
614 <since_tizen> 3 </since_tizen>
615 <value>A <see cref="T:Tizen.Multimedia.RecorderAudioCodec"/> that specifies the type of audio codec.</value>
616 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
618 <member name="P:Tizen.Multimedia.RecorderSettings.VideoCodec">
620 The video codec for encoding video stream.
622 <since_tizen> 3 </since_tizen>
623 <value>A <see cref="T:Tizen.Multimedia.RecorderVideoCodec"/> that specifies the type of video codec.</value>
624 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
626 <member name="P:Tizen.Multimedia.RecorderSettings.FileFormat">
628 The file format for recording media stream.
630 <since_tizen> 3 </since_tizen>
631 <value>A <see cref="T:Tizen.Multimedia.RecorderFileFormat"/> that specifies the file format.</value>
632 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
634 <member name="P:Tizen.Multimedia.RecorderSettings.FilePath">
636 The file path to record.
638 <since_tizen> 3 </since_tizen>
640 If the same file already exists in the file system, then old file
643 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
645 <member name="P:Tizen.Multimedia.RecorderSettings.SizeLimit">
647 The maximum size of a recording file in KB(kilobytes). If 0, means
648 unlimited recording size.
650 <since_tizen> 3 </since_tizen>
652 After reaching the limitation, the data which is being recorded will
653 be discarded and not written to the file.
654 The recorder state must be in 'Ready' or 'Created' state.
656 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
658 <member name="P:Tizen.Multimedia.RecorderSettings.TimeLimit">
660 The time limit of a recording file in Seconds. If 0, means unlimited recording
663 <since_tizen> 3 </since_tizen>
665 After reaching the limitation, the data which is being recorded will
666 be discarded and not written to the file.
667 The recorder state must be in 'Ready' or 'Created' state.
669 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
671 <member name="P:Tizen.Multimedia.RecorderSettings.Mute">
673 The mute state of a recorder.
675 <since_tizen> 3 </since_tizen>
676 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
678 <member name="P:Tizen.Multimedia.RecorderSettings.MotionRate">
680 The video recording motion rate
682 <since_tizen> 3 </since_tizen>
684 The attribute is valid only in a video recorder.
685 If the rate is in range of 0-1, video is recorded in a slow motion mode.
686 If the rate is bigger than 1, video is recorded in a fast motion mode.
688 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
690 <member name="P:Tizen.Multimedia.RecorderSettings.OrientationTag">
692 The orientation in a video metadata tag.
694 <since_tizen> 3 </since_tizen>
695 <value>A <see cref="T:Tizen.Multimedia.Rotation"/> that specifies the type of orientation.</value>
696 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
698 <member name="P:Tizen.Multimedia.RecorderSettings.VideoResolution">
700 Resolution of the video.
702 <since_tizen> 3 </since_tizen>
703 <exception cref="T:System.ArgumentException">In case of invalid parameters</exception>
704 <exception cref="T:System.ObjectDisposedException">The camera already has been disposed.</exception>
706 <member name="T:Tizen.Multimedia.RecorderStateChangedEventArgs">
708 An extended EventArgs class which contains details about previous and current state
709 of the recorder when its state is changed.
712 <member name="P:Tizen.Multimedia.RecorderStateChangedEventArgs.Previous">
714 Previous state of the recorder.
716 <since_tizen> 3 </since_tizen>
718 <member name="P:Tizen.Multimedia.RecorderStateChangedEventArgs.Current">
720 Current state of the recorder.
722 <since_tizen> 3 </since_tizen>
724 <member name="P:Tizen.Multimedia.RecorderStateChangedEventArgs.IsStateChangedByPolicy">
726 true if the state changed by policy such as Resource Conflict or Security, otherwise false
727 in normal state change.
729 <since_tizen> 3 </since_tizen>
731 <member name="T:Tizen.Multimedia.RecordingErrorOccurredEventArgs">
733 An extended EventArgs class which contains details about error status and
734 state of the recorder when it failed.
737 <member name="P:Tizen.Multimedia.RecordingErrorOccurredEventArgs.Error">
741 <since_tizen> 3 </since_tizen>
743 <member name="P:Tizen.Multimedia.RecordingErrorOccurredEventArgs.State">
745 The state of the recorder.
747 <since_tizen> 3 </since_tizen>
749 <member name="T:Tizen.Multimedia.RecordingLimitReachedEventArgs">
751 An extended EventArgs class containing details about the recording limit.
754 <member name="P:Tizen.Multimedia.RecordingLimitReachedEventArgs.Type">
758 <since_tizen> 3 </since_tizen>
760 <member name="T:Tizen.Multimedia.RecordingProgressEventArgs">
762 An extened EventArgs class which contain the details of current recording status.
765 <member name="P:Tizen.Multimedia.RecordingProgressEventArgs.ElapsedTime">
767 The time of recording in milliseconds.
769 <since_tizen> 3 </since_tizen>
771 <member name="P:Tizen.Multimedia.RecordingProgressEventArgs.FileSize">
773 The size of the recording file in Kilobyte.
775 <since_tizen> 3 </since_tizen>