nn::snd::CTR::OutputCapture Class

Syntax

class OutputCapture

Description

The class for getting the DSP's final output.

Use this class to get the DSP's final output from a thread other than a sound thread. To get it from a sound thread, use the nn::snd::CTR::GetMixedBusData function.

By registering OutputCapture with the nn::snd::CTR::SetOutputCapture function, you can automatically get the DSP's final output waveform within the nn::snd::CTR::WaitForDspSync function to the buffer specified by the nn::snd::CTR::OutputCapture::Initialize function. The obtained data can be obtained asynchronously for a sound thread with the nn::snd::CTR::OutputCapture::Read function. It is possible to control whether to get the data using the nn::snd::CTR::OutputCapture::Enable and nn::snd::CTR::OutputCapture::Disable functions.

Since the buffer assigned to OutputCapture by the nn::snd::CTR::OutputCapture::Initialize function is handled as a ring buffer, when data is not obtained by the nn::snd::CTR::OutputCapture::Read function, note that old data may be overwritten. To make sure this does not happen, it is necessary to allocate a buffer of sufficient length.

Member Functions

Initialization & Shutdown
Initialize Performs initialization.
Finalize Performs finalization.
S GetRequiredMemorySize Calculates the necessary buffer size from the specified number of sound frames.
Data Acquisition
Enable Enables/disables the getting of data from the DSP.
Disable Disables the getting of data from the DSP.
IsEnabled Gets whether the getting of data from the DSP is enabled.
Read Copies the data obtained from the DSP to the specified buffer.
Reset Destroys all the obtained data.

Revision History

2010/10/20
Initial version.

CONFIDENTIAL