Agora Java API Reference for Android
IAgoraParameter.h
1 //
2 // Agora Engine SDK
3 //
4 // Created by minbo in 2019-10.
5 // Copyright (c) 2019 Agora.io. All rights reserved.
6 
7 /*
8  * Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
9  *
10  * Use of this source code is governed by a BSD-style license
11  * that can be found in the LICENSE file in the root of the source
12  * tree. An additional intellectual property rights grant can be found
13  * in the file PATENTS. All contributing project authors may
14  * be found in the AUTHORS file in the root of the source tree.
15  */
16 
17 #pragma once // NOLINT(build/header_guard)
18 
19 // external key
24 #define KEY_RTC_UDP_PORT_RANGE "rtc.udp_port_range"
25 
29 #define KEY_RTC_UDP_PORT_LIST "rtc.udp_port_list"
30 
35 #define KEY_RTC_UDP_SEND_FD "rtc.udp_send_fd"
36 
40 #define KEY_RTC_VIDEO_ENABLED_HW_ENCODER "engine.video.enable_hw_encoder"
41 
45 #define KEY_RTC_VIDEO_HW_ENCODER_PROVIDER "engine.video.hw_encoder_provider"
46 
50 #define KEY_RTC_VIDEO_ENABLED_HW_DECODER "engine.video.enable_hw_decoder"
51 
55 #define KEY_RTC_VIDEO_HW_DECODER_PROVIDER "engine.video.hw_decoder_provider"
56 
60 #define KEY_RTC_VIDEO_OVERRIDE_SMALLVIDEO_NOT_USE_HWENC_POLICY "engine.video.override_smallvideo_not_use_hwenc_policy"
61 
65 #define KEY_RTC_VIDEO_RESEND "rtc.video_resend"
66 
70 #define KEY_RTC_AUDIO_RESEND "rtc.audio_resend"
71 
75 #define KEY_RTC_AUDIO_ENABLE_AGORA_AEC "rtc.audio.aec.enable"
76 
80 #define KEY_RTC_AUDIO_AEC_AGGRESSIVENESS "rtc.audio.aec.aggressiveness"
81 
82 #define KEY_RTC_AUDIO_MAX_TARGET_DELAY "rtc.audio.max_target_delay"
83 
87 #define KEY_RTC_AUDIO_ENABLE_AGORA_AGC "rtc.audio.agc.enable"
88 
92 #define KEY_RTC_AUDIO_ENABLE_AGORA_ANS "rtc.audio.ans.enable"
93 
97 #define KEY_RTC_AUDIO_ENABLE_AGORA_MD "rtc.audio.md.enable"
98 
102 #define KEY_RTC_AUDIO_OPENSL_MODE "rtc.audio.opensl.mode"
103 
110 #define KEY_RTC_AUDIO_OBOE_ENABLE "rtc.audio.oboe.enable"
111 
116 #define KEY_RTC_AUDIO_ENABLE_HARDWARE_EAR_MONITOR "rtc.audio.enable_hardware_ear_monitor"
117 
121 #define KEY_RTC_AUDIO_INPUT_SAMPLE_RATE "rtc.audio.input_sample_rate"
122 
129 #define KEY_RTC_AUDIO_FORCE_USE_MEDIA_VOLUME "rtc.audio.force_use_media_volume"
130 
137 #define KEY_RTC_AUDIO_FORCE_BLUETOOTH_A2DP "rtc.audio.force_bluetooth_a2dp"
138 
142 #define KEY_RTC_AUDIO_KEEP_AUDIOSESSION "rtc.audio.keep.audiosession"
143 
150 #define KEY_RTC_AUDIO_USE_MEDIA_VOLUME_IN_BLUETOOTH "rtc.audio.use_media_volume_in_bluetooth"
151 
155 #define KEY_RTC_VIDEO_BITRATE_ADJUST_RATIO "rtc.video.bitrate_adjust_ratio"
156 
160 #define KEY_RTC_VIDEO_MINBITRATE_RATIO "rtc.video.minbitrate_ratio"
161 
165 #define KEY_RTC_VIDEO_DEGRADATION_PREFERENCE "rtc.video.degradation_preference"
166 
171 #define KEY_RTC_VIDEO_DEGRADATION_FPS_DOWN_STEP "rtc.video.degradation_fps_down_step"
172 
175 #define KEY_RTC_VIDEO_DEGRADATION_FPS_UP_STEP "rtc.video.degradation_fps_up_step"
176 
180 #define KEY_RTC_CONNECTION_LOST_PERIOD "rtc.connection_lost_period"
181 
185 #define KEY_RTC_LOCAL_IP "rtc.local.ip"
186 
190 #define KEY_RTC_NETWORK_INTERFACE "rtc.network.interface"
191 
195 #define KEY_RTC_VIDEO_CODEC_TYPE "engine.video.codec_type"
196 
200 #define KEY_RTC_VIDEO_QUALITY_SCALE_ONLY_ON_AVERAGE_QP "engine.video.quality_scale_only_on_average_qp"
201 
205 #define KEY_RTC_VIDEO_H264_QP_THRESHOLD_LOW "engine.video.h264_qp_thresholds_low"
206 
210 #define KEY_RTC_VIDEO_H264_QP_THRESHOLD_HIGH "engine.video.h264_qp_thresholds_high"
211 
212 
213 namespace agora {
214 
215 namespace util {
216 template <class T>
217 class CopyableAutoPtr;
218 
219 class IString;
220 typedef CopyableAutoPtr<IString> AString;
221 } // namespace util
222 
223 namespace base {
224 
226 public:
230  virtual void release() = 0;
231 
240  virtual int setBool(const char* key, bool value) = 0;
241 
250  virtual int setInt(const char* key, int value) = 0;
251 
260  virtual int setUInt(const char* key, unsigned int value) = 0;
261 
270  virtual int setNumber(const char* key, double value) = 0;
271 
280  virtual int setString(const char* key, const char* value) = 0;
281 
290  virtual int setObject(const char* key, const char* value) = 0;
291 
300  virtual int setArray(const char* key, const char* value) = 0;
309  virtual int getBool(const char* key, bool& value) = 0;
310 
319  virtual int getInt(const char* key, int& value) = 0;
320 
329  virtual int getUInt(const char* key, unsigned int& value) = 0;
330 
339  virtual int getNumber(const char* key, double& value) = 0;
340 
349  virtual int getString(const char* key, agora::util::AString& value) = 0;
350 
359  virtual int getObject(const char* key, agora::util::AString& value) = 0;
360 
369  virtual int getArray(const char* key, const char* args, agora::util::AString& value) = 0;
370 
377  virtual int setParameters(const char* parameters) = 0;
378 
379  virtual int convertPath(const char* filePath, agora::util::AString& value) = 0;
380 
381  virtual ~IAgoraParameter() {}
382 };
383 
384 } // namespace base
385 } // namespace agora
agora::base::IAgoraParameter
Definition: IAgoraParameter.h:225
agora::base::IAgoraParameter::getArray
virtual int getArray(const char *key, const char *args, agora::util::AString &value)=0
agora::base::IAgoraParameter::getNumber
virtual int getNumber(const char *key, double &value)=0
agora::base::IAgoraParameter::getUInt
virtual int getUInt(const char *key, unsigned int &value)=0
agora::base::IAgoraParameter::setBool
virtual int setBool(const char *key, bool value)=0
agora::base::IAgoraParameter::setArray
virtual int setArray(const char *key, const char *value)=0
agora::base::IAgoraParameter::getInt
virtual int getInt(const char *key, int &value)=0
agora::base::IAgoraParameter::getString
virtual int getString(const char *key, agora::util::AString &value)=0
agora::base::IAgoraParameter::setInt
virtual int setInt(const char *key, int value)=0
agora::base::IAgoraParameter::release
virtual void release()=0
agora::base::IAgoraParameter::setObject
virtual int setObject(const char *key, const char *value)=0
agora::base::IAgoraParameter::setUInt
virtual int setUInt(const char *key, unsigned int value)=0
agora::util::CopyableAutoPtr
Definition: AgoraBase.h:162
agora::base::IAgoraParameter::getBool
virtual int getBool(const char *key, bool &value)=0
agora::base::IAgoraParameter::setString
virtual int setString(const char *key, const char *value)=0
agora::base::IAgoraParameter::setParameters
virtual int setParameters(const char *parameters)=0
agora::base::IAgoraParameter::setNumber
virtual int setNumber(const char *key, double value)=0
agora::base::IAgoraParameter::getObject
virtual int getObject(const char *key, agora::util::AString &value)=0