Agora RTC Objective-C API Reference  Refactor
Data Structures | Namespaces | Macros
IAgoraParameter.h File Reference

Go to the source code of this file.

Data Structures

class  IAgoraParameter
 

Namespaces

 agora
 
 agora::util
 
 agora::base
 

Macros

#define KEY_RTC_UDP_SEND_FD   "rtc.udp_send_fd"
 
#define KEY_RTC_VIDEO_ENABLED_HW_ENCODER   "engine.video.enable_hw_encoder"
 
#define KEY_RTC_VIDEO_HW_ENCODER_PROVIDER   "engine.video.hw_encoder_provider"
 
#define KEY_RTC_VIDEO_ENABLED_HW_DECODER   "engine.video.enable_hw_decoder"
 
#define KEY_RTC_VIDEO_HW_DECODER_PROVIDER   "engine.video.hw_decoder_provider"
 
#define KEY_RTC_VIDEO_OVERRIDE_SMALLVIDEO_NOT_USE_HWENC_POLICY   "engine.video.override_smallvideo_not_use_hwenc_policy"
 
#define KEY_RTC_VIDEO_RESEND   "rtc.video_resend"
 
#define KEY_RTC_AUDIO_RESEND   "rtc.audio_resend"
 
#define KEY_RTC_AUDIO_ENABLE_AGORA_AEC   "rtc.audio.aec.enable"
 
#define KEY_RTC_AUDIO_AEC_AGGRESSIVENESS   "rtc.audio.aec.aggressiveness"
 
#define KEY_RTC_AUDIO_ENABLE_AGORA_AGC   "rtc.audio.agc.enable"
 
#define KEY_RTC_AUDIO_ENABLE_AGORA_ANS   "rtc.audio.ans.enable"
 
#define KEY_RTC_AUDIO_ENABLE_AGORA_MD   "rtc.audio.md.enable"
 
#define KEY_RTC_AUDIO_OPENSL_MODE   "rtc.audio.opensl.mode"
 
#define KEY_RTC_AUDIO_INPUT_SAMPLE_RATE   "rtc.audio.input_sample_rate"
 
#define KEY_RTC_AUDIO_KEEP_AUDIOSESSION   "rtc.audio.keep.audiosession"
 
#define KEY_RTC_VIDEO_BITRATE_ADJUST_RATIO   "rtc.video.bitrate_adjust_ratio"
 
#define KEY_RTC_VIDEO_MINBITRATE_RATIO   "rtc.video.minbitrate_ratio"
 
#define KEY_RTC_VIDEO_DEGRADATION_PREFERENCE   "rtc.video.degradation_preference"
 
#define KEY_RTC_VIDEO_DEGRADATION_FPS_DOWN_STEP   "rtc.video.degradation_fps_down_step"
 
#define KEY_RTC_VIDEO_DEGRADATION_FPS_UP_STEP   "rtc.video.degradation_fps_up_step"
 
#define KEY_RTC_CONNECTION_LOST_PERIOD   "rtc.connection_lost_period"
 
#define KEY_RTC_LOCAL_IP   "rtc.local.ip"
 
#define KEY_RTC_NETWORK_INTERFACE   "rtc.network.interface"
 
#define KEY_RTC_VIDEO_CODEC_TYPE   "engine.video.codec_type"
 
#define KEY_RTC_VIDEO_QUALITY_SCALE_ONLY_ON_AVERAGE_QP   "engine.video.quality_scale_only_on_average_qp"
 
#define KEY_RTC_VIDEO_H264_QP_THRESHOLD_LOW   "engine.video.h264_qp_thresholds_low"
 
#define KEY_RTC_VIDEO_H264_QP_THRESHOLD_HIGH   "engine.video.h264_qp_thresholds_high"
 

Macro Definition Documentation

◆ KEY_RTC_UDP_PORT_RANGE

#define KEY_RTC_UDP_PORT_RANGE   "rtc.udp_port_range"

◆ KEY_RTC_UDP_PORT_LIST

#define KEY_RTC_UDP_PORT_LIST   "rtc.udp_port_list"

◆ KEY_RTC_UDP_SEND_FD

#define KEY_RTC_UDP_SEND_FD   "rtc.udp_send_fd"

get the fd of sending socket available for connection note: set method is not supported.

◆ KEY_RTC_VIDEO_ENABLED_HW_ENCODER

#define KEY_RTC_VIDEO_ENABLED_HW_ENCODER   "engine.video.enable_hw_encoder"

set the video encoder mode (hardware or software)

◆ KEY_RTC_VIDEO_HW_ENCODER_PROVIDER

#define KEY_RTC_VIDEO_HW_ENCODER_PROVIDER   "engine.video.hw_encoder_provider"

set the hardware video encoder provider (nv for nvidia or qsv for intel)

◆ KEY_RTC_VIDEO_ENABLED_HW_DECODER

#define KEY_RTC_VIDEO_ENABLED_HW_DECODER   "engine.video.enable_hw_decoder"

set the video decoder mode (hardware or software)

◆ KEY_RTC_VIDEO_HW_DECODER_PROVIDER

#define KEY_RTC_VIDEO_HW_DECODER_PROVIDER   "engine.video.hw_decoder_provider"

set the hardware video decoder provider (h264_cuvid(default) or h264_qsv)

◆ KEY_RTC_VIDEO_OVERRIDE_SMALLVIDEO_NOT_USE_HWENC_POLICY

#define KEY_RTC_VIDEO_OVERRIDE_SMALLVIDEO_NOT_USE_HWENC_POLICY   "engine.video.override_smallvideo_not_use_hwenc_policy"

override the lua policy

◆ KEY_RTC_VIDEO_RESEND

#define KEY_RTC_VIDEO_RESEND   "rtc.video_resend"

enable/disable video packet retransmission, enabled by default

◆ KEY_RTC_AUDIO_RESEND

#define KEY_RTC_AUDIO_RESEND   "rtc.audio_resend"

enable/disable audio packet retransmission, enabled by default

◆ KEY_RTC_AUDIO_ENABLE_AGORA_AEC

#define KEY_RTC_AUDIO_ENABLE_AGORA_AEC   "rtc.audio.aec.enable"

enable/disable agora aec logic, enabled by default

◆ KEY_RTC_AUDIO_AEC_AGGRESSIVENESS

#define KEY_RTC_AUDIO_AEC_AGGRESSIVENESS   "rtc.audio.aec.aggressiveness"

update aec aggressiveness level

◆ KEY_RTC_AUDIO_MAX_TARGET_DELAY

#define KEY_RTC_AUDIO_MAX_TARGET_DELAY   "rtc.audio.max_target_delay"

◆ KEY_RTC_AUDIO_ENABLE_AGORA_AGC

#define KEY_RTC_AUDIO_ENABLE_AGORA_AGC   "rtc.audio.agc.enable"

enable/disable agora agc logic, enabled by default

◆ KEY_RTC_AUDIO_ENABLE_AGORA_ANS

#define KEY_RTC_AUDIO_ENABLE_AGORA_ANS   "rtc.audio.ans.enable"

enable/disable agora ans logic, enabled by default

◆ KEY_RTC_AUDIO_ENABLE_AGORA_MD

#define KEY_RTC_AUDIO_ENABLE_AGORA_MD   "rtc.audio.md.enable"

enable/disable agora md logic, enabled by default

◆ KEY_RTC_AUDIO_OPENSL_MODE

#define KEY_RTC_AUDIO_OPENSL_MODE   "rtc.audio.opensl.mode"

set the OpenSL mode for Android audio

◆ KEY_RTC_AUDIO_OBOE_ENABLE

#define KEY_RTC_AUDIO_OBOE_ENABLE   "rtc.audio.oboe.enable"

◆ KEY_RTC_AUDIO_ENABLE_HARDWARE_EAR_MONITOR

#define KEY_RTC_AUDIO_ENABLE_HARDWARE_EAR_MONITOR   "rtc.audio.enable_hardware_ear_monitor"

◆ KEY_RTC_AUDIO_INPUT_SAMPLE_RATE

#define KEY_RTC_AUDIO_INPUT_SAMPLE_RATE   "rtc.audio.input_sample_rate"

set the adm input sample rate

◆ KEY_RTC_AUDIO_FORCE_USE_MEDIA_VOLUME

#define KEY_RTC_AUDIO_FORCE_USE_MEDIA_VOLUME   "rtc.audio.force_use_media_volume"

◆ KEY_RTC_AUDIO_FORCE_BLUETOOTH_A2DP

#define KEY_RTC_AUDIO_FORCE_BLUETOOTH_A2DP   "rtc.audio.force_bluetooth_a2dp"

◆ KEY_RTC_AUDIO_KEEP_AUDIOSESSION

#define KEY_RTC_AUDIO_KEEP_AUDIOSESSION   "rtc.audio.keep.audiosession"

set the adm keep audiosession

◆ KEY_RTC_AUDIO_USE_MEDIA_VOLUME_IN_BLUETOOTH

#define KEY_RTC_AUDIO_USE_MEDIA_VOLUME_IN_BLUETOOTH   "rtc.audio.use_media_volume_in_bluetooth"

◆ KEY_RTC_VIDEO_BITRATE_ADJUST_RATIO

#define KEY_RTC_VIDEO_BITRATE_ADJUST_RATIO   "rtc.video.bitrate_adjust_ratio"

set the bitrate ratio for video

◆ KEY_RTC_VIDEO_MINBITRATE_RATIO

#define KEY_RTC_VIDEO_MINBITRATE_RATIO   "rtc.video.minbitrate_ratio"

set the minbitrate / bitrate ratio for video

◆ KEY_RTC_VIDEO_DEGRADATION_PREFERENCE

#define KEY_RTC_VIDEO_DEGRADATION_PREFERENCE   "rtc.video.degradation_preference"

set the degradation preference

◆ KEY_RTC_VIDEO_DEGRADATION_FPS_DOWN_STEP

#define KEY_RTC_VIDEO_DEGRADATION_FPS_DOWN_STEP   "rtc.video.degradation_fps_down_step"

set the degradation fps down step

◆ KEY_RTC_VIDEO_DEGRADATION_FPS_UP_STEP

#define KEY_RTC_VIDEO_DEGRADATION_FPS_UP_STEP   "rtc.video.degradation_fps_up_step"

set the degradation fps up step

◆ KEY_RTC_CONNECTION_LOST_PERIOD

#define KEY_RTC_CONNECTION_LOST_PERIOD   "rtc.connection_lost_period"

set the duration ms for connection lost callback

◆ KEY_RTC_LOCAL_IP

#define KEY_RTC_LOCAL_IP   "rtc.local.ip"

set the local ip

◆ KEY_RTC_NETWORK_INTERFACE

#define KEY_RTC_NETWORK_INTERFACE   "rtc.network.interface"

set the network interface

◆ KEY_RTC_VIDEO_CODEC_TYPE

#define KEY_RTC_VIDEO_CODEC_TYPE   "engine.video.codec_type"

set the video codec type, such as "H264", "JPEG"

◆ KEY_RTC_VIDEO_QUALITY_SCALE_ONLY_ON_AVERAGE_QP

#define KEY_RTC_VIDEO_QUALITY_SCALE_ONLY_ON_AVERAGE_QP   "engine.video.quality_scale_only_on_average_qp"

only use average QP for quality scaling

◆ KEY_RTC_VIDEO_H264_QP_THRESHOLD_LOW

#define KEY_RTC_VIDEO_H264_QP_THRESHOLD_LOW   "engine.video.h264_qp_thresholds_low"

low bound for quality scaling

◆ KEY_RTC_VIDEO_H264_QP_THRESHOLD_HIGH

#define KEY_RTC_VIDEO_H264_QP_THRESHOLD_HIGH   "engine.video.h264_qp_thresholds_high"

high bound for quality scaling