Agora Java API Reference for Android
config_engine_i.h
1 //
2 // Agora Media SDK
3 //
4 // Copyright (c) 2020 Agora IO. All rights reserved.
5 //
6 #pragma once
7 
8 #include <cstdint>
9 #include <functional>
10 #include <string>
11 #include <unordered_set>
12 #include <utility>
13 
14 // internal key
15 #define INTERNAL_KEY_NT_ET_AP_PORT "nt.et.ap_port"
16 #define INTERNAL_KEY_NT_ET_ET_PORT_LIST "nt.et.et_port_list"
17 #define INTERNAL_KEY_NT_ET_AP_LIST "nt.et.ap_list"
18 #define INTERNAL_KEY_NT_ET_ET_LIST "nt.et.et_list"
19 #define INTERNAL_KEY_NT_PT_PUBLIC_DOMAIN_LIST "nt.pt.public_domain_list"
20 #define INTERNAL_KEY_RTC_AUDIO_MUTE_ME "rtc.audio.mute_me"
21 #define INTERNAL_KEY_RTC_AUDIO_MUTE_PEERS "rtc.audio.mute_peers"
22 #define INTERNAL_KEY_RTC_AUDIO_SET_DEFAULT_MUTE_PEERS "rtc.audio.set_default_mute_peers"
23 #define INTERNAL_KEY_RTC_AUDIO_MUTE_PEER "rtc.audio.mute_peer"
24 #define INTERNAL_KEY_RTC_AUDIO_UPLINK_MAX_RETRY_TIMES "rtc.audio.uplink_max_retry_times"
25 #define INTERNAL_KEY_RTC_AUDIO_DOWNLINK_MAX_RETRY_TIMES "rtc.audio.downlink_max_retry_times"
26 #define INTERNAL_KEY_RTC_AUDIO_ENABLED "rtc.audio.enabled"
27 #define INTERNAL_KEY_RTC_AUDIO_PAUSED "rtc.audio.paused"
28 #define INTERNAL_KEY_RTC_AUDIO_CODEC "rtc.audio.codec"
29 #define INTERNAL_KEY_RTC_AUDIO_DTX "rtc.audio.dtx"
30 #define INTERNAL_KEY_RTC_AUDIO_OPTIONS "rtc.audio.options"
31 #define INTERNAL_KEY_RTC_AUDIO_FRAMES_PER_PACKET "rtc.audio.frames_per_packet"
32 #define INTERNAL_KEY_RTC_AUDIO_INTERLEAVES_PER_PACKET "rtc.audio.interleaves_per_packet"
33 #define INTERNAL_KEY_RTC_AUDIO_HIGH_QUALITY_MODE "rtc.audio.high.quality.mode"
34 #define INTERNAL_KEY_RTC_AUDIO_NETWORK_OPTIMIZED "rtc.audio.network_optimized"
35 #define INTERNAL_KEY_RTC_AUDIO_INSTANT_JOIN_OPTIMIZED "rtc.audio.instant_join_optimized"
36 #define INTERNAL_KEY_RTC_AUDIO_START_CALL "rtc.audio.start_call"
37 #define INTERNAL_KEY_RTC_AUDIO_APM_DUMP "rtc.audio.apm_dump"
38 #define INTERNAL_KEY_RTC_AUDIO_FRAME_DUMP "rtc.audio.frame_dump"
39 #define INTERNAL_KEY_RTC_VIDEO_MUTE_ME "rtc.video.mute_me"
40 #define INTERNAL_KEY_RTC_VIDEO_MUTE_PEERS "rtc.video.mute_peers"
41 #define INTERNAL_KEY_RTC_VIDEO_SET_DEFAULT_MUTE_PEERS "rtc.video.set_default_mute_peers"
42 #define INTERNAL_KEY_RTC_VIDEO_MUTE_PEER "rtc.video.mute_peer"
43 #define INTERNAL_KEY_RTC_VIDEO_SET_REMOTE_VIDEO_STREAM "rtc.video.set_remote_video_stream"
44 #define INTERNAL_KEY_RTC_VIDEO_SET_REMOTE_DEFAULT_VIDEO_STREAM_TYPE "rtc.video.set_remote_default_video_stream_type"
45 #define INTERNAL_KEY_RTC_VIDEO_CAPTURE "rtc.video.capture"
46 #define INTERNAL_KEY_RTC_VIDEO_ENABLED "rtc.video.enabled"
47 #define INTERNAL_KEY_RTC_VIDEO_PREVIEW "rtc.video.preview"
48 #define INTERNAL_KEY_RTC_VIDEO_AUDIENCE_PREVIEW "rtc.video.audience_preview"
49 #define INTERNAL_KEY_RTC_VIDEO_LOCAL_MIRRORED "rtc.video.local_mirrored"
50 #define INTERNAL_KEY_RTC_VIDEO_BITRATE_LIMIT "rtc.video.bitrate_limit"
51 #define INTERNAL_KEY_RTC_VIDEO_PROFILE "rtc.video.profile"
52 #define INTERNAL_KEY_RTC_VIDEO_ENGINE_PROFILE "rtc.video.engine_profile"
53 #define INTERNAL_KEY_RTC_VIDEO_CACHE "rtc.video.cache"
54 #define INTERNAL_KEY_RTC_VIDEO_CODEC "rtc.video.codec"
55 #define INTERNAL_KEY_RTC_VIDEO_PREFER_FRAME_RATE "rtc.video.prefer_frame_rate"
56 #define INTERNAL_KEY_RTC_VIDEO_WEB_H264_INTEROP_ENABLE "rtc.video.web_h264_interop_enable"
57 #define INTERNAL_KEY_RTC_VIDEO_CUSTOM_PROFILE "rtc.video.custom_profile"
58 #define INTERNAL_KEY_RTC_VIDEO_UPLINK_MAX_RETRY_TIMES "rtc.video.uplink_max_retry_times"
59 #define INTERNAL_KEY_RTC_VIDEO_DOWNLINK_MAX_RETRY_TIMES "rtc.video.downlink_max_retry_times"
60 #define INTERNAL_KEY_RTC_VIDEO_RSFEC_MIN_LEVEL "rtc.video.rsfec_min_level"
61 #define INTERNAL_KEY_RTC_PEER_OFFLINE_PERIOD "rtc.peer.offline_period"
62 #define INTERNAL_KEY_RTC_CONNECTION_TIMEOUT_PERIOD "rtc.connection_timeout_period"
63 #define INTERNAL_KEY_RTC_CHANNEL_MODE "rtc.channel_mode"
64 #define INTERNAL_KEY_RTC_AP_PORT "rtc.ap_port"
65 #define INTERNAL_KEY_RTC_VOCS_PORT "rtc.vocs_port"
66 #define INTERNAL_KEY_RTC_STUN_PORT "rtc.stun_port"
67 #define INTERNAL_KEY_RTC_LASTMILE_PROBE_TEST "rtc.lastmile_probe_test"
68 #define INTERNAL_KEY_RTC_AP_LIST "rtc.ap_list"
69 #define INTERNAL_KEY_RTC_VOCS_LIST "rtc.vocs_list"
70 #define INTERNAL_KEY_RTC_VOS_IP_PORT_LIST "rtc.vos_list"
71 #define INTERNAL_KEY_RTC_PRIORITY_VOS_IP_PORT_LIST "rtc.priority_vos_list"
72 #define INTERNAL_KEY_RTC_STUN_PORT "rtc.stun_port"
73 #define INTERNAL_KEY_RTC_ICE_LIST "rtc.ice_list"
74 #define INTERNAL_KEY_RTC_STUN_LIST "rtc.stun_list"
75 #define INTERNAL_KEY_RTC_ICE_LIST2 "rtc.ice_list2"
76 #define INTERNAL_KEY_RTC_RENEW_TOKEN "rtc.renew_token"
77 #define INTERNAL_KEY_RTC_NETOB "rtc.netob"
78 #define INTERNAL_KEY_RTC_PROXY_SERVER "rtc.proxy_server"
79 #define INTERNAL_KEY_RTC_ENABLE_PROXY_SERVER "rtc.enable_proxy"
80 #define INTERNAL_KEY_RTC_CROSS_CHANNEL_PARAM "rtc.cross_channel_param"
81 #define INTERNAL_KEY_RTC_CROSS_CHANNEL_ENABLED "rtc.cross_channel_enabled"
82 #define INTERNAL_KEY_RTC_ACTIVE_VOS_LIST "rtc.active_vos_list"
83 #define INTERNAL_KEY_RTC_JOINED_VOS "rtc.joined.vos"
84 #define INTERNAL_KEY_RTC_LOCAL_PUBLISH_FALLBACK_OPTION "rtc.local_publish_fallback_option"
85 #define INTERNAL_KEY_RTC_REMOTE_SUBSCRIBE_FALLBACK_OPTION "rtc.remote_subscribe_fallback_option"
86 #define INTERNAL_KEY_RTC_PUBLIC_DOMAIN_LIST "rtc.public_domain_list"
87 #define INTERNAL_KEY_RTC_VOET_LIST "rtc.voet_list"
88 #define INTERNAL_KEY_RTC_VOET_PORT_LIST "rtc.voet_port_list"
89 #define INTERNAL_KEY_RTC_SIGNAL_DEBUG "rtc.signal_debug"
90 #define INTERNAL_KEY_RTC_AUDIO_QUALITY_INDICATION "rtc.audio_quality_indication"
91 #define INTERNAL_KEY_RTC_TRANSPORT_QUALITY_INDICATION "rtc.transport_quality_indication"
92 #define INTERNAL_KEY_RTC_COMPATIBLE_MODE "rtc.compatible_mode"
93 #define INTERNAL_KEY_RTC_CLIENT_TYPE "rtc.client_type"
94 #define INTERNAL_KEY_RTC_EXTENSIONID "rtc.extension_id"
95 #define INTERNAL_KEY_RTC_REPORT_LEVEL "rtc.report_level"
96 #define INTERNAL_KEY_RTC_CHANNEL_PROFILE "rtc.channel_profile"
97 #define INTERNAL_KEY_RTC_CLIENT_ROLE "rtc.client_role"
98 #define INTERNAL_KEY_RTC_DUAL_STREAM_MODE "rtc.dual_stream_mode"
99 #define INTERNAL_KEY_RTC_ENCRYPTION_MASTER_KEY "rtc.encryption.master_key"
100 #define INTERNAL_KEY_RTC_ENCRYPTION_MODE "rtc.encryption.mode"
101 #define INTERNAL_KEY_RTC_FORCE_UNIFIED_COMMUNICATION_MODE "rtc.force_unified_communication_mode"
102 #define INTERNAL_KEY_RTC_TRY_P2P_ONLY_ONCE "rtc.try_p2p_only_once"
103 #define INTERNAL_KEY_RTC_APPLY_DEFAULT_CONFIG "rtc.apply_default_config"
104 #define INTERNAL_KEY_RTC_CACHE_CONFIG "rtc.cache_config"
105 #define INTERNAL_KEY_RTC_DUAL_SIGNALING_MODE "rtc.dual_signaling_mode"
106 #define INTERNAL_KEY_RTC_LIVE_DUAL_LBS_MODE "rtc.live_dual_lbs_mode"
107 #define INTERNAL_KEY_RTC_GEN_NOTIFICATION_WITH_ID "rtc.gen_notification_with_id"
108 #define INTERNAL_KEY_RTC_UPLOAD_LOG "rtc.upload_log"
109 #define INTERNAL_KEY_RTC_EXTENSION_LIST "rtc.extension_list"
110 #define INTERNAL_KEY_RTC_REQ_JOIN_PUBLISHER "rtc.req.join_publisher"
111 #define INTERNAL_KEY_RTC_RES_JOIN_PUBLISHER "rtc.res.join_publisher"
112 #define INTERNAL_KEY_RTC_REQ_REMOVE_PUBLISHER "rtc.req.remove_publisher"
113 #define INTERNAL_KEY_RTC_ENABLE_API_TRACER "rtc.enable_api_tracer"
114 #define INTERNAL_KEY_RTC_RECORDING_CONFIG "rtc.recording.config"
115 #define INTERNAL_KEY_RTC_AUDIO_FEC "rtc.audio_fec"
116 #define INTERNAL_KEY_RTC_CAPABILITIES "rtc.capabilities"
117 #define INTERNAL_KEY_RTC_USER_ACCOUNT_SERVER_LIST "rtc.user_account_server_list"
118 #define INTERNAL_KEY_RTC_WORK_MANAGER_ACCOUNT_LIST "rtc.work_manager_account_list"
119 #define INTERNAL_KEY_RTC_WORK_MANAGER_ADDR_LIST "rtc.work_manager_addr_list"
120 #define INTERNAL_KEY_RTC_REPORT_TYPE "rtc.report_type"
121 #define INTERNAL_KEY_RTC_AUDIO_FROZEN_TYPE_IN_API "rtc.audio.frozen_type_in_api"
122 #define CONFIGURABLE_KEY_RTC_VIDEO_PLAYOUT_DELAY_MAX "rtc.video.playout_delay_max"
123 #define CONFIGURABLE_KEY_RTC_VIDEO_PLAYOUT_DELAY_MIN "rtc.video.playout_delay_min"
124 #define INTERNAL_KEY_RTC_DISABLE_INTRA_REQUEST "rtc.disable_intra_request"
125 #define CONFIGURABLE_KEY_RTC_UPLOAD_LOG_REQUEST "rtc.upload_log_request"
126 #define CONFIGURABLE_KEY_RTC_WIN_ALLOW_MAGNIFICATION "rtc.win_allow_magnification"
127 #define CONFIGURABLE_KEY_RTC_WIN_ALLOW_DIRECTX "rtc.win_allow_directx"
128 #define CONFIGURABLE_KEY_SDK_DEBUG_ENABLE "rtc.debug.enable"
129 #define INTERNAL_KEY_SDK_DEBUG_COMMAND "rtc.debug.command"
130 #define INTERNAL_KEY_RTC_TEST_CONFIG_SERVICE "rtc.test_config_service"
131 #define CONFIGURABLE_KEY_RTC_AEC3_ENABLE "rtc.aec3.enable"
132 #define CONFIGURABLE_KEY_RTC_AUDIO_ENABLE_OPENSL "rtc.audio.opensl"
133 #define CONFIGURABLE_KEY_RTC_AUDIO_BANNED_SL_LEVEL "rtc.audio.banned_sl_level"
134 #define CONFIGURABLE_KEY_RTC_AUDIO_HIGH_QUALITY_ENABLE_OPENSL_WITH_HEADSET "rtc.audio.highQuality.enableOpenSL.withHeadset"
135 #define CONFIGURABLE_KEY_RTC_AUDIO_IO_BUFFER_PERIOD_WITH_OPENSL "rtc.audio.io_buffer_period.withOpenSL"
136 #define CONFIGURABLE_KEY_RTC_AUDIO_ADM_LAYER "rtc.audio.admlayer"
137 #define CONFIGURABLE_KEY_RTC_REPORT_CONFIG "rtc.report_config"
138 #define CONFIGURABLE_KEY_RTC_AUDIO_PLAYBUFSIZE_FACTOR "rtc.audio.playbufsize_factor"
139 #define INTERNAL_KEY_CHE_AUDIO_PROFILE "che.audio.profile"
140 #define INTERNAL_KEY_CHE_AUDIO_USE_MEDIA_VOLUME_IN_HEADSET "che.audio.use_media_volume_in_headset"
141 #define INTERNAL_KEY_CHE_AUDIO_USE_MEDIA_VOLUME_IN_AUDIENCE "che.audio.use_media_volume_in_audience"
142 #define INTERNAL_KEY_CHE_AUDIO_USE_MEDIA_VOLUME_IN_SOLO "che.audio.use_media_volume_in_solo"
143 #define CONFIGURABLE_KEY_RTC_IP_AREACODE "rtc.ip_area_code"
144 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_CN "rtc.ip_cn_area"
145 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_NA "rtc.ip_na_area"
146 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_EUR "rtc.ip_eur_area"
147 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_AS "rtc.ip_as_area"
148 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_JP "rtc.ip_jp_area"
149 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_IN "rtc.ip_india_area"
150 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_OCEANIA "rtc.ip_oceania_area"
151 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_SA "rtc.ip_south_america_area"
152 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_AFRICA "rtc.ip_africa_area"
153 #define CONFIGURABLE_KEY_RTC_IP_AREACODE_OVERSEA "rtc.ip_oversea_area"
154 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_CN "rtc.ip_tls_cn_area"
155 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_NA "rtc.ip_tls_na_area"
156 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_EUR "rtc.ip_tls_eur_area"
157 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_AS "rtc.ip_tls_as_area"
158 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_JP "rtc.ip_tls_jp_area"
159 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_IN "rtc.ip_tls_indian_area"
160 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_OC "rtc.ip_tls_oceania_area"
161 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_SA "rtc.ip_tls_south_america_area"
162 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_AF "rtc.ip_tls_africa_area"
163 #define CONFIGURABLE_KEY_RTC_IP_TLS_AREACODE_OVS "rtc.ip_tls_oversea_area"
164 #define CONFIGURABLE_KEY_RTC_PROXY_IP_AREACODE_CN "rtc.proxy.ip_cn_area"
165 #define CONFIGURABLE_KEY_RTC_PROXY_IP_AREACODE_NA "rtc.proxy.ip_na_area"
166 #define CONFIGURABLE_KEY_RTC_PROXY_IP_AREACODE_EUR "rtc.proxy.ip_eur_area"
167 #define CONFIGURABLE_KEY_RTC_PROXY_IP_AREACODE_AS "rtc.proxy.ip_as_area"
168 #define CONFIGURABLE_KEY_RTC_PROXY_IP_TLS_AREACODE_CN "rtc.proxy.ip_tls_cn_area"
169 #define CONFIGURABLE_KEY_RTC_PROXY_IP_TLS_AREACODE_NA "rtc.proxy.ip_tls_na_area"
170 #define CONFIGURABLE_KEY_RTC_PROXY_IP_TLS_AREACODE_EUR "rtc.proxy.ip_tls_eur_area"
171 #define CONFIGURABLE_KEY_RTC_PROXY_IP_TLS_AREACODE_AS "rtc.proxy.ip_tls_as_area"
172 #define CONFIGURABLE_KEY_RTC_ENABLE_DNS "rtc.enable_dns"
173 #define INTERNAL_KEY_RTC_PROXY_AP_PORTS "rtc.proxy.ap_ports"
174 #define INTERNAL_KEY_RTC_PROXY_AP_AUT_PORTS "rtc.proxy.ap_aut_ports"
175 #define INTERNAL_KEY_RTC_PROXY_AP_TLS_PORTS "rtc.proxy.ap_tls_ports"
176 #define INTERNAL_KEY_RTC_PROXY_AP_TLS_443_PORTS "rtc.proxy.tls_443_ports"
177 #define INTERNAL_KEY_RTC_JOIN_CHANNEL_TIMEOUT "rtc.join_channel_timeout"
178 #define CONFIGURABLE_KEY_RTC_FIRST_FRAME_DECODED_TIMEOUT "rtc.first_frame_decoded_timeout"
179 #define CONFIGURABLE_KEY_RTC_JOIN_TO_FIRST_DECODED_TIMEOUT "rtc.join_to_first_decoded_timeout"
180 #define CONFIGURABLE_KEY_RTC_VIDEO_ENABLED_HW_ENCODER KEY_RTC_VIDEO_ENABLED_HW_ENCODER
181 #define CONFIGURABLE_KEY_RTC_VIDEO_ENABLE_HW_DECODER KEY_RTC_VIDEO_ENABLED_HW_DECODER
182 #define INTERNAL_KEY_RTC_ENABLE_DEBUG_LOG "rtc.enable_debug_log"
183 #define CONFIGURABLE_VIDEO_QUICK_INTRA_HIGH_FEC "rtc.video.quickIntraHighFec"
184 #define CONFIGURABLE_ENABLE_NEW_RTO "rtc.enable_new_rto"
185 #define CONFIGURABLE_QUICK_REXFER_KEYFRAME "rtc.enable_quick_rexfer_keyframe"
186 #define CONFIGURABLE_KEY_RTC_P2P_SWITCH "rtc.enable_p2p"
187 #define INTERNAL_KEY_RTC_ENABLE_TWO_BYTE_RTP_EXTENSION "rtc.enable_two_byte_rtp_extension"
188 #define CONFIGURABLE_KEY_RTC_ENABLE_DUMP "rtc.enable_xdump"
189 #define CONFIGURABLE_KEY_RTC_ENABLE_DUMP_FILE "rtc.enable_xdump_file"
190 #define CONFIGURABLE_KEY_RTC_ENABLE_DUMP_UPLOAD "rtc.enable_xdump_upload"
191 #define INTERNAL_KEY_RTC_CRASH_FOR_TEST_PURPOSE "rtc.crash_for_test_purpose"
192 #define CONFIGURABLE_KEY_BITRATE_ADJUST_RATIO KEY_RTC_VIDEO_BITRATE_ADJUST_RATIO
193 #define CONFIGURABLE_KEY_MINBITRATE_RATIO KEY_RTC_VIDEO_MINBITRATE_RATIO
194 #define CONFIGURABLE_KEY_RTC_ENABLE_CAMERA_CAPTURE_YUV "rtc.enable_camera_capture_yuv"
195 #define CONFIGURABLE_KEY_CAMERA_OUTPUT_TYPE "che.video.android_camera_output_type"
196 #define CONFIGURABLE_KEY_RTC_CAMERA_ROTATION "rtc.camera_rotation"
197 #define CONFIGURABLE_KEY_RTC_SECONDARY_CAMERA_ROTATION "rtc.secondary_camera_rotation"
198 #define CONFIGURABLE_KEY_ENABLE_WEBRTC_PACER "rtc.enable_webrtc_pacer"
199 #define INTERNAL_KEY_RTC_GATEWAY_RTT "rtc.gateway_rtt"
200 #define INTERNAL_KEY_RTC_ENABLE_USERINFO_HIDDEN "rtc.enable_userinfo_hidden"
201 #define CONFIGURABLE_KEY_VIDEO_DEGRADATION_PREFERENCE KEY_RTC_VIDEO_DEGRADATION_PREFERENCE
202 #define CONFIGURABLE_KEY_VIDEO_DEGRADATION_FPS_DOWN_STEP KEY_RTC_VIDEO_DEGRADATION_FPS_DOWN_STEP
203 #define CONFIGURABLE_KEY_VIDEO_DEGRADATION_FPS_UP_STEP KEY_RTC_VIDEO_DEGRADATION_FPS_UP_STEP
204 #define CONFIGURABLE_KEY_RTC_VIDEO_CODEC_TYPE KEY_RTC_VIDEO_CODEC_TYPE
205 #define CONFIGURABLE_KEY_VIDEO_VQC_VERSION "rtc.video.vqc_version"
206 //TODO(kefan) these vqc parameters should placed in MediaEngineParameterCollection
207 #define CONFIGURABLE_KEY_VIDEO_VQC_QUICK_ADAPT_NETWORK "che.video.quick_adapt_network"
208 #define CONFIGURABLE_KEY_VIDEO_VQC_MIN_HOLDTIME_AUTO_RESIZE_ZOOMIN "che.video.min_holdtime_auto_resize_zoomin"
209 #define CONFIGURABLE_KEY_VIDEO_VQC_MIN_HOLDTIME_AUTO_RESIZE_ZOOMOUT "che.video.min_holdtime_auto_resize_zoomout"
210 #define CONFIGURABLE_KEY_VIDEO_VQC_MIN_FRAMERATE "che.video.video_min_framerate"
211 #define CONFIGURABLE_KEY_VIDEO_VQC_QP_ADJUST "che.video.qpAdjust"
212 #define CONFIGURABLE_KEY_VIDEO_VQC_IOS_H265_QPADJUST "che.video.ios_h265_qpAdjust"
213 #define CONFIGURABLE_KEY_FEC_METHOD "rtc.fec_method"
214 #define CONFIGURABLE_KEY_DM_FEC_WSIZE "rtc.dm_wsize"
215 #define CONFIGURABLE_KEY_DM_FEC_MIN_LEVEL "rtc.video.dmfec_min_level"
216 
217 #define INTERNAL_KEY_RTC_NEW_VOS "rtc.new_vos"
218 #define CONFIGURABLE_KEY_AUDIO_PROCESS_BLACK_LIST "rtc.audio.process.black_list"
219 #define INTERNAL_KEY_RTC_AUDIO_CUSTOM_BITRATE "rtc.audio.custom_bitrate"
220 #define CONFIGURABLE_KEY_VIDEO_HAS_INTRA_REQUEST "che.video.has_intra_request"
221 #define CONFIGURABLE_KEY_ENABLE_VIDEO_SENDER_FRAME_DROPPER "che.video.enable_video_sender_frame_dropper"
222 #define CONFIGURABLE_KEY_RTC_VIDEO_QUALITY_SCALE_ONLY_ON_AVERAGE_QP KEY_RTC_VIDEO_QUALITY_SCALE_ONLY_ON_AVERAGE_QP
223 #define CONFIGURABLE_KEY_RTC_VIDEO_H264_QP_THRESHOLD_LOW KEY_RTC_VIDEO_H264_QP_THRESHOLD_LOW
224 #define CONFIGURABLE_KEY_RTC_VIDEO_H264_QP_THRESHOLD_HIGH KEY_RTC_VIDEO_H264_QP_THRESHOLD_HIGH
225 #define KEY_RTC_VIDEO_RATE_CONTROL_MODE "che.video.rate_control_mode"
226 #define INTERNAL_KEY_RTC_PRIMARY_FORCED_USING_SCREEN_CAPTURE "rtc.primary_screen.forced_using_screen_capture"
227 #define INTERNAL_KEY_RTC_SECONDARY_FORCED_USING_SCREEN_CAPTURE "rtc.secondary_screen.forced_using_screen_capture"
228 #define INTERNAL_KEY_RTC_DESENSITISE_IP "rtc.desensitize.Ip"
229 #define INTERNAL_KEY_RTC_AUDIO_CUSTOM_PAYLOAD_TYPE "rtc.audio.custom_payload_type"
230 #define INTERNAL_KEY_RTC_JOIN_VOS_TIMEOUT "rtc.join_vos_timeout"
231 
232 #define CONFIGURABLE_VIDEO_FEC_PROTECTION_FACTOR "rtc.video.fec_protection_factor"
233 #define CONFIGURABLE_VIDEO_ENABLE_FEC_REXFER "rtc.enable_fec_rexfer"
234 #define CONFIGURABLE_VIDEO_FEC_PROTECTION_RATIO_LEVEL "rtc.video.fec_protection_ratio_level"
235 #define CONFIGURABLE_VIDEO_FEC_RATIO_LEVEL_RTT_THRESHOLD "rtc.video.fec_ratio_level_rtt_threshold"
236 #define CONFIGURABLE_VIDEO_ENABLE_PEC "che.video.enable_pec"
237 #define CONFIGURABLE_VIDEO_ANDROID_CAMERA_SELECT "che.video.android_camera_select"
238 #define CONFIGURABLE_VIDEO_ANDROID_YUVCONVERTER_ENABLE_PBO "rtc.video.yuvconverter_enable_pbo"
239 #define CONFIGURABLE_VIDEO_ANDROID_YUVCONVERTER_ENABLE_PERF "rtc.video.yuvconverter_enable_perf"
240 #define CONFIGURABLE_VIDEO_FREEZE_DIAGNOSE "rtc.video.freeze_diagnose"
241 #define INTERNAL_KEY_AUDIO_AQM_THRESHOLD "che.audio.aqm.threshold"
242 #define CONFIGURABLE_VIDEO_ANDROID_CAMERA_PQ_FIRST "che.video.android_camera_PQ_First"
243 
244 #define CONFIGURABLE_KEY_VIDEO_H264_HW_MIN_RES_LEVEL "rtc.video.h264_hw_min_res_level"
245 #define CONFIGURABLE_KEY_VIDEO_ENC_MAX_SLICES "rtc.video.max_slices"
246 #define CONFIGURABLE_KEY_VIDEO_H264_PROFILE "rtc.video.h264_profile"
247 
248 #define CONFIGURABLE_KEY_RTC_NEW_VOS INTERNAL_KEY_RTC_NEW_VOS
249 
250 #define CONFIGURABLE_KEY_RTC_PREFER_IPV6 "rtc.prefer_ipv6"
251 #define CONFIGURABLE_KEY_RTC_DISABLE_IPV6 "rtc.disable_ipv6"
252 
253 namespace agora {
254 namespace config {
255 
256 struct AnyValue {
257  enum Type {
258  UNSPEC = -1,
259  INTEGER = 0,
260  UNSIGNED_INTEGER = 1,
261  BOOLEAN = 2,
262  DOUBLE = 3,
263  CSTR = 4,
264  JSON = 5,
265  } type;
266  union {
267  int val_int;
268  unsigned int val_uint;
269  bool val_bool;
270  double val_double;
271  const char* val_cstr;
272  const void* val_cjson;
273  };
274 };
275 
276 template <class T>
278  static const config::AnyValue::Type AnyValueType = config::AnyValue::UNSPEC;
279 };
280 template <>
282  static const config::AnyValue::Type AnyValueType = config::AnyValue::INTEGER;
283  static int getValue(const AnyValue& value) { return value.val_int; }
284  static void setValue(int from, AnyValue& to) {
285  to.type = AnyValueType;
286  to.val_int = from;
287  }
288 };
289 template <>
290 struct ExternalParameterHelperTypeTraits<unsigned int> {
291  static const config::AnyValue::Type AnyValueType =
292  config::AnyValue::UNSIGNED_INTEGER;
293  static unsigned int getValue(const AnyValue& value) { return value.val_uint; }
294  static void setValue(unsigned int from, AnyValue& to) {
295  to.type = AnyValueType;
296  to.val_uint = from;
297  }
298 };
299 template <>
301  static const config::AnyValue::Type AnyValueType =
302  config::AnyValue::UNSIGNED_INTEGER;
303  static uint16_t getValue(const AnyValue& value) { return value.val_uint; }
304  static void setValue(uint16_t from, AnyValue& to) {
305  to.type = AnyValueType;
306  to.val_uint = from;
307  }
308 };
309 template <>
311  static const config::AnyValue::Type AnyValueType = config::AnyValue::DOUBLE;
312  static double getValue(const AnyValue& value) { return value.val_double; }
313  static void setValue(double from, AnyValue& to) {
314  to.type = AnyValueType;
315  to.val_double = from;
316  }
317 };
318 template <>
320  static const config::AnyValue::Type AnyValueType = config::AnyValue::BOOLEAN;
321  static bool getValue(const AnyValue& value) { return value.val_bool; }
322  static void setValue(bool from, AnyValue& to) {
323  to.type = AnyValueType;
324  to.val_bool = from;
325  }
326 };
327 template <>
329  static const config::AnyValue::Type AnyValueType = config::AnyValue::CSTR;
330  static std::string getValue(const AnyValue& value) { return value.val_cstr; }
331  static void setValue(const std::string& from, AnyValue& to) {
332  to.type = AnyValueType;
333  to.val_cstr = from.c_str();
334  }
335 };
336 template <>
338  static const config::AnyValue::Type AnyValueType = config::AnyValue::CSTR;
339  static const char* getValue(const AnyValue& value) { return value.val_cstr; }
340  static void setValue(const char* from, AnyValue& to) {
341  to.type = AnyValueType;
342  to.val_cstr = from;
343  }
344 };
345 
346 template <>
348  static const config::AnyValue::Type AnyValueType = config::AnyValue::JSON;
349  static const void* getValue(const AnyValue& value) { return value.val_cjson; }
350  static void setValue(const void* from, AnyValue& to) {
351  to.type = AnyValueType;
352  to.val_cjson = from;
353  }
354 };
355 
357  public:
358  virtual bool toUserId(unsigned int uid, std::string& userId) const = 0;
359  virtual bool toInternalUid(const char* userId, unsigned int& uid) const = 0;
360  virtual bool hasUser(unsigned int uid) const = 0;
361  virtual bool hasUser(const char* userId) const = 0;
362  virtual ~IUserIdManager() {}
363 };
364 
365 class IObserver {
366  public:
367  virtual bool onSetValue(const AnyValue& value) = 0;
368  virtual bool onGetValue(AnyValue& value) { return false; }
369  virtual ~IObserver() {}
370 };
371 class IFilter {
372  public:
373  virtual bool onSetValue(const AnyValue& value) = 0;
374  virtual bool onGetValue(AnyValue& value) { return false; }
375  virtual ~IFilter() {}
376 };
377 
378 class IParameter {
379  public:
380  virtual void release() = 0;
381  virtual bool getValue(AnyValue& value) const = 0;
382  virtual bool setValue(
383  const AnyValue& value,
384  bool storeOnly) = 0; // specify storeOnly to true to
385  // skip trigger observer and filter
386  virtual bool getOriginalValue(AnyValue& value) const = 0;
387  virtual bool setOriginalValue(const AnyValue& value) = 0;
388  virtual bool connectExternalObserver(IObserver* observer,
389  bool triggerOnConnect) = 0;
390  virtual bool disconnectExternalObserver() = 0;
391  virtual bool connectExternalFilter(IFilter* filter,
392  bool triggerOnConnect) = 0;
393  virtual bool disconnectExternalFilter() = 0;
394  virtual ~IParameter() {}
395 };
396 
398  public:
399  virtual void release() = 0;
400  virtual ~IParameterCollection() {}
401 };
402 
404  public:
405  enum PARAMETER_TYPE {
406  VALUE_ONLY = 0,
407  HAS_EXTERNAL_FILTER = 1,
408  HAS_EXTERNAL_OBSERVER = 2,
409  HAS_EXTERNAL_TRIGGER = 3,
410  HAS_ORIGINAL_VALUE = 4,
411  };
412  virtual IParameter* createParameter(const char* key, AnyValue::Type valueType,
413  PARAMETER_TYPE paramType) = 0;
414  virtual IParameter* getParameter(const char* key) = 0;
415  virtual int setParameters(const char* parameters) = 0;
416  virtual ~IConfigEngine() {}
417 };
418 
419 template <class T>
421  public:
422  InternalParameterHelper(const T& defValue) : value_(defValue) {}
423  const T& value() const { return value_; }
424  bool setValue(const T& value) {
425  value_ = value;
426  return true;
427  }
428 
429  protected:
430  T value_;
431 };
432 
434  public:
435  /*ExternalTriggerParameterHelper(IConfigEngine& engine, const char* key)
436  :parameter_(engine.getParameter(key))
437  {
438  }*/
439  ExternalTriggerParameterHelper(IConfigEngine& engine, const char* key,
440  AnyValue::Type valueType,
441  IConfigEngine::PARAMETER_TYPE paramType)
442  : parameter_(engine.createParameter(key, valueType, paramType)) {}
444  if (parameter_) parameter_->release();
445  }
446  operator bool() { return parameter_ != nullptr; }
447 
448  protected:
449  IParameter* parameter_;
450 };
451 
452 template <class T>
454  public:
456  IConfigEngine& engine, const char* key, const T& defValue,
457  AnyValue::Type valueType =
459  IConfigEngine::PARAMETER_TYPE paramType = IConfigEngine::VALUE_ONLY)
460  : ExternalTriggerParameterHelper(engine, key, valueType, paramType) {
461  setValue(defValue, true);
462  }
463  T value() const {
464  AnyValue val;
465  if (parameter_ && parameter_->getValue(val)) {
467  }
468  return T();
469  }
470  bool setValue(const AnyValue& value, bool storeValue = true) {
471  if (parameter_) {
472  return parameter_->setValue(value, storeValue);
473  }
474  return false;
475  }
476  bool setValue(T value, bool storeValue = true) {
477  AnyValue v;
479  return setValue(v, storeValue);
480  }
481 };
482 
483 template <class T>
485  : public ExternalParameterHelper<T> {
486  public:
488  IConfigEngine& engine, const char* key, const T& defValue,
489  AnyValue::Type valueType =
491  IConfigEngine::PARAMETER_TYPE paramType = IConfigEngine::VALUE_ONLY)
492  : ExternalParameterHelper<T>(engine, key, defValue, valueType,
493  paramType) {
494  setOriginalValue(defValue);
495  }
496  bool getOriginalValue(T& v) const {
497  AnyValue val;
498  if (this->parameter_ && this->parameter_->getOriginalValue(val)) {
500  return true;
501  }
502  return false;
503  }
504 
505  protected:
506  bool setOriginalValue(const T& value) {
507  if (this->parameter_) {
508  AnyValue v;
510  return this->parameter_->setOriginalValue(v);
511  }
512  return false;
513  }
514 };
515 
517  public:
518  virtual ~ExternalParameterHasSlots() { disconnectAll(); }
519  void disconnectAll() {
520  for (auto& param : parameters_) {
521  param->disconnectExternalObserver();
522  param->disconnectExternalFilter();
523  }
524  parameters_.clear();
525  }
526  void addParameter(IParameter* param) {
527  if (param) parameters_.insert(param);
528  }
529 
530  private:
531  std::unordered_set<IParameter*> parameters_;
532 };
533 
534 template <class T>
536  public IObserver {
537  typedef std::function<int(const T&)> setter_type;
538  typedef std::function<int(T&)> getter_type;
539 
540  public:
542  IConfigEngine& engine, const char* key, const T& defValue,
543  AnyValue::Type valueType =
545  : ExternalParameterHelper<T>(engine, key, defValue, valueType,
546  IConfigEngine::HAS_EXTERNAL_OBSERVER) {}
547  bool connect(ExternalParameterHasSlots* om, setter_type&& setter,
548  getter_type&& getter = nullptr, bool triggerOnConnect = false) {
549  if (this->parameter_) {
550  this->setter_ = std::move(setter);
551  this->getter_ = std::move(getter);
552  if (om) om->addParameter(this->parameter_);
553  return this->parameter_->connectExternalObserver(this, triggerOnConnect);
554  }
555  return false;
556  }
557  virtual bool onSetValue(const AnyValue& value) override {
558  if (this->setter_) {
559  return this->setter_(
561  }
562  return false;
563  }
564  virtual bool onGetValue(AnyValue& value) override {
565  if (this->getter_) {
566  T tmp;
567  if (this->getter_(tmp) == 0) {
569  return true;
570  }
571  }
572  return false;
573  }
574 
575  private:
576  setter_type setter_;
577  getter_type getter_;
578 };
579 
580 template <class T>
582  public IFilter {
583  typedef std::function<int(const T&)> setter_type;
584  typedef std::function<int(T&)> getter_type;
585 
586  public:
588  IConfigEngine& engine, const char* key, const T& defValue,
589  AnyValue::Type valueType =
591  : ExternalParameterHelper<T>(engine, key, defValue, valueType,
592  IConfigEngine::HAS_EXTERNAL_FILTER) {}
593  bool connect(ExternalParameterHasSlots* om, setter_type&& setter,
594  getter_type&& getter = nullptr, bool triggerOnConnect = false) {
595  if (this->parameter_) {
596  this->setter_ = std::move(setter);
597  this->getter_ = std::move(getter);
598  if (om) om->addParameter(this->parameter_);
599  return this->parameter_->connectExternalFilter(this, triggerOnConnect);
600  }
601  return false;
602  }
603  virtual bool onSetValue(const AnyValue& value) override {
604  return this->setter_ &&
605  this->setter_(
607  }
608  virtual bool onGetValue(AnyValue& value) override {
609  if (this->getter_) {
610  T tmp;
611  if (this->getter_(tmp) == 0) {
613  return true;
614  }
615  }
616  return false;
617  }
618 
619  private:
620  setter_type setter_;
621  getter_type getter_;
622 };
623 
624 template <class T>
627  public IObserver {
628  typedef std::function<int(const T&)> setter_type;
629  typedef std::function<int(T&)> getter_type;
630 
631  public:
633  IConfigEngine& engine, const char* key,
634  AnyValue::Type valueType =
636  : ExternalTriggerParameterHelper(engine, key, valueType,
637  IConfigEngine::HAS_EXTERNAL_TRIGGER) {}
638  bool connect(ExternalParameterHasSlots* om, setter_type&& setter,
639  getter_type&& getter = nullptr, bool triggerOnConnect = false) {
640  if (this->parameter_) {
641  this->setter_ = std::move(setter);
642  this->getter_ = std::move(getter);
643  if (om) om->addParameter(this->parameter_);
644  return this->parameter_->connectExternalObserver(this, triggerOnConnect);
645  }
646  return false;
647  }
648  virtual bool onSetValue(const AnyValue& value) override {
649  if (this->setter_) {
650  return this->setter_(
652  }
653  return false;
654  }
655  virtual bool onGetValue(AnyValue& value) override {
656  if (this->getter_) {
657  T tmp;
658  if (this->getter_(tmp) == 0) {
660  return true;
661  }
662  }
663  return false;
664  }
665 
666  private:
667  setter_type setter_;
668  getter_type getter_;
669 };
670 
671 enum CONFIG_POLICY_TYPE{
672  CONFIG_POLICY_CDS = 0x1,
673  CONFIG_POLICY_TDS = 0x2,
674  CONFIG_POLICY_ALL = CONFIG_POLICY_CDS|CONFIG_POLICY_TDS
675 };
676 
677 } // namespace config
678 } // namespace agora
agora::config::ExternalTriggerParameterHelperWithObserver
Definition: config_engine_i.h:627
agora::config::ExternalTriggerParameterHelper
Definition: config_engine_i.h:433
agora::config::ExternalParameterHelperWithObserver
Definition: config_engine_i.h:536
agora::config::IObserver
Definition: config_engine_i.h:365
agora::config::IConfigEngine
Definition: config_engine_i.h:403
agora::config::IParameter
Definition: config_engine_i.h:378
agora::config::IFilter
Definition: config_engine_i.h:371
agora::config::ExternalParameterHelperTypeTraits
Definition: config_engine_i.h:277
agora::config::InternalParameterHelper
Definition: config_engine_i.h:420
agora::config::IParameterCollection
Definition: config_engine_i.h:397
agora::config::ExternalParameterHelperWithFilter
Definition: config_engine_i.h:582
agora::config::ExternalParameterHasSlots
Definition: config_engine_i.h:516
agora::config::IUserIdManager
Definition: config_engine_i.h:356
agora::config::ExternalParameterHelperWithOriginalValue
Definition: config_engine_i.h:485
agora::config::ExternalParameterHelper
Definition: config_engine_i.h:453
agora::config::AnyValue
Definition: config_engine_i.h:256