Difference between revisions of "RecordingDevice:getData"

(Created page)
 
m (getData -> this function)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{newin|[[0.11.0]]|110|type=function}}
+
{{newin|[[11.0]]|110|type=function}}
 
Gets all recorded audio [[SoundData]] stored in the device's internal ring buffer.
 
Gets all recorded audio [[SoundData]] stored in the device's internal ring buffer.
  
The internal ring buffer is cleared when this function is called, so calling it again will only get audio recorded after the previous call. If the device's internal ring buffer completely fills up before getData is called, the oldest data that doesn't fit into the buffer will be lost.
+
The internal ring buffer is cleared when this function is called, so calling it again will only get audio recorded after the previous call. If the device's internal ring buffer completely fills up before this function is called, the oldest data that doesn't fit into the buffer will be lost.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 16: Line 16:
 
* [[RecordingDevice:start]]
 
* [[RecordingDevice:start]]
 
* [[RecordingDevice:stop]]
 
* [[RecordingDevice:stop]]
 +
* [[Constructs::SoundData]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 
{{#set:Description=Gets all recorded audio [[SoundData]] stored in the device's internal ring buffer.}}
 
{{#set:Description=Gets all recorded audio [[SoundData]] stored in the device's internal ring buffer.}}
 
== Other Languages ==
 
== Other Languages ==
 
{{i18n|RecordingDevice:getData}}
 
{{i18n|RecordingDevice:getData}}

Latest revision as of 07:38, 2 December 2019

Available since LÖVE 11.0
This function is not supported in earlier versions.

Gets all recorded audio SoundData stored in the device's internal ring buffer.

The internal ring buffer is cleared when this function is called, so calling it again will only get audio recorded after the previous call. If the device's internal ring buffer completely fills up before this function is called, the oldest data that doesn't fit into the buffer will be lost.

Function

Synopsis

data = RecordingDevice:getData( )

Arguments

None.

Returns

SoundData data (nil)
The recorded audio data, or nil if the device isn't recording.

See Also

Other Languages