Agora RTC Objective-C API Reference Refactor

NGIAgoraExtensionControl.h
Go to the documentation of this file.
1 //
2 // Copyright (c) 2020 Agora.io. All rights reserved
3
4 // This program is confidential and proprietary to Agora.io.
5 // And may not be copied, reproduced, modified, disclosed to others, published
6 // or used, in whole or in part, without the express prior written permission
7 // of Agora.io.
8
9 #pragma once // NOLINT(build/header_guard)
10 #include "AgoraBase.h"
11 #include "AgoraRefPtr.h"
12 #include "IAgoraLog.h"
13 #include "NGIAgoraVideoFrame.h"
14 #include "NGIAgoraExtensionProvider.h"
15
16 namespace agora {
17 namespace rtc {
18 class IExtensionProvider;
22 class IExtensionControl {
23 public:
27 struct Capabilities {
31 bool audio;
35 bool video;
36 };
37
43 virtual void getCapabilities(Capabilities& capabilities) = 0;
44
52 virtual int recycleVideoCache() = 0;
53
61 virtual int dumpVideoFrame(agora_refptr<IVideoFrame> frame, const char* file) = 0;
62
72 virtual int log(commons::LOG_LEVEL level, const char* message) = 0;
73
85 virtual int fireEvent(const char* provider, const char* extension, const char* event_key, const char* value) = 0;
86
92 virtual int registerProvider(const char* provider, agora_refptr<IExtensionProvider> instance) = 0;
93
94 protected:
95 virtual ~IExtensionControl() {}
96 };
97
98 } // namespace rtc
99 } // namespace agora
agora::rtc::IExtensionControl::recycleVideoCache
virtual int recycleVideoCache()=0
NGIAgoraExtensionProvider.h
AgoraBase.h
agora::rtc::IExtensionControl::Capabilities
Definition: NGIAgoraExtensionControl.h:27
agora::agora_refptr
Definition: AgoraRefPtr.h:44
agora::rtc::IExtensionControl::Capabilities::video
bool video
Definition: NGIAgoraExtensionControl.h:35
agora::rtc::IExtensionControl::dumpVideoFrame
virtual int dumpVideoFrame(agora_refptr< IVideoFrame > frame, const char *file)=0
agora::rtc::IExtensionControl::registerProvider
virtual int registerProvider(const char *provider, agora_refptr< IExtensionProvider > instance)=0
agora
Definition: AgoraAtomicOps.h:21
NGIAgoraVideoFrame.h
agora::rtc::IExtensionControl::getCapabilities
virtual void getCapabilities(Capabilities &capabilities)=0
agora::commons::LOG_LEVEL
OPTIONAL_ENUM_CLASS LOG_LEVEL
Definition: IAgoraLog.h:33
agora::rtc::IExtensionControl::~IExtensionControl
virtual ~IExtensionControl()
Definition: NGIAgoraExtensionControl.h:95
agora::rtc::IExtensionControl::log
virtual int log(commons::LOG_LEVEL level, const char *message)=0
IAgoraLog.h
agora::rtc::IExtensionControl::Capabilities::audio
bool audio
Definition: NGIAgoraExtensionControl.h:31
AgoraRefPtr.h
agora::rtc::IExtensionControl::fireEvent
virtual int fireEvent(const char *provider, const char *extension, const char *event_key, const char *value)=0
agora::rtc::IExtensionControl
Definition: NGIAgoraExtensionControl.h:22