Agora C++ API Reference for All Platforms
Public Member Functions | List of all members
agora::rtc::IRemoteAudioMixerSource Class Referenceabstract

Inherits agora::RefCountInterface.

Inherited by agora::rtc::IRemoteAudioMixerSourceEx.

Public Member Functions

virtual ~IRemoteAudioMixerSource ()
 
virtual int addAudioTrack (agora_refptr< IRemoteAudioTrack > track)=0
 
virtual int removeAudioTrack (agora_refptr< IRemoteAudioTrack > track)=0
 
virtual int getMixDelay () const =0
 
- Public Member Functions inherited from agora::RefCountInterface
virtual void AddRef () const =0
 
virtual RefCountReleaseStatus Release () const =0
 
virtual bool HasOneRef () const =0
 

Additional Inherited Members

- Protected Member Functions inherited from agora::RefCountInterface
virtual ~RefCountInterface ()
 

Detailed Description

The IRemoteAudioMixerSource class abstracts a multi-in-single-out audio source which receives audio streams from multiple remote audio tracks and generate mixed audio stream in user defined output format.

Constructor & Destructor Documentation

◆ ~IRemoteAudioMixerSource()

virtual agora::rtc::IRemoteAudioMixerSource::~IRemoteAudioMixerSource ( )
inlinevirtual

Member Function Documentation

◆ addAudioTrack()

virtual int agora::rtc::IRemoteAudioMixerSource::addAudioTrack ( agora_refptr< IRemoteAudioTrack track)
pure virtual

Add a audio track for mixing. Automatically starts mixing if add audio track

Parameters
trackThe instance of the audio track that you want mixer to receive its audio stream.

◆ removeAudioTrack()

virtual int agora::rtc::IRemoteAudioMixerSource::removeAudioTrack ( agora_refptr< IRemoteAudioTrack track)
pure virtual

Remove a audio track for mixing. Automatically stops the mixed stream if all audio tracks are removed

Parameters
trackThe instance of the audio track that you want to remove from the mixer.

◆ getMixDelay()

virtual int agora::rtc::IRemoteAudioMixerSource::getMixDelay ( ) const
pure virtual

Gets the delay time for mix.