API概览
IArRtcEngine
IRTCEngineEventHandler
IArRtcChannel
IChannelEventHandler
IAudioDeviceManager
IVideoDeviceManager
状态码错误码

IRtcEngineParameter

最近更新时间：2022-09-20 05:17:40

成员函数说明
release
释放 IRtcEngineParameter 对象占用的所有资源。
setBool
setInt
setUInt
setNumber
setString
setObject
getBool
getInt
getUInt
getNumber
getString
getObject
getArray
setParameters
setProfile
convertPath
Public 成员函数
virtual voidrelease ()=0
virtual intsetBool (const char *key, bool value)=0
virtual intsetInt (const char *key, int value)=0
virtual intsetUInt (const char *key, unsigned int value)=0
virtual intsetNumber (const char *key, double value)=0
virtual intsetString (const char *key, const char *value)=0
virtual intsetObject (const char *key, const char *value)=0
virtual intgetBool (const char *key, bool &value)=0
virtual intgetInt (const char *key, int &value)=0
virtual intgetUInt (const char *key, unsigned int &value)=0
virtual intgetNumber (const char *key, double &value)=0
virtual intgetString (const char *key, ar::util::AString &value)=0
virtual intgetObject (const char *key, ar::util::AString &value)=0
virtual intgetArray (const char *key, ar::util::AString &value)=0
virtual intsetParameters (const char* parameters)=0
virtual intsetProfile (const char *profile, bool merge)=0
virtual intconvertPath (const char *filePath, ar::util::AString &value)=0

成员函数说明

release

virtual void release()

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

setBool

virtual int setBool(const char* key, bool value)

设置 JSON 中对应的 key 的 bool 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

setInt

virtual int setInt(const char* key, int value)

设置 JSON 中对应的 key 的 int 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

setUInt

virtual int setUInt(const char* key, int value)

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

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

setNumber

virtual int setNumber(const char* key, double value)

设置 JSON 中对应的 key 的 double 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

setString

virtual int setString(const char* key, const char* value)

设置 JSON 中对应的 key 的 string 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

setObject

virtual int setObject(const char* key, const char* value)

设置 JSON 的对象值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getBool

virtual int getBool(const char* key, bool& value)

获取 JSON 中对应的 key 的 bool 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getInt

virtual int getInt(const char* key, int& value)

获取 JSON 中对应的 key 的 int 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getUInt

virtual int getUInt(const char* key, unsigned int& value)

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

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getNumber

virtual int getNumber(const char* key, double& value)

获取 JSON 中对应的 key 的 double 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getString

virtual int getString(const char* key, ar::util::AString& value)

获取 JSON 中对应的 key 的 string 值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getObject

virtual int getObject(const char* key, ar::util::AString& value)

获取 JSON 的对象值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

getArray

virtual int getArray(const char* key, ar::util::AString& value)

获取 JSON 的矩阵值

参数

key键名。
value键值。

返回

  • 0: 方法调用成功
  • < 0: 方法调用失败

setParameters

virtual int setParameters(const char* parameters)

setProfile

virtual int setProfile(const char* profile, bool merge)

设置 profile 以控制 RTC 引擎

参数

profileProfile
merge是否与原始值合并。
  • true: 与原始值合并；
  • false: 不与原始值合并。

    • 返回

    • 0: 方法调用成功
    • < 0: 方法调用失败

    convertPath

    virtual int convertPath(const char* filePath, ar::util::AString& value)