Skip to content

Commit e1d863e

Browse files
committed
Documenting the new run parameter
1 parent 14bc29e commit e1d863e

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

core/src/plugin/mod.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ pub trait Plugin: UriBound + Sized + Send + Sync + 'static {
4545
/// Run a processing step.
4646
///
4747
/// The host will always call this method after `active` has been called and before `deactivate` has been called.
48+
///
49+
/// The sample count is the number of frames covered by this `run` call. Audio and CV ports will contain exactly `sample_count` frames. Please note that `sample_count` may be differ between calls.
4850
fn run(
4951
&mut self,
5052
ports: &mut Self::Ports,

0 commit comments

Comments
 (0)