agora Namespace Reference

Namespaces
namespace	base
namespace	commons
namespace	internal
namespace	media
namespace	rtc
namespace	signaling
namespace	util

Classes
struct	AudioPcmFrame
struct	ExternalVideoFrame
struct	in_place_t
struct	nullopt_t
class	Optional
struct	UserInfo
struct	VideoFrame

Typedefs
typedef commons::cjson::JsonWrapper	any_document_t
typedef const char *	user_id_t
typedef void *	view_t
typedef util::AList< UserInfo >	UserList

Enumerations
enum	CHANNEL_PROFILE_TYPE { CHANNEL_PROFILE_COMMUNICATION = 0 , CHANNEL_PROFILE_LIVE_BROADCASTING = 1 , CHANNEL_PROFILE_GAME = 2 , __deprecated = 3 }
enum	VIDEO_PIXEL_FORMAT {   VIDEO_PIXEL_UNKNOWN = 0 , VIDEO_PIXEL_I420 = 1 , VIDEO_PIXEL_BGRA = 2 , VIDEO_PIXEL_NV21 = 3 ,   VIDEO_PIXEL_RGBA = 4 , VIDEO_PIXEL_NV12 = 8 , VIDEO_TEXTURE_2D = 10 , VIDEO_TEXTURE_OES = 11 ,   VIDEO_PIXEL_I422 = 16 }
enum	VIDEO_MODULE_POSITION { POSITION_POST_CAPTURER = 1 << 0 , POSITION_PRE_RENDERER = 1 << 1 , POSITION_PRE_ENCODER = 1 << 2 , POSITION_POST_FILTERS = 1 << 3 }

Functions
const nullopt_t	nullopt (0)
template<class T , class U >
bool	operator== (const Optional< T > &lhs, const Optional< U > &rhs)
template<class T , class U >
bool	operator!= (const Optional< T > &lhs, const Optional< U > &rhs)
template<class T , class U >
bool	operator< (const Optional< T > &lhs, const Optional< U > &rhs)
template<class T , class U >
bool	operator<= (const Optional< T > &lhs, const Optional< U > &rhs)
template<class T , class U >
bool	operator> (const Optional< T > &lhs, const Optional< U > &rhs)
template<class T , class U >
bool	operator>= (const Optional< T > &lhs, const Optional< U > &rhs)
template<class T >
CONSTEXPR bool	operator== (const Optional< T > &opt, nullopt_t)
template<class T >
CONSTEXPR bool	operator== (nullopt_t, const Optional< T > &opt)
template<class T >
CONSTEXPR bool	operator!= (const Optional< T > &opt, nullopt_t)
template<class T >
CONSTEXPR bool	operator!= (nullopt_t, const Optional< T > &opt)
template<class T >
CONSTEXPR bool	operator< (const Optional< T > &opt, nullopt_t)
template<class T >
CONSTEXPR bool	operator< (nullopt_t, const Optional< T > &opt)
template<class T >
CONSTEXPR bool	operator<= (const Optional< T > &opt, nullopt_t)
template<class T >
CONSTEXPR bool	operator<= (nullopt_t, const Optional< T > &opt)
template<class T >
CONSTEXPR bool	operator> (const Optional< T > &opt, nullopt_t)
template<class T >
CONSTEXPR bool	operator> (nullopt_t, const Optional< T > &opt)
template<class T >
CONSTEXPR bool	operator>= (const Optional< T > &opt, nullopt_t)
template<class T >
CONSTEXPR bool	operator>= (nullopt_t, const Optional< T > &opt)
template<class T , class U >
CONSTEXPR bool	operator== (const Optional< T > &opt, const U &value)
template<class T , class U >
CONSTEXPR bool	operator== (const U &value, const Optional< T > &opt)
template<class T , class U >
CONSTEXPR bool	operator!= (const Optional< T > &opt, const U &value)
template<class T , class U >
CONSTEXPR bool	operator!= (const U &value, const Optional< T > &opt)
template<class T , class U >
CONSTEXPR bool	operator< (const Optional< T > &opt, const U &value)
template<class T , class U >
CONSTEXPR bool	operator< (const U &value, const Optional< T > &opt)
template<class T , class U >
CONSTEXPR bool	operator<= (const Optional< T > &opt, const U &value)
template<class T , class U >
CONSTEXPR bool	operator<= (const U &value, const Optional< T > &opt)
template<class T , class U >
CONSTEXPR bool	operator> (const Optional< T > &opt, const U &value)
template<class T , class U >
CONSTEXPR bool	operator> (const U &value, const Optional< T > &opt)
template<class T , class U >
CONSTEXPR bool	operator>= (const Optional< T > &opt, const U &value)
template<class T , class U >
CONSTEXPR bool	operator>= (const U &value, const Optional< T > &opt)
template<class T >
void	swap (Optional< T > &lhs, Optional< T > &rhs)

Variables
const in_place_t	in_place = {}

Typedef Documentation

any_document_t

typedef commons::cjson::JsonWrapper agora::any_document_t

user_id_t

typedef const char* agora::user_id_t

UserList

typedef util::AList<UserInfo> agora::UserList

view_t

typedef void* agora::view_t

Enumeration Type Documentation

CHANNEL_PROFILE_TYPE

enum agora::CHANNEL_PROFILE_TYPE

The channel profile.

Enumerator
CHANNEL_PROFILE_COMMUNICATION	0: Communication. This profile prioritizes smoothness and applies to the one-to-one scenario.
CHANNEL_PROFILE_LIVE_BROADCASTING	1: (Default) Live Broadcast. This profile prioritizes supporting a large audience in a live broadcast channel.
CHANNEL_PROFILE_GAME	2: Gaming. Deprecated This profile is deprecated.
__deprecated	3: Cloud Gaming. This profile prioritizes low end-to-end latency and applies to scenarios where users interact with each other, and any delay affects the user experience. Deprecated This profile is deprecated.

VIDEO_MODULE_POSITION

enum agora::VIDEO_MODULE_POSITION

Enumerator
POSITION_POST_CAPTURER
POSITION_PRE_RENDERER
POSITION_PRE_ENCODER
POSITION_POST_FILTERS

VIDEO_PIXEL_FORMAT

enum agora::VIDEO_PIXEL_FORMAT

Video pixel formats.

Enumerator
VIDEO_PIXEL_UNKNOWN	0: Unknown format.
VIDEO_PIXEL_I420	1: I420.
VIDEO_PIXEL_BGRA	2: BGRA.
VIDEO_PIXEL_NV21	3: NV21.
VIDEO_PIXEL_RGBA	4: RGBA.
VIDEO_PIXEL_NV12	8: NV12.
VIDEO_TEXTURE_2D	10: GL_TEXTURE_2D
VIDEO_TEXTURE_OES	11: GL_TEXTURE_OES
VIDEO_PIXEL_I422	16: I422.

Function Documentation

nullopt()

const nullopt_t agora::nullopt

(

0

)

operator!=() [1/5]

template<class T , class U >

bool agora::operator!=	(	const Optional< T > &	lhs,
		const Optional< U > &	rhs )

operator!=() [2/5]

template<class T , class U >

CONSTEXPR bool agora::operator!=	(	const Optional< T > &	opt,
		const U &	value )

operator!=() [3/5]

template<class T >

CONSTEXPR bool agora::operator!=	(	const Optional< T > &	opt,
		nullopt_t	)

operator!=() [4/5]

template<class T , class U >

CONSTEXPR bool agora::operator!=	(	const U &	value,
		const Optional< T > &	opt )

operator!=() [5/5]

template<class T >

CONSTEXPR bool agora::operator!=	(	nullopt_t	,
		const Optional< T > &	opt )

operator<() [1/5]

template<class T , class U >

bool agora::operator<	(	const Optional< T > &	lhs,
		const Optional< U > &	rhs )

operator<() [2/5]

template<class T , class U >

CONSTEXPR bool agora::operator<	(	const Optional< T > &	opt,
		const U &	value )

operator<() [3/5]

template<class T >

CONSTEXPR bool agora::operator<	(	const Optional< T > &	opt,
		nullopt_t	)

operator<() [4/5]

template<class T , class U >

CONSTEXPR bool agora::operator<	(	const U &	value,
		const Optional< T > &	opt )

operator<() [5/5]

template<class T >

CONSTEXPR bool agora::operator<	(	nullopt_t	,
		const Optional< T > &	opt )

operator<=() [1/5]

template<class T , class U >

bool agora::operator<=	(	const Optional< T > &	lhs,
		const Optional< U > &	rhs )

operator<=() [2/5]

template<class T , class U >

CONSTEXPR bool agora::operator<=	(	const Optional< T > &	opt,
		const U &	value )

operator<=() [3/5]

template<class T >

CONSTEXPR bool agora::operator<=	(	const Optional< T > &	opt,
		nullopt_t	)

operator<=() [4/5]

template<class T , class U >

CONSTEXPR bool agora::operator<=	(	const U &	value,
		const Optional< T > &	opt )

operator<=() [5/5]

template<class T >

CONSTEXPR bool agora::operator<=	(	nullopt_t	,
		const Optional< T > &	opt )

operator==() [1/5]

template<class T , class U >

bool agora::operator==	(	const Optional< T > &	lhs,
		const Optional< U > &	rhs )

operator==() [2/5]

template<class T , class U >

CONSTEXPR bool agora::operator==	(	const Optional< T > &	opt,
		const U &	value )

operator==() [3/5]

template<class T >

CONSTEXPR bool agora::operator==	(	const Optional< T > &	opt,
		nullopt_t	)

operator==() [4/5]

template<class T , class U >

CONSTEXPR bool agora::operator==	(	const U &	value,
		const Optional< T > &	opt )

operator==() [5/5]

template<class T >

CONSTEXPR bool agora::operator==	(	nullopt_t	,
		const Optional< T > &	opt )

operator>() [1/5]

template<class T , class U >

bool agora::operator>	(	const Optional< T > &	lhs,
		const Optional< U > &	rhs )

operator>() [2/5]

template<class T , class U >

CONSTEXPR bool agora::operator>	(	const Optional< T > &	opt,
		const U &	value )

operator>() [3/5]

template<class T >

CONSTEXPR bool agora::operator>	(	const Optional< T > &	opt,
		nullopt_t	)

operator>() [4/5]

template<class T , class U >

CONSTEXPR bool agora::operator>	(	const U &	value,
		const Optional< T > &	opt )

operator>() [5/5]

template<class T >

CONSTEXPR bool agora::operator>	(	nullopt_t	,
		const Optional< T > &	opt )

operator>=() [1/5]

template<class T , class U >

bool agora::operator>=	(	const Optional< T > &	lhs,
		const Optional< U > &	rhs )

operator>=() [2/5]

template<class T , class U >

CONSTEXPR bool agora::operator>=	(	const Optional< T > &	opt,
		const U &	value )

operator>=() [3/5]

template<class T >

CONSTEXPR bool agora::operator>=	(	const Optional< T > &	opt,
		nullopt_t	)

operator>=() [4/5]

template<class T , class U >

CONSTEXPR bool agora::operator>=	(	const U &	value,
		const Optional< T > &	opt )

operator>=() [5/5]

template<class T >

CONSTEXPR bool agora::operator>=	(	nullopt_t	,
		const Optional< T > &	opt )

swap()

template<class T >

void agora::swap	(	Optional< T > &	lhs,
		Optional< T > &	rhs )

Variable Documentation

in_place

const in_place_t agora::in_place = {}