audio_start_recording

Start recording audio to the recorder buffer from a given source.

Syntax:

audio_start_recording(recorder_index);

Returns: Index

Description

This function will start recording audio from the recorder source indexed. You can get the number of recorder sources using the function audio_get_recorder_count(), and once you start recording the audio will be stored in a temporary buffer and start triggering an Audio Recording Asynchronous Event. This event is triggered every step that recording takes place and will create the special ds_map in the variable async_load with the following key/value pairs:

• "buffer_id" - the ID of the temporary buffer you can use to retrieve the audio data
• "channel_index" - the recording channel index (as returned by the function) this data came from
• "data_len" - the length of data (in bytes) you've received

Note that after the asynchronous event has been triggered, the audio in the temporary buffer will be wiped, so you should be copying it's data into a custom buffer that you have previously created.

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

Example:

audio_record = audio_start_recording(0);

The above code starts recording from the recorder source 0, storing the channel index of the recording in the variable "audio_record" for use in the asynchronous Audio Recording event.

© Copyright YoYo Games Ltd. 2015 All Rights Reserved