AudioEffectRecord

Records a bus signal into an AudioStreamWav resource.

1.0.0

class AudioEffectRecordReckfellSharpInherits AudioEffect

AudioEffectRecord accumulates a bus recording in memory. Add the effect, start with SetRecordingActive(true), stop with false, then call GetRecording(). Starting again clears the previous recording.

For a file, call SaveToWav() on the returned resource and check Error. Long recordings require memory. A bus need not originate from a microphone; microphone access requires separate device settings and permissions.

Working example.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

AudioEffectRecordConstructor

# AudioEffectRecord

C#
public AudioEffectRecord();

Properties1

FormatProperty

# Format

C#
public AudioStreamWav.FormatEnum Format { get; set; }

Specifies the format in which the sample will be recorded.

Methods5

GetFormatAudioStreamWav.FormatEnum

# GetFormat

C#
public AudioStreamWav.FormatEnum GetFormat();

Returns AudioStreamWav.FormatEnum

GetRecordingAudioStreamWav

# GetRecording

C#
public AudioStreamWav GetRecording();

Returns the accumulated AudioStreamWav. Stop recording normally with SetRecordingActive(false) first. Saving is a separate SaveToWav() call whose Error must be checked.

Returns AudioStreamWav

IsRecordingActivebool

# IsRecordingActive

C#
public bool IsRecordingActive();

Returns whether the recording is active or not.

Returns bool

SetFormatvoid

# SetFormat

C#
public void SetFormat(AudioStreamWav.FormatEnum format);

Parameters
Name	Type	Default
`format`	`AudioStreamWav.FormatEnum`	—

SetRecordingActivevoid

# SetRecordingActive

C#
public void SetRecordingActive(bool record);

Starts or ends recording accumulation. Starting again removes the previous recording. Add the effect to a bus first; retrieve the result with GetRecording() after stopping.

Parameters
Name	Type	Default
`record`	`bool`	—

Reckfell Engine documentationBack to top ↑