Difference between revisions of "Microphone"

From GiderosMobile
m (Text replacement - "</source>" to "</syntaxhighlight>")
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
<languages />
 
 
<!-- GIDEROSOBJ:Microphone -->
 
<!-- GIDEROSOBJ:Microphone -->
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]]<br/>
+
'''Supported platforms:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]]<br/>
'''<translate>Available since</translate>:''' Gideros 2013.06<br/>
+
'''Available since:''' Gideros 2013.06<br/>
=== <translate>Description</translate> ===
+
 
<translate>Use this plugin to record to an audio clip using a connected microphone.</translate>
+
=== Description ===
 +
Use this plugin to record to an audio clip using a connected microphone.
 +
 
 +
=== Example ===
 +
<syntaxhighlight lang="lua">
 +
require "microphone"
 +
 
 +
local microphone = Microphone.new(nil, 22050, 1, 16)
 +
 
 +
microphone:addEventListener(Event.DATA_AVAILABLE, function(event)
 +
print(event.peakAmplitude)
 +
end)
 +
 
 +
microphone:setOutputFile("|D|record.wav")
 +
 
 +
local function onRecord()
 +
microphone:start()
 +
end
 +
--record:addEventListener(Event.CLICK, onRecord)
 +
 
 +
local function onRecordStop()
 +
microphone:stop()
 +
end
 +
--recordStop:addEventListener(Event.CLICK, onRecordStop)
 +
</syntaxhighlight>
 +
 
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== <translate>Methods</translate> ===
+
=== Methods ===
[[Special:MyLanguage/Microphone.new|Microphone.new]] ''<translate>Creates a new Microphone object.</translate>''<br/><!-- GIDEROSMTD:Microphone.new(deviceName,sampleRate,numChannels,bitsPerSample,quality) Creates a new Microphone object. -->
+
[[Microphone.new]] ''creates a new Microphone object''<br/><!--GIDEROSMTD:Microphone.new(deviceName,sampleRate,numChannels,bitsPerSample,quality) creates a new Microphone object-->
[[Special:MyLanguage/Microphone:setOutputFile|Microphone:setOutputFile]] ''<translate>Sets the output file</translate>''<br/><!-- GIDEROSMTD:Microphone:setOutputFile(fileName) Sets the output file -->
+
[[Microphone:setOutputFile]] ''sets the output file''<br/><!--GIDEROSMTD:Microphone:setOutputFile(fileName) sets the output file-->
[[Special:MyLanguage/Microphone:start|Microphone:start]] ''<translate>Start recording with device.</translate>''<br/><!-- GIDEROSMTD:Microphone:start() Start recording with device. -->
+
[[Microphone:start]] ''starts recording with device''<br/><!--GIDEROSMTD:Microphone:start() starts recording with device-->
[[Special:MyLanguage/Microphone:stop|Microphone:stop]] ''<translate>Stop recording</translate>''<br/><!-- GIDEROSMTD:Microphone:stop() Stop recording -->
+
[[Microphone:stop]] ''stops recording''<br/><!--GIDEROSMTD:Microphone:stop() stops recording-->
 +
 
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== <translate>Events</translate> ===
+
=== Events ===
[[Special:MyLanguage/Event.DATA_AVAILABLE|Event.DATA_AVAILABLE]]<br/><!-- GIDEROSEVT:Event.DATA_AVAILABLE dataAvailable-->
+
[[Event.DATA_AVAILABLE]]<br/><!--GIDEROSEVT:Event.DATA_AVAILABLE dataAvailable-->
=== <translate>Constants</translate> ===
+
 
 +
=== Constants ===
 
|}
 
|}
 +
 +
{{GIDEROS IMPORTANT LINKS}}

Latest revision as of 15:30, 13 July 2023

Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.png
Available since: Gideros 2013.06

Description

Use this plugin to record to an audio clip using a connected microphone.

Example

require "microphone"

local microphone = Microphone.new(nil, 22050, 1, 16)

microphone:addEventListener(Event.DATA_AVAILABLE, function(event)
	print(event.peakAmplitude)
end)

microphone:setOutputFile("|D|record.wav")

local function onRecord()
	microphone:start()
end
--record:addEventListener(Event.CLICK, onRecord)

local function onRecordStop()
	microphone:stop()
end
--recordStop:addEventListener(Event.CLICK, onRecordStop)

Methods

Microphone.new creates a new Microphone object
Microphone:setOutputFile sets the output file
Microphone:start starts recording with device
Microphone:stop stops recording

Events

Event.DATA_AVAILABLE

Constants