Agora RTC Objective-C API Reference  Refactor
Public Member Functions
IRtcEngineParameter Class Referenceabstract

Public Member Functions

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
 

Constructor & Destructor Documentation

◆ ~IRtcEngineParameter()

virtual ~IRtcEngineParameter ( )
inlinevirtual

Member Function Documentation

◆ release()

virtual void release ( )
pure virtual

Releases the resource.

◆ setBool()

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

Sets the bool value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setInt()

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

Sets the int value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setUInt()

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

Sets the unsigned int value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setNumber()

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

Sets the double value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setString()

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

Sets the string value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setObject()

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

Sets the object value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getBool()

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

Gets the bool value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getInt()

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

Gets the int value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getUInt()

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

Gets the unsigned int value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getNumber()

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

Gets the double value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getString()

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

Gets the string value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getObject()

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

Gets a child object value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ getArray()

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

Gets the array value of the JSON.

Parameters
keyKey name
valueValue
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setParameters()

virtual int setParameters ( const char *  parameters)
pure virtual

Sets the parameters of the SDK or engine.

Parameters
parametersParameters
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ setProfile()

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

Sets the profile to control the RTC engine.

Parameters
profileProfile
merge
  • True: Merge with the original value.
  • False: Do not merge with the orginal value.
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ convertPath()

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