#include <NGIAgoraRtcConnection.h>

Public Member Functions
	RtcConnectionConfiguration ()

Public Attributes
bool	autoSubscribeAudio

bool	autoSubscribeVideo

bool	enableAudioRecordingOrPlayout

int	maxSendBitrate

int	minPort

int	maxPort

CLIENT_ROLE_TYPE	clientRoleType

CHANNEL_PROFILE_TYPE	channelProfile

bool	audioRecvMediaPacket

bool	videoRecvMediaPacket

Detailed Description

Configurations for an RTC connection.

Set these configurations when calling createRtcConnection.

Constructor & Destructor Documentation

◆ RtcConnectionConfiguration()

agora::rtc::RtcConnectionConfiguration::RtcConnectionConfiguration ( )

inline

Member Data Documentation

◆ audioRecvMediaPacket

bool agora::rtc::RtcConnectionConfiguration::audioRecvMediaPacket

Whether to receive audio media packet.

◆ autoSubscribeAudio

bool agora::rtc::RtcConnectionConfiguration::autoSubscribeAudio

Whether to subscribe to all audio tracks automatically.

true: (Default) Subscribe to all audio tracks automatically.
false: Do not subscribe to any audio track automatically.

◆ autoSubscribeVideo

bool agora::rtc::RtcConnectionConfiguration::autoSubscribeVideo

Whether to subscribe to all video tracks automatically.

true: (Default) Subscribe to all video tracks automatically.
false: Do not subscribe to any video track automatically.

◆ channelProfile

CHANNEL_PROFILE_TYPE agora::rtc::RtcConnectionConfiguration::channelProfile

The channel profile. For details, see CHANNEL_PROFILE_TYPE. The default channel profile is CHANNEL_PROFILE_LIVE_BROADCASTING.

◆ clientRoleType

CLIENT_ROLE_TYPE agora::rtc::RtcConnectionConfiguration::clientRoleType

The user role. For details, see CLIENT_ROLE_TYPE. The default user role is CLIENT_ROLE_AUDIENCE.

◆ enableAudioRecordingOrPlayout

bool agora::rtc::RtcConnectionConfiguration::enableAudioRecordingOrPlayout

Whether to enable audio recording or playout.

true: Enables audio recording or playout. Use this option when you publish and mix audio tracks, or subscribe to one or multiple audio tracks and play audio.
false: Disables audio recording or playout. Use this option when you publish external audio frames without audio mixing, or you do not need audio devices to play audio.

◆ maxPort

int agora::rtc::RtcConnectionConfiguration::maxPort

The maximum port.

◆ maxSendBitrate

int agora::rtc::RtcConnectionConfiguration::maxSendBitrate

The maximum sending bitrate.

◆ minPort

int agora::rtc::RtcConnectionConfiguration::minPort

The minimum port.

◆ videoRecvMediaPacket

bool agora::rtc::RtcConnectionConfiguration::videoRecvMediaPacket

Whether to receive video media packet.

The documentation for this struct was generated from the following file:

NGIAgoraRtcConnection.h

Public Member Functions

Public Attributes