Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Public Attributes | List of all members
om::engine::sound::SoundPluginNode Class Reference

A class that wraps a SoundPlugin object as a SoundNode. More...

#include <omEngineSoundNodes.h>

Inheritance diagram for om::engine::sound::SoundPluginNode:
om::engine::sound::SoundNode

Public Member Functions

 SoundPluginNode (SoundPlugin *newPlugin)
 Create a new sound plugin node that wraps the specified sound plugin. More...
 
virtual Size getInputCount () const
 Return the number of input audio streams there are for this sound node. More...
 
virtual Size getOutputCount () const
 Return the number of output audio streams there are for this sound node. More...
 
virtual SoundResult process (const SoundFrame &inputFrame, SoundFrame &outputFrame, Size numSamples)
 Process the given number of samples from the specified input frame and produce and output frame. More...
 
- Public Member Functions inherited from om::engine::sound::SoundNode
virtual ~SoundNode ()
 Destroy a sound node and release all internal resources. More...
 

Public Attributes

SoundPluginplugin
 A pointer to the sound plugin that this node is wrapping. More...
 

Detailed Description

A class that wraps a SoundPlugin object as a SoundNode.

Constructor & Destructor Documentation

om::engine::sound::SoundPluginNode::SoundPluginNode ( SoundPlugin newPlugin)
inline

Create a new sound plugin node that wraps the specified sound plugin.

Member Function Documentation

virtual Size om::engine::sound::SoundPluginNode::getInputCount ( ) const
virtual

Return the number of input audio streams there are for this sound node.

Implements om::engine::sound::SoundNode.

virtual Size om::engine::sound::SoundPluginNode::getOutputCount ( ) const
virtual

Return the number of output audio streams there are for this sound node.

Implements om::engine::sound::SoundNode.

virtual SoundResult om::engine::sound::SoundPluginNode::process ( const SoundFrame &  inputFrame,
SoundFrame &  outputFrame,
Size  numSamples 
)
virtual

Process the given number of samples from the specified input frame and produce and output frame.

Implements om::engine::sound::SoundNode.

Member Data Documentation

SoundPlugin* om::engine::sound::SoundPluginNode::plugin

A pointer to the sound plugin that this node is wrapping.


The documentation for this class was generated from the following file: