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

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

#include <omEngineSoundNodes.h>

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

Public Member Functions

 SoundInputStreamNode (SoundInputStream *newStream)
 Create a new sound input stream node that wraps the specified input stream. 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

SoundInputStreamstream
 A pointer to the sound input stream that this node is wrapping. More...
 

Detailed Description

A class that wraps a SoundInputStream object as a SoundNode.

Constructor & Destructor Documentation

om::engine::sound::SoundInputStreamNode::SoundInputStreamNode ( SoundInputStream newStream)
inline

Create a new sound input stream node that wraps the specified input stream.

Member Function Documentation

virtual Size om::engine::sound::SoundInputStreamNode::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::SoundInputStreamNode::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::SoundInputStreamNode::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

SoundInputStream* om::engine::sound::SoundInputStreamNode::stream

A pointer to the sound input stream that this node is wrapping.


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