文档中心
互动直播 (Legacy)
Console 官网 社区 技术支持
简体中文
search-icon

C++ API Reference for All Platforms

概览 IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

#include <IAgoraRtcEngine.h>

Public 成员函数

virtual ~IRtcEngineParameter ()
 
virtual void release ()=0
 
virtual int setBool (const char *key, bool value)=0
 
virtual int setInt (const char *key, int value)=0
 
virtual int setUInt (const char *key, unsigned int value)=0
 
virtual int setNumber (const char *key, double value)=0
 
virtual int setString (const char *key, const char *value)=0
 
virtual int setObject (const char *key, const char *value)=0
 
virtual int getBool (const char *key, bool &value)=0
 
virtual int getInt (const char *key, int &value)=0
 
virtual int getUInt (const char *key, unsigned int &value)=0
 
virtual int getNumber (const char *key, double &value)=0
 
virtual int getString (const char *key, agora::util::AString &value)=0
 
virtual int getObject (const char *key, agora::util::AString &value)=0
 
virtual int getArray (const char *key, agora::util::AString &value)=0
 
virtual int setParameters (const char *parameters)=0
 
virtual int setProfile (const char *profile, bool merge)=0
 
virtual int convertPath (const char *filePath, agora::util::AString &value)=0
 

构造及析构函数说明

◆ ~IRtcEngineParameter()

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

成员函数说明

◆ release()

virtual void agora::rtc::IRtcEngineParameter::release ( )
pure virtual

释放 IRtcEngineParameter 对象占用的所有资源。

◆ setBool()

virtual int agora::rtc::IRtcEngineParameter::setBool ( const char *  key,
bool  value 
)
pure virtual

设置 JSON 中对应的 key 的 bool 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setInt()

virtual int agora::rtc::IRtcEngineParameter::setInt ( const char *  key,
int  value 
)
pure virtual

设置 JSON 中对应的 key 的 int 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setUInt()

virtual int agora::rtc::IRtcEngineParameter::setUInt ( const char *  key,
unsigned int  value 
)
pure virtual

设置 JSON 中对应的 key 的 unsigned int 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setNumber()

virtual int agora::rtc::IRtcEngineParameter::setNumber ( const char *  key,
double  value 
)
pure virtual

设置 JSON 中对应的 key 的 double 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setString()

virtual int agora::rtc::IRtcEngineParameter::setString ( const char *  key,
const char *  value 
)
pure virtual

设置 JSON 中对应的 key 的 string 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setObject()

virtual int agora::rtc::IRtcEngineParameter::setObject ( const char *  key,
const char *  value 
)
pure virtual

设置 JSON 的对象值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getBool()

virtual int agora::rtc::IRtcEngineParameter::getBool ( const char *  key,
bool &  value 
)
pure virtual

获取 JSON 中对应的 key 的 bool 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getInt()

virtual int agora::rtc::IRtcEngineParameter::getInt ( const char *  key,
int &  value 
)
pure virtual

获取 JSON 中对应的 key 的 int 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getUInt()

virtual int agora::rtc::IRtcEngineParameter::getUInt ( const char *  key,
unsigned int &  value 
)
pure virtual

获取 JSON 中对应的 key 的 unsigned int 值。

参数
key键名
value键值
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getNumber()

virtual int agora::rtc::IRtcEngineParameter::getNumber ( const char *  key,
double &  value 
)
pure virtual

获取 JSON 中对应的 key 的 double 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getString()

virtual int agora::rtc::IRtcEngineParameter::getString ( const char *  key,
agora::util::AString &  value 
)
pure virtual

获取 JSON 中对应的 key 的 string 值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getObject()

virtual int agora::rtc::IRtcEngineParameter::getObject ( const char *  key,
agora::util::AString &  value 
)
pure virtual

获取 JSON 的对象值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ getArray()

virtual int agora::rtc::IRtcEngineParameter::getArray ( const char *  key,
agora::util::AString &  value 
)
pure virtual

获取 JSON 的矩阵值。

参数
key键名。
value键值。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setParameters()

virtual int agora::rtc::IRtcEngineParameter::setParameters ( const char *  parameters)
pure virtual

通过 JSON 配置 SDK 提供技术预览或特别定制功能。

参数
parametersJSON 格式的字符串。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ setProfile()

virtual int agora::rtc::IRtcEngineParameter::setProfile ( const char *  profile,
bool  merge 
)
pure virtual

设置 profile 以控制 RTC 引擎。

参数
profileProfile
merge是否与原始值合并。
  • true: 与原始值合并；
  • false: 不与原始值合并。
返回
  • 0: 方法调用成功
  • < 0: 方法调用失败

◆ convertPath()

virtual int agora::rtc::IRtcEngineParameter::convertPath ( const char *  filePath,
agora::util::AString &  value 
)
pure virtual