Agora C++ API Reference for All Platforms
IAgoraMediaEngine.h
1 //
2 // Agora Media SDK
3 //
4 // Copyright (c) 2015 Agora IO. All rights reserved.
5 //
6 #pragma once
7 
8 #include "AgoraBase.h"
9 #include "AgoraMediaBase.h"
10 #include "AgoraRefPtr.h"
11 
12 namespace agora {
13 namespace media {
14 
18  /* 0: Original mode */
20  /* 1: Left channel mode */
22  /* 2: Right channel mode */
24  /* 3: Mixed channel mode */
26 };
27 
28 
32 class IMediaEngine {
33  public:
46  virtual int registerAudioFrameObserver(IAudioFrameObserver* observer) = 0;
60  virtual int registerVideoFrameObserver(IVideoFrameObserver* observer) = 0;
75 
88  virtual int registerFaceInfoObserver(IFaceInfoObserver* observer) = 0;
89 
101 
119 
141  bool enabled, bool useTexture, EXTERNAL_VIDEO_SOURCE_TYPE sourceType = VIDEO_FRAME,
142  rtc::SenderOptions encodedVideoOption = rtc::SenderOptions()) = 0;
143 
170  virtual int setExternalAudioSource(bool enabled, int sampleRate, int channels, bool localPlayback = false, bool publish = true) __deprecated = 0;
171 
187  virtual rtc::track_id_t createCustomAudioTrack(rtc::AUDIO_TRACK_TYPE trackType, const rtc::AudioTrackConfig& config) = 0;
188 
198  virtual int destroyCustomAudioTrack(rtc::track_id_t trackId) = 0;
199 
227  virtual int setExternalAudioSink(bool enabled, int sampleRate, int channels) = 0;
228 
243  virtual int enableCustomAudioLocalPlayback(rtc::track_id_t trackId, bool enabled) = 0;
244 
253  virtual int pushVideoFrame(base::ExternalVideoFrame* frame, unsigned int videoTrackId = 0) = 0;
264  virtual int pushEncodedVideoImage(const unsigned char* imageBuffer, size_t length,
265  const agora::rtc::EncodedVideoFrameInfo& videoEncodedFrameInfo,
266  unsigned int videoTrackId = 0) = 0;
270  virtual int addVideoFrameRenderer(IVideoFrameObserver *renderer) = 0;
271 
275  virtual int removeVideoFrameRenderer(IVideoFrameObserver *renderer) = 0;
276 
277  virtual void release() = 0;
278 
279  protected:
280  virtual ~IMediaEngine() {}
281 };
282 
283 } // namespace media
284 
285 } // namespace agora
agora::rtc::SenderOptions
Definition: AgoraBase.h:1233
agora::media::VIDEO_FRAME
@ VIDEO_FRAME
Definition: AgoraMediaBase.h:1786
agora::media::IMediaEngine::pushEncodedVideoImage
virtual int pushEncodedVideoImage(const unsigned char *imageBuffer, size_t length, const agora::rtc::EncodedVideoFrameInfo &videoEncodedFrameInfo, unsigned int videoTrackId=0)=0
agora::media::IMediaEngine::enableCustomAudioLocalPlayback
virtual int enableCustomAudioLocalPlayback(rtc::track_id_t trackId, bool enabled)=0
agora::media::IFaceInfoObserver
Definition: AgoraMediaBase.h:1908
agora::media::IMediaEngine::pullAudioFrame
virtual int pullAudioFrame(IAudioFrameObserverBase::AudioFrame *frame)=0
agora::media::IMediaEngine::registerVideoFrameObserver
virtual int registerVideoFrameObserver(IVideoFrameObserver *observer)=0
agora::media::IVideoFrameObserver
Definition: AgoraMediaBase.h:1575
agora::media::IMediaEngine::pushAudioFrame
virtual int pushAudioFrame(IAudioFrameObserverBase::AudioFrame *frame, rtc::track_id_t trackId=0)=0
agora::media::IAudioFrameObserverBase::AudioFrame
Definition: AgoraMediaBase.h:1217
agora::media::IAudioFrameObserver
Definition: AgoraMediaBase.h:1466
agora::media::IMediaEngine::registerAudioFrameObserver
virtual int registerAudioFrameObserver(IAudioFrameObserver *observer)=0
agora::media::AUDIO_MIXING_DUAL_MONO_AUTO
@ AUDIO_MIXING_DUAL_MONO_AUTO
Definition: IAgoraMediaEngine.h:19
agora::media::IMediaEngine::release
virtual void release()=0
agora::media::IMediaEngine::createCustomAudioTrack
virtual rtc::track_id_t createCustomAudioTrack(rtc::AUDIO_TRACK_TYPE trackType, const rtc::AudioTrackConfig &config)=0
agora::media::AUDIO_MIXING_DUAL_MONO_MODE
AUDIO_MIXING_DUAL_MONO_MODE
Definition: IAgoraMediaEngine.h:17
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::track_id_t
unsigned int track_id_t
Definition: AgoraMediaBase.h:29
agora::media::IMediaEngine::registerFaceInfoObserver
virtual int registerFaceInfoObserver(IFaceInfoObserver *observer)=0
agora::media::AUDIO_MIXING_DUAL_MONO_L
@ AUDIO_MIXING_DUAL_MONO_L
Definition: IAgoraMediaEngine.h:21
agora::media::IMediaEngine::setExternalAudioSink
virtual int setExternalAudioSink(bool enabled, int sampleRate, int channels)=0
agora::media::IMediaEngine::registerVideoEncodedFrameObserver
virtual int registerVideoEncodedFrameObserver(IVideoEncodedFrameObserver *observer)=0
agora::media::AUDIO_MIXING_DUAL_MONO_MIX
@ AUDIO_MIXING_DUAL_MONO_MIX
Definition: IAgoraMediaEngine.h:25
agora::media::IMediaEngine::destroyCustomAudioTrack
virtual int destroyCustomAudioTrack(rtc::track_id_t trackId)=0
agora::media::IMediaEngine::setExternalVideoSource
virtual int setExternalVideoSource(bool enabled, bool useTexture, EXTERNAL_VIDEO_SOURCE_TYPE sourceType=VIDEO_FRAME, rtc::SenderOptions encodedVideoOption=rtc::SenderOptions())=0
agora::media::__deprecated
@ __deprecated
Definition: AgoraMediaBase.h:301
agora::media::IMediaEngine::setExternalAudioSource
virtual int setExternalAudioSource(bool enabled, int sampleRate, int channels, bool localPlayback=false, bool publish=true) __deprecated=0
agora::media::IMediaEngine
Definition: IAgoraMediaEngine.h:32
agora::media::IVideoEncodedFrameObserver
Definition: AgoraMediaBase.h:1554
agora::media::EXTERNAL_VIDEO_SOURCE_TYPE
EXTERNAL_VIDEO_SOURCE_TYPE
Definition: AgoraMediaBase.h:1782
agora::media::IMediaEngine::removeVideoFrameRenderer
virtual int removeVideoFrameRenderer(IVideoFrameObserver *renderer)=0
agora::media::AUDIO_MIXING_DUAL_MONO_R
@ AUDIO_MIXING_DUAL_MONO_R
Definition: IAgoraMediaEngine.h:23
rtc
Definition: video_node_i.h:28
agora::media::IMediaEngine::addVideoFrameRenderer
virtual int addVideoFrameRenderer(IVideoFrameObserver *renderer)=0
agora::media::IMediaEngine::pushVideoFrame
virtual int pushVideoFrame(base::ExternalVideoFrame *frame, unsigned int videoTrackId=0)=0