audio_get_recorder_info

Returns a ds_map containing information about the indexed recording device.

Syntax:

audio_get_recorder_info(recorder_index);

Returns: ds_map

Description

This function will return a ds_map with information about the given recorder source index. You can find out how many recorder sources are available using the function audio_get_recorder_count, and the map returned will contain the following key/value pairs:

• "name" - a name to describe the device
• "index" - the index to be used to record
• "data_format" - the format data will be returned in (this is currently always buffer_s16 but other formats may be supported in the future)
• "sample_rate" - the sample rate (in Hz) of the data returned (currently clamped to 16000hz but this may change in future)
• "channels" - the constant audio_mono (further constants for stereo and 3D may be supported in the future)

note that while the function creates a ds_map for you, it does not remove it again later and so you should be destroying the map yourself when it is no longer needed to prevent any memory leaks.

NOTE: Recording audio is currently only available currently for the Windows, Xbox One, PlayStation 4 and HTML5 target modules.

Example:

len = async_load[? "data_len"];
audio_buff = buffer_create(len, buffer_fast, 1);
buffer_copy(async_load[? "buffer_id"], 0, len, buff, 0);
audio_queue_sound(audio_queue, audio_buff, 0, len);
audio_play_sound(audio_queue, 10, 0);

The above code would be called in the asynchronous Audio Recording event and assigns some recorded data to a buffer, which is then added to an audio queue. This is then played.

© Copyright YoYo Games Ltd. 2015 All Rights Reserved