Microphone: Difference between revisions

From GiderosMobile
m Text replacement - "</source>" to "</syntaxhighlight>"
No edit summary
Line 34: Line 34:
=== Methods ===
=== Methods ===
[[Microphone.new]] ''creates a new Microphone object''<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-->
[[Microphone:setOutputFile]] ''sets the output file''<br/><!--GIDEROSMTD:Microphone:setOutputFile(fileName) sets the output file-->
[[Microphone:getStreamId]] ''gets the mic stream id''<br/><!--GIDEROSMTD:Microphone:getStreamId() gets the mic stream id-->
[[Microphone:start]] ''starts recording with device''<br/><!--GIDEROSMTD:Microphone:start() starts recording with device-->
[[Microphone:isPaused]] ''returns the mic paused status''<br/><!--GIDEROSMTD:Microphone:isPaused() returns the mic paused status-->
[[Microphone:stop]] ''stops recording''<br/><!--GIDEROSMTD:Microphone:stop() stops recording-->
[[Microphone:isRecording]] ''returns the mic recording status''<br/><!--GIDEROSMTD:Microphone:isRecording() returns the mic recording status-->
[[Microphone:setOutputFile]] ''sets the mic stream output file''<br/><!--GIDEROSMTD:Microphone:setOutputFile(fileName) sets the mic stream output file-->
[[Microphone:setPaused]] ''sets the mic paused state''<br/><!--GIDEROSMTD:Microphone:setPaused() sets the mic paused state-->
[[Microphone:start]] ''starts mic recording''<br/><!--GIDEROSMTD:Microphone:start() starts mic recording-->
[[Microphone:stop]] ''stops mic recording''<br/><!--GIDEROSMTD:Microphone:stop() stops mic recording-->


| style="width: 50%; vertical-align:top;"|
| style="width: 50%; vertical-align:top;"|

Revision as of 00:44, 26 August 2024

Supported platforms:
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:getStreamId gets the mic stream id
Microphone:isPaused returns the mic paused status
Microphone:isRecording returns the mic recording status
Microphone:setOutputFile sets the mic stream output file
Microphone:setPaused sets the mic paused state
Microphone:start starts mic recording
Microphone:stop stops mic recording

Events

Event.DATA_AVAILABLE

Constants