Server Gateway SDK v3.7.200.21 for Linux Java
Public Member Functions | List of all members
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 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 getVideoRecvMediaPacket ()
void setVideoRecvMediaPacket (int videoRecvMediaPacket)

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  videoRecvMediaPacket 


autoSubscribeAudioWhether to subscribe to all audio tracks automatically.
  • 0: (Default) Subscribe to all audio tracks automatically.
  • 1: Do not subscribe to any audio track automatically.
autoSubscribeVideoWhether to subscribe to all video tracks automatically.
  • 0: (Default) Subscribe to all video tracks automatically.
  • 1: Do not subscribe to any video track automatically.
enableAudioRecordingOrPlayoutWhether to enable audio recording or playout.
  • 0: 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.
  • 1: 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.
maxSendBitrateThe maximum sending bitrate.
minPortThe minimum port.
maxPortThe maximum port.
audioSubsOptionsThe options for audio subscription.
clientRoleTypeThe user role.
  • 1: Broadcaster. A broadcaster can both send and receive streams.
  • 2: Audience. An audience can only receive streams.
channelProfileThe channel profile.
  • 0: Communication. This profile prioritizes smoothness and applies to the one-to-one scenario.
  • 1: (Default) Live Broadcast. This profile prioritizes supporting a large audience in a live broadcast channel.
  • 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.
audioRecvMediaPacketWhether to receive audio media packet.
audioRecvMediaPacketWhether to receive video media packet.

Member Function Documentation

◆ 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 ( )

◆ 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)

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