This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English version of the page.

Note: This page has been translated by MathWorks. Click here to see
To view all translated materials including this page, select Country from the country navigator on the bottom of this page.

getSamplesPerFrame

Class: audioPluginSource

Get frame size returned by the plugin

Syntax

frameSize = getSamplesPerFrame(myAudioSourcePlugin)

Description

frameSize = getSamplesPerFrame(myAudioSourcePlugin) returns the frame size at which the plugin is run. frameSize is the number of output samples (rows) that the current call to the processing function of myAudioSourcePlugin must return.

  • In a digital audio workstation (DAW) environment, getSamplesPerFrame interacts with the DAW to determine the frame size. Frame size can vary from call to call, as determined by the DAW environment.

  • In the MATLAB® environment, getSamplesPerFrame returns the value set by a previous call to the setSamplesPerFrame method. If setSamplesPerFrame has not been called, then getSamplesPerFrame returns the default value, 256.

Note

When authoring source plugins in MATLAB, getSamplesPerFrame is valid only when called in the processing function.

Introduced in R2016a