audio_get_recorder_info

Returns a ds_map containing information about the indexed recording device.

Syntax:

audio_get_recorder_info(recorder_index);


Argument Description
recorder_index The index of the recorder source to get the information from.


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:

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: Most platforms support recording audio in some form, but that does not mean that all devices will permit it, even if the platform does, so you should always check that the audio_get_recorder_count() function returns a value greater than 0 to verify that recording devices are available before using the rest of the recording functions.


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.


Back: Audio Buffers
Next: audio_system
© Copyright YoYo Games Ltd. 2018 All Rights Reserved