io.agora.rtc.RtcConnConfig Class Reference

Public Member Functions
	RtcConnConfig ()
	RtcConnConfig (int autoSubscribeAudio, int autoSubscribeVideo, int enableAudioRecordingOrPlayout, int maxSendBitrate, int minPort, int maxPort, AudioSubscriptionOptions audioSubsOptions, int clientRoleType, int channelProfile, int audioRecvMediaPacket, int audioRecvEncodedFrame, int videoRecvMediaPacket)
int	getAutoSubscribeAudio ()
void	setAutoSubscribeAudio (int autoSubscribeAudio)
int	getAutoSubscribeVideo ()
void	setAutoSubscribeVideo (int autoSubscribeVideo)
int	getEnableAudioRecordingOrPlayout ()
void	setEnableAudioRecordingOrPlayout (int enableAudioRecordingOrPlayout)
int	getMaxSendBitrate ()
void	setMaxSendBitrate (int maxSendBitrate)
int	getMinPort ()
void	setMinPort (int minPort)
int	getMaxPort ()
void	setMaxPort (int maxPort)
AudioSubscriptionOptions	getAudioSubsOptions ()
void	setAudioSubsOptions (AudioSubscriptionOptions audioSubsOptions)
int	getClientRoleType ()
void	setClientRoleType (int clientRoleType)
int	getChannelProfile ()
void	setChannelProfile (int channelProfile)
int	getAudioRecvMediaPacket ()
void	setAudioRecvMediaPacket (int audioRecvMediaPacket)
int	getAudioRecvEncodedFrame ()
void	setAudioRecvEncodedFrame (int audioRecvEncodedFrame)
int	getVideoRecvMediaPacket ()
void	setVideoRecvMediaPacket (int videoRecvMediaPacket)
String	toString ()

Private Attributes
int	autoSubscribeAudio = 1
int	autoSubscribeVideo = 1
int	enableAudioRecordingOrPlayout
int	maxSendBitrate
int	minPort
int	maxPort
AudioSubscriptionOptions	audioSubsOptions
int	clientRoleType
int	audioRecvMediaPacket
int	audioRecvEncodedFrame
int	videoRecvMediaPacket
int	channelProfile

Detailed Description

Configurations for an RTC connection.

Set these configurations when calling agoraRtcConnCreate.

Constructor & Destructor Documentation

RtcConnConfig() [1/2]

io.agora.rtc.RtcConnConfig.RtcConnConfig

(

)

RtcConnConfig() [2/2]

io.agora.rtc.RtcConnConfig.RtcConnConfig	(	int	autoSubscribeAudio,
		int	autoSubscribeVideo,
		int	enableAudioRecordingOrPlayout,
		int	maxSendBitrate,
		int	minPort,
		int	maxPort,
		AudioSubscriptionOptions	audioSubsOptions,
		int	clientRoleType,
		int	channelProfile,
		int	audioRecvMediaPacket,
		int	audioRecvEncodedFrame,
		int	videoRecvMediaPacket )

Member Function Documentation

getAudioRecvEncodedFrame()

int io.agora.rtc.RtcConnConfig.getAudioRecvEncodedFrame

(

)

getAudioRecvMediaPacket()

int io.agora.rtc.RtcConnConfig.getAudioRecvMediaPacket

(

)

getAudioSubsOptions()

AudioSubscriptionOptions io.agora.rtc.RtcConnConfig.getAudioSubsOptions

(

)

getAutoSubscribeAudio()

int io.agora.rtc.RtcConnConfig.getAutoSubscribeAudio

(

)

getAutoSubscribeVideo()

int io.agora.rtc.RtcConnConfig.getAutoSubscribeVideo

(

)

getChannelProfile()

int io.agora.rtc.RtcConnConfig.getChannelProfile

(

)

getClientRoleType()

int io.agora.rtc.RtcConnConfig.getClientRoleType

(

)

getEnableAudioRecordingOrPlayout()

int io.agora.rtc.RtcConnConfig.getEnableAudioRecordingOrPlayout

(

)

getMaxPort()

int io.agora.rtc.RtcConnConfig.getMaxPort

(

)

getMaxSendBitrate()

int io.agora.rtc.RtcConnConfig.getMaxSendBitrate

(

)

getMinPort()

int io.agora.rtc.RtcConnConfig.getMinPort

(

)

getVideoRecvMediaPacket()

int io.agora.rtc.RtcConnConfig.getVideoRecvMediaPacket

(

)

setAudioRecvEncodedFrame()

void io.agora.rtc.RtcConnConfig.setAudioRecvEncodedFrame

(

int

audioRecvEncodedFrame

)

setAudioRecvMediaPacket()

void io.agora.rtc.RtcConnConfig.setAudioRecvMediaPacket

(

int

audioRecvMediaPacket

)

setAudioSubsOptions()

void io.agora.rtc.RtcConnConfig.setAudioSubsOptions

(

AudioSubscriptionOptions

audioSubsOptions

)

setAutoSubscribeAudio()

void io.agora.rtc.RtcConnConfig.setAutoSubscribeAudio

(

int

autoSubscribeAudio

)

setAutoSubscribeVideo()

void io.agora.rtc.RtcConnConfig.setAutoSubscribeVideo

(

int

autoSubscribeVideo

)

setChannelProfile()

void io.agora.rtc.RtcConnConfig.setChannelProfile

(

int

channelProfile

)

setClientRoleType()

void io.agora.rtc.RtcConnConfig.setClientRoleType

(

int

clientRoleType

)

setEnableAudioRecordingOrPlayout()

void io.agora.rtc.RtcConnConfig.setEnableAudioRecordingOrPlayout

(

int

enableAudioRecordingOrPlayout

)

setMaxPort()

void io.agora.rtc.RtcConnConfig.setMaxPort

(

int

maxPort

)

setMaxSendBitrate()

void io.agora.rtc.RtcConnConfig.setMaxSendBitrate

(

int

maxSendBitrate

)

setMinPort()

void io.agora.rtc.RtcConnConfig.setMinPort

(

int

minPort

)

setVideoRecvMediaPacket()

void io.agora.rtc.RtcConnConfig.setVideoRecvMediaPacket

(

int

videoRecvMediaPacket

)

toString()

String io.agora.rtc.RtcConnConfig.toString

(

)

Member Data Documentation

audioRecvEncodedFrame

int io.agora.rtc.RtcConnConfig.audioRecvEncodedFrame

private

Whether to recieve encoded audio frame.

• 1: Receive encoded audio frame.
• 0: Do not receive encoded audio frame.

audioRecvMediaPacket

int io.agora.rtc.RtcConnConfig.audioRecvMediaPacket

private

Whether to receive audio media packet.

• 1: Receive audio media packet.
• 0: Do not receive audio media packet.

audioSubsOptions

AudioSubscriptionOptions io.agora.rtc.RtcConnConfig.audioSubsOptions

private

The options for audio subscription.

autoSubscribeAudio

int io.agora.rtc.RtcConnConfig.autoSubscribeAudio = 1

private

Parameters

autoSubscribeAudio

Whether to subscribe to all audio tracks automatically. 1: (Default) Subscribe to all audio tracks automatically. 0: Do not subscribe to any audio track automatically.

autoSubscribeVideo

int io.agora.rtc.RtcConnConfig.autoSubscribeVideo = 1

private

Whether to subscribe to all video tracks automatically.

• 1: (Default) Subscribe to all video tracks automatically.
• 0: Do not subscribe to any video track automatically.

channelProfile

int io.agora.rtc.RtcConnConfig.channelProfile

private

clientRoleType

int io.agora.rtc.RtcConnConfig.clientRoleType

private

The user role.

• 1: Broadcaster. A broadcaster can both send and receive streams.
• 2: (Default) Audience. An audience can only receive streams.

enableAudioRecordingOrPlayout

int io.agora.rtc.RtcConnConfig.enableAudioRecordingOrPlayout

private

Whether to enable audio recording or playout.

• 0: It's used to publish extenal audio frame only without mixing microphone, or does not need audio device for playout either.
• 1: It's used to publish audio and mix microphone, or subscribe audio and playout.

maxPort

int io.agora.rtc.RtcConnConfig.maxPort

private

The maximum port.

maxSendBitrate

int io.agora.rtc.RtcConnConfig.maxSendBitrate

private

The maximum sending bitrate.

minPort

int io.agora.rtc.RtcConnConfig.minPort

private

The minimum port.

videoRecvMediaPacket

int io.agora.rtc.RtcConnConfig.videoRecvMediaPacket

private

Whether to receive video media packet.

• 1: Receive video media packet.
• 0: Do not receive video media packet.

---

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

• RtcConnConfig.java