Agora C++ API Reference for All Platforms
extension_provider_i.h
1 //
2 // Agora SDK
3 //
4 // Copyright (c) 2021 Agora.io. All rights reserved.
5 //
6 
7 #pragma once
8 
9 #include <string>
10 
11 #include "NGIAgoraExtensionProvider.h"
12 #include "NGIAgoraExtensionScreenSource.h"
13 #include "api2/AgoraRefCountedObject.h"
14 
15 namespace agora {
16 namespace rtc {
17 
19  public:
20  virtual void* createCustomExtension(const char* name) = 0;
21  virtual void destroyCustomExtension(const char* name, void* object) = 0;
22 };
23 
24 #define RESERVED_INTERNAL_MAJOR_VERSION 999
25 
26 template <>
29  return ExtensionVersion(RESERVED_INTERNAL_MAJOR_VERSION, 0, 0);
30  }
31 };
32 
33 template <class ExtInterface>
35  public:
37  const char* extension, bool refcounted)
38  : provider_(provider), ext_name_(extension) {
39  assert(provider_ && !ext_name_.empty());
40  if (refcounted) {
41  ref_ptr_ = static_cast<RefCountedObject<ExtInterface>*>(
42  provider_->createCustomExtension(extension));
43  } else {
44  raw_ptr_ = static_cast<ExtInterface*>(provider_->createCustomExtension(extension));
45  }
46  }
47 
49  if (raw_ptr_) {
50  assert(provider_ && !ext_name_.empty());
51  provider_->destroyCustomExtension(ext_name_.c_str(), raw_ptr_);
52  }
53  }
54 
59 
60  ExtInterface* get() {
61  return raw_ptr_? raw_ptr_ : ref_ptr_.get();
62  }
63 
65  return ref_ptr_;
66  }
67 
68  private:
69  std::string ext_name_;
70  ICustomExtensionProvider* provider_ = nullptr;
71  agora_refptr<ExtInterface> ref_ptr_ = nullptr;
72  ExtInterface* raw_ptr_ = nullptr;
73 };
74 
75 } // namespace rtc
76 } // namespace agora
agora::rtc::ICustomExtensionProvider::destroyCustomExtension
virtual void destroyCustomExtension(const char *name, void *object)=0
agora::rtc::ExtensionVersion
Definition: AgoraExtensionVersion.h:14
agora::agora_refptr< ExtInterface >
agora::agora_refptr::get
T * get() const
Definition: AgoraRefPtr.h:77
agora::rtc::CustomExtensionWrapper::CustomExtensionWrapper
CustomExtensionWrapper(const CustomExtensionWrapper &)=default
agora::rtc::ExtensionInterfaceVersion< ICustomExtensionProvider >::Version
static ExtensionVersion Version()
Definition: extension_provider_i.h:28
agora::rtc::CustomExtensionWrapper::~CustomExtensionWrapper
~CustomExtensionWrapper()
Definition: extension_provider_i.h:48
agora::rtc::CustomExtensionWrapper
Definition: extension_provider_i.h:34
agora::rtc::CustomExtensionWrapper::get
ExtInterface * get()
Definition: extension_provider_i.h:60
agora::rtc::ICustomExtensionProvider
Definition: extension_provider_i.h:18
agora::RefCountedObject
Definition: AgoraRefCountedObject.h:63
agora
Definition: AgoraAtomicOps.h:21
agora::rtc::CustomExtensionWrapper::getRefPtr
agora_refptr< ExtInterface > getRefPtr()
Definition: extension_provider_i.h:64
agora::rtc::IExtensionProvider
Definition: NGIAgoraExtensionProvider.h:35
agora::rtc::CustomExtensionWrapper::CustomExtensionWrapper
CustomExtensionWrapper(ICustomExtensionProvider *provider, const char *extension, bool refcounted)
Definition: extension_provider_i.h:36
agora::rtc::CustomExtensionWrapper::operator=
CustomExtensionWrapper & operator=(const CustomExtensionWrapper &)=default
agora::rtc::CustomExtensionWrapper::CustomExtensionWrapper
CustomExtensionWrapper(CustomExtensionWrapper &&)=default
agora::rtc::CustomExtensionWrapper::operator=
CustomExtensionWrapper & operator=(CustomExtensionWrapper &&)=default
agora::rtc::ExtensionInterfaceVersion
Definition: AgoraExtensionVersion.h:65
rtc
Definition: video_node_i.h:25
agora::rtc::ICustomExtensionProvider::createCustomExtension
virtual void * createCustomExtension(const char *name)=0