/lib/titanium/mobile/media/AudioRecorder.hx

 1package titanium.mobile.media;
 2import titanium.mobile.core.Dispatcher;
 3
 4/**
 5AudioRecorder class
 6
 7Documentation available at:
 8http://developer.appcelerator.com/apidoc/mobile/latest/Titanium.Media.AudioRecorder-object
 9
10- namespace
11
12Titanium.Media.AudioRecorder
13
14- type
15
16object
17
18- subtype
19
20proxy
21
22- description
23
24The AudioRecorder object is returned by [[Titanium.Media.createAudioRecorder]] and is used for recording audio from the device microphone.
25
26- since
27
280.9
29
30- platforms
31
32iphone, ipad
33
34- properties
35
36recording[boolean]: readonly property to indicate if recording
37stopped[boolean]: readonly property to indicate if stopped
38paused[boolean]: readonly property to indicate if paused
39compression[int]: audio compression constant to be used for the recording
40format[int]: audio format constant for used for the recording
41
42- methods
43
44start: called to start recording audio
45stop: called to stop recording audio
46pause: called to temporarily pause recording
47resume: called to resume audio recording
48
49
50**/
51
52@:native("Titanium.Media.AudioRecorder")
53extern class AudioRecorder extends Dispatcher
54{
55	// static constructor
56	public inline static function create(?params:Dynamic):AudioRecorder
57		return titanium.mobile.Media.createAudioRecorder(params)
58		
59	// properties
60	public var compression:Int;
61	public var format:Int;
62	public var paused:Bool;
63	public var recording:Bool;
64	public var stopped:Bool;
65	
66	// methods
67	public function pause():Void;
68	public function resume():Void;
69	public function start():Void;
70	public function stop():Void;
71}