NAP
Public Member Functions | List of all members
InputPin Class Referencefinal

#include <audio/core/audiopin.h>

Public Member Functions

 InputPin (Node *node)
 
virtual ~InputPin () override
 
SampleBufferpull ()
 
- Public Member Functions inherited from InputPinBase
 InputPinBase (Node *node)
 
virtual ~InputPinBase ()
 
void connect (OutputPin &input)
 
void disconnect (OutputPin &input)
 
void disconnectAll ()
 
NodegetNode ()
 

Description

An input pin is used by audio node to connect it to other nodes. The pin connects one channel (mono) audio.

Inheritance diagram for InputPin:
[legend]
Collaboration diagram for InputPin:
[legend]

Constructor & Destructor Documentation

◆ InputPin()

InputPin ( Node node)

◆ ~InputPin()

virtual ~InputPin ( )
overridevirtual

Destructor. If the input is connected on destruction the connection will be broken first.

Member Function Documentation

◆ pull()

SampleBuffer* pull ( )

This method can be used by the node to pull one sample buffer output from the connected audio output.

Returns
Pointer to the sample buffer containing the input coming in through the pin. If the InputPin is not connected or somewhere down the graph silence is being output nullptr can be returned.