NAP
Public Member Functions | List of all members
VideoAudioComponentInstance Class Reference

#include <videoaudiocomponent.h>

Public Member Functions

 VideoAudioComponentInstance (EntityInstance &entity, Component &resource)
 
bool init (utility::ErrorState &errorState) override
 
int getChannelCount () const override
 
OutputPingetOutputForChannel (int channel) override
 
- Public Member Functions inherited from AudioComponentBaseInstance
 AudioComponentBaseInstance (EntityInstance &entity, Component &resource)
 
- Public Member Functions inherited from ComponentInstance
 ComponentInstance (EntityInstance &entity, Component &resource)
 
virtual void update (double deltaTime)
 
nap::EntityInstancegetEntityInstance () const
 
nap::ComponentgetComponent () const
 
template<typename T >
T * getComponent () const
 
virtual bool init (utility::ErrorState &errorState)
 
- Public Member Functions inherited from Object
 Object ()
 
virtual ~Object ()
 
virtual void onDestroy ()
 
 Object (Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&)=delete
 
Objectoperator= (Object &&)=delete
 
- Public Member Functions inherited from IMultiChannelOutput
virtual ~IMultiChannelOutput ()=default
 
OutputPintryGetOutputForChannel (unsigned int)
 

Additional Inherited Members

- Static Public Member Functions inherited from Object
static bool isIDProperty (rtti::Instance &object, const rtti::Property &property)
 
- Public Attributes inherited from Object
std::string mID
 Property: 'mID' unique name of the object. Used as an identifier by the system. More...
 
- Protected Member Functions inherited from AudioComponentBaseInstance
NodeManagergetNodeManager ()
 
AudioServicegetAudioService ()
 

Description

Instance part of the of VideoAudioComponent, outputs audio from a video stream. Without this component no video-audio is processed and therefore outputted.

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

Constructor & Destructor Documentation

◆ VideoAudioComponentInstance()

VideoAudioComponentInstance ( EntityInstance entity,
Component resource 
)

Member Function Documentation

◆ getChannelCount()

int getChannelCount ( ) const
overridevirtual
Returns
the total number of audio channels

Implements IMultiChannelOutput.

◆ getOutputForChannel()

OutputPin* getOutputForChannel ( int  channel)
overridevirtual
Parameters
channelindex of the output channel.
Returns
the output pin associated with the given channel.

Implements IMultiChannelOutput.

◆ init()

bool init ( utility::ErrorState errorState)
overridevirtual

Initializes this component based on it's resource.

Parameters
errorStatecontains the error when initialization fails.
Returns
if initialization succeeded.

Reimplemented from ComponentInstance.