Documentation





Voice Call (Legacy)

Console 官网 Community Technical support





Agora C++ API Reference for All Platforms

Index IRtcEngine IRtcEngineEventHandler IChannel IChannelEventHandler IAudioDeviceManager IVideoDeviceManager

#include <IAgoraRtcEngine.h>

Public Member Functions
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

Constructor & Destructor Documentation

◆ ~IRtcEngineParameter()

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

inlinevirtual

Member Function Documentation

◆ release()

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

pure virtual

Releases all IRtcEngineParameter resources.

◆ setBool()

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

pure virtual

Sets the bool value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Sets the value.

Returns

0: Success.
< 0: Failure.

◆ setInt()

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

pure virtual

Sets the int value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Sets the value.

Returns

0: Success.
< 0: Failure.

◆ setUInt()

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

pure virtual

Sets the unsigned int value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Sets the value.

Returns

0: Success.
< 0: Failure.

◆ setNumber()

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

pure virtual

Sets the double value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Sets the value.

Returns

0: Success.
< 0: Failure.

◆ setString()

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

pure virtual

Sets the string value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the set value.

Returns

0: Success.
< 0: Failure.

◆ setObject()

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

pure virtual

Sets the object value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the set value.

Returns

0: Success.
< 0: Failure.

◆ getBool()

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

pure virtual

Gets the bool value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ getInt()

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

pure virtual

Gets the int value of the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ getUInt()

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

pure virtual

Gets the unsigned int value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ getNumber()

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

pure virtual

Gets the double value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ getString()

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

pure virtual

Gets the string value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ getObject()

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

pure virtual

Gets a child object value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ getArray()

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

pure virtual

Gets the array value of a specified key in the JSON format.

Parameters

key	Pointer to the name of the key.
value	Pointer to the retrieved value.

Returns

0: Success.
< 0: Failure.

◆ setParameters()

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

pure virtual

Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options.

Parameters

parameters Pointer to the set parameters in a JSON string.

Returns

0: Success.
< 0: Failure.

◆ setProfile()

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

pure virtual

Sets the profile to control the RTC engine.

Parameters

profile	Pointer to the set profile.
merge	Sets whether to merge the profile data with the original value: true: Merge the profile data with the original value. false: Do not merge the profile data with the original value.

Returns

0: Success.
< 0: Failure.

◆ convertPath()

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

pure virtual

Agora C++ API Reference for All Platforms

Public Member Functions

Constructor & Destructor Documentation

◆ ~IRtcEngineParameter()

Member Function Documentation

◆ release()

◆ setBool()

◆ setInt()

◆ setUInt()

◆ setNumber()

◆ setString()

◆ setObject()

◆ getBool()

◆ getInt()

◆ getUInt()

◆ getNumber()

◆ getString()

◆ getObject()

◆ getArray()

◆ setParameters()

◆ setProfile()

◆ convertPath()