Agora C++ API Reference for All Platforms
|
13 #include "AgoraBase.h"
14 #include "AgoraOptional.h"
16 #if defined(WEBRTC_WIN)
17 #define NEW_LINE "\r\n"
31 #define SET_FROM(X) SetFrom(&X, change.X)
46 SET_FROM(number_of_bframe_temporal_layers);
73 SET_FROM(frame_max_size);
246 #define BEGIN_COMPARE() bool b = true
247 #define ADD_COMPARE(X) b = (b && (X == o.X))
248 #define END_COMPARE()
262 ADD_COMPARE(number_of_bframe_temporal_layers);
289 ADD_COMPARE(frame_max_size);
467 #define ADD_STRING(X) ost << ToStringIfSet(#X, X)
469 std::ostringstream ost;
483 ADD_STRING(number_of_bframe_temporal_layers);
510 ADD_STRING(frame_max_size);
682 std::string ret = ost.str();
683 auto index = ret.rfind(
",");
684 if (index != ret.npos) {
685 ret = ret.substr(0, index);
689 return "{" NEW_LINE + ret +
"}";
958 std::string ToStringIfSet(
const char* key,
const Optional<T>& val)
const {
962 str =
"\t\"" + str +
"\"";
964 str += std::to_string(*val);
975 str =
"\t\"" + str +
"\"";
984 std::string ToStringIfSet(
const char* key,
const Optional<bool>& val)
const {
988 str =
"\t\"" + str +
"\"";
990 str += *val ?
"true" :
"false";
997 template <
typename T>
998 static void SetFrom(Optional<T>* s,
const Optional<T>& o) {
Optional< bool > av1_feedback_enable
Definition: video_config_i.h:740
Optional< int > fps_up_step
Definition: video_config_i.h:715
VideoConfigurationEx()=default
Optional< int > h264_hw_min_res_level
Definition: video_config_i.h:822
Optional< int > sr_type
Definition: video_config_i.h:837
Optional< int32_t > intel_cpu_threshold_mhz
Definition: video_config_i.h:818
Optional< bool > enable_instant_streaming_mode
Definition: video_config_i.h:952
Optional< int > av_enc_video_max_slices
Definition: video_config_i.h:824
Optional< int > vqc_res_min_width
Definition: video_config_i.h:727
Optional< bool > enable_background_hw_decode
Definition: video_config_i.h:788
Optional< int32_t > av_enc_hw_exceptions
Definition: video_config_i.h:894
bool operator!=(const VideoConfigurationEx &o) const
Definition: video_config_i.h:464
Optional< bool > video_force_texture_to_i420
Definition: video_config_i.h:861
Optional< int > av_enc_alpha_data_codec_type
Definition: video_config_i.h:925
Optional< std::string > pps_data
Definition: video_config_i.h:706
Optional< int > av_sw_enc_dump_frame_info
Definition: video_config_i.h:830
Optional< bool > adaptive_op_mode
Definition: video_config_i.h:708
Optional< bool > enable_pvc_verify
Definition: video_config_i.h:833
Optional< int32_t > video_vpr_adaptive_thres
Definition: video_config_i.h:845
Optional< std::string > bitrate_adjust_ratio
Definition: video_config_i.h:769
Optional< int > fps_down_step
Definition: video_config_i.h:714
Optional< int32_t > video_render_buffer_queue_size
Definition: video_config_i.h:859
Optional< bool > enable_minor_stream_codec_follow_major_stream
Definition: video_config_i.h:951
Optional< int > quick_response_intra_request
Definition: video_config_i.h:732
Optional< int > vqc_version
Definition: video_config_i.h:716
Optional< bool > av_enc_send_sei_alpha
Definition: video_config_i.h:924
Optional< bool > scc_auto_framerate
Definition: video_config_i.h:855
Optional< std::string > simulcast_stream_bitrate_string
Definition: video_config_i.h:947
Optional< int > direct_cdn_streaming_h264_profile
Definition: video_config_i.h:922
Optional< bool > force_hw_encoder
Definition: video_config_i.h:795
Optional< bool > av_dec_texture_copy_enable
Definition: video_config_i.h:899
Optional< int > min_bitrate
Definition: video_config_i.h:699
Optional< int > video_encoder_rc_scene
Definition: video_config_i.h:827
Optional< bool > wz265_dec_enable
Definition: video_config_i.h:757
Optional< bool > initial_hw_encoder_quickly_start
Definition: video_config_i.h:934
Optional< bool > video_android_capturer_copy_enable
Definition: video_config_i.h:863
Optional< int > max_hwdec_cosessions
Definition: video_config_i.h:786
Optional< bool > frame_dropping_on
Definition: video_config_i.h:762
Optional< bool > av_enc_new_complexity
Definition: video_config_i.h:919
Optional< int > orientation_mode
Definition: video_config_i.h:702
Optional< int > h264_profile
Definition: video_config_i.h:707
Optional< bool > av_enc_profiling
Definition: video_config_i.h:878
Optional< bool > vp8_enc_switch
Definition: video_config_i.h:747
Optional< bool > enable_video_qoe_assess
Definition: video_config_i.h:820
Optional< bool > h265_dec_enable
Definition: video_config_i.h:736
Optional< bool > av_dec_google_dav1d_enable
Definition: video_config_i.h:903
Optional< int32_t > av_enc_intra_key_interval
Definition: video_config_i.h:849
Optional< int > major_stream_encoder_thread_num
Definition: video_config_i.h:742
Optional< int > posted_frames_waiting_for_encode
Definition: video_config_i.h:768
Optional< bool > av_enc_google_enable
Definition: video_config_i.h:901
Optional< int > vqc_min_framerate
Definition: video_config_i.h:721
Definition: AgoraAtomicOps.h:21
Optional< bool > enc_scc_enable
Definition: video_config_i.h:745
Optional< int32_t > av_enc_video_width_alignment
Definition: video_config_i.h:887
Optional< int > vqc_res_min_height
Definition: video_config_i.h:728
Optional< int > key_frame_interval
Definition: video_config_i.h:764
Optional< bool > scc_quality_opt
Definition: video_config_i.h:856
bool operator==(const VideoConfigurationEx &o) const
Definition: video_config_i.h:245
Optional< std::string > bitrate_ceiling_ratio
Definition: video_config_i.h:932
Optional< bool > denoising_on
Definition: video_config_i.h:760
Optional< std::string > av_hw_dec_skip_by_name
Definition: video_config_i.h:891
Optional< std::string > av_enc_param_config
Definition: video_config_i.h:880
Optional< int32_t > video_vpr_max_size
Definition: video_config_i.h:841
Optional< bool > default_enable_hw_encoder
Definition: video_config_i.h:938
Optional< int > roi_max_qp
Definition: video_config_i.h:869
Optional< bool > enable_video_vpr
Definition: video_config_i.h:839
Optional< int32_t > video_vpr_frozen_ms_thres
Definition: video_config_i.h:842
Optional< int > start_bitrate
Definition: video_config_i.h:697
Optional< int > matrixCoefficients
Definition: video_config_i.h:909
Optional< int32_t > av_enc_screen_sharing_subclass
Definition: video_config_i.h:886
Optional< int > decoder_thread_num
Definition: video_config_i.h:791
~VideoConfigurationEx()=default
Optional< int32_t > video_vpr_method
Definition: video_config_i.h:844
Optional< int > key_frame_interval_intra_request
Definition: video_config_i.h:915
Optional< bool > av_enc_encode_alpha
Definition: video_config_i.h:927
Optional< bool > enable_iptos
Definition: video_config_i.h:910
Optional< int > vqc_ios_h265_adjust
Definition: video_config_i.h:726
Optional< int > h264_qp_thresholds_high
Definition: video_config_i.h:776
Optional< std::string > hw_decoder_provider
Definition: video_config_i.h:790
Optional< bool > enable_hw_encoder_quickly_start
Definition: video_config_i.h:933
void SetAll(const VideoConfigurationEx &change)
Definition: video_config_i.h:30
std::string ToString() const
Definition: video_config_i.h:466
Optional< int32_t > video_vpr_frozen_rate_thres
Definition: video_config_i.h:843
Optional< int > complexity
Definition: video_config_i.h:759
Optional< bool > save_encode_bitrate_minor_stream
Definition: video_config_i.h:913
Optional< bool > use_single_slice_parser
Definition: video_config_i.h:906
Optional< uint8_t > simulcast_stream_number_of_temporal_layers
Definition: video_config_i.h:946
Optional< int > vqc_min_holdtime_auto_resize_zoomout
Definition: video_config_i.h:724
Optional< int > overuse_detector_version
Definition: video_config_i.h:718
Optional< int > frame_glitching_detect_level
Definition: video_config_i.h:940
Optional< int > codec_type
Definition: video_config_i.h:692
Optional< bool > video_render_d3d9_texture
Definition: video_config_i.h:857
Optional< int > h264_qp_thresholds_low
Definition: video_config_i.h:775
Optional< int32_t > nvdia_cpu_threshold_mhz
Definition: video_config_i.h:817
Optional< bool > av_enc_video_enable_dequeue_timewait
Definition: video_config_i.h:897
Optional< bool > enable_bframe
Definition: video_config_i.h:929
Optional< bool > vdm_not_override_lua_smallvideo_not_use_hwenc_policy
Definition: video_config_i.h:819
Optional< uint8_t > number_of_temporal_layers
Definition: video_config_i.h:703
Optional< uint32_t > av_enc_codec_type
Definition: video_config_i.h:799
Optional< int > av_dec_output_byte_frame_resolution_product_thres
Definition: video_config_i.h:904
Optional< bool > save_encode_bitrate
Definition: video_config_i.h:912
Optional< int32_t > max_all_intra_encode_time
Definition: video_config_i.h:954
Optional< int > actual_max_bitrate
Definition: video_config_i.h:701
Optional< bool > retrans_detect_enable
Definition: video_config_i.h:846
Optional< int > degradation_preference
Definition: video_config_i.h:713
Optional< int > video_rotation
Definition: video_config_i.h:852
Optional< int > sr_verify_type
Definition: video_config_i.h:835
Optional< int > fec_method
Definition: video_config_i.h:733
Optional< bool > video_enable_high_definition_strategy
Definition: video_config_i.h:865
Optional< bool > video_render_vsync_switch
Definition: video_config_i.h:860
Optional< int > scale_type
Definition: video_config_i.h:853
Optional< int32_t > av_dec_sw_a264_enable
Definition: video_config_i.h:895
Optional< bool > has_intra_request
Definition: video_config_i.h:763
Optional< bool > av_dec_output_byte_frame
Definition: video_config_i.h:900
Optional< int > fec_fix_rate
Definition: video_config_i.h:734
Optional< int > min_encode_keyframe_interval
Definition: video_config_i.h:917
Optional< bool > default_enable_hwenc_win32
Definition: video_config_i.h:752
Optional< int > video_enc_min_scc_auto_framerate
Definition: video_config_i.h:876
Optional< bool > enable_bframe_h265
Definition: video_config_i.h:931
Optional< std::string > minbitrate_ratio
Definition: video_config_i.h:770
Optional< int > loop_filter_disable_idc
Definition: video_config_i.h:766
Optional< std::string > av_enc_video_hwenc_config
Definition: video_config_i.h:889
Optional< int > video_switch_soft_decoder_threshold
Definition: video_config_i.h:916
Optional< float > major_minor_stream_resolution_ratio
Definition: video_config_i.h:949
Definition: video_config_i.h:25
Optional< int > target_bitrate
Definition: video_config_i.h:698
Optional< uint8_t > number_of_spatial_layers
Definition: video_config_i.h:709
Optional< int > use_keyframe_type_from_parser
Definition: video_config_i.h:939
Optional< int32_t > av_dec_hw_hevc_exceptions
Definition: video_config_i.h:893
Optional< bool > enable_change_encoder_profile
Definition: video_config_i.h:755
Optional< int32_t > key_force_device_score
Definition: video_config_i.h:850
Optional< std::string > sps_data
Definition: video_config_i.h:705
Optional< int > reset_framerate_ratio
Definition: video_config_i.h:779
Optional< std::string > av_dec_video_hwdec_config
Definition: video_config_i.h:890
Optional< int > h265_screen_enable
Definition: video_config_i.h:693
Optional< bool > av_enc_vmaf_calc
Definition: video_config_i.h:874
Optional< int > av_enc_video_qp_parser_skip
Definition: video_config_i.h:872
Optional< int32_t > av_enc_bitrate_adjustment_type
Definition: video_config_i.h:851
Optional< bool > color_space_enable
Definition: video_config_i.h:907
Optional< bool > enable_follow_major_stream
Definition: video_config_i.h:948
Optional< bool > av_enc_video_enable_roi
Definition: video_config_i.h:868
Optional< int > av_enc_alpha_data_scale_mode
Definition: video_config_i.h:926
Optional< int > dec_mosreport
Definition: video_config_i.h:782
Optional< int > pvc_max_support_resolution
Definition: video_config_i.h:832
Optional< bool > background_detection_on
Definition: video_config_i.h:767
Optional< int32_t > video_vpr_init_size
Definition: video_config_i.h:840
Optional< bool > video_windows_capture_to_texture
Definition: video_config_i.h:862
Optional< int > minor_stream_encoder_thread_num
Definition: video_config_i.h:743
Optional< bool > enable_fast_first_remote_draw
Definition: video_config_i.h:953
Optional< int > minscore_for_swh265enc
Definition: video_config_i.h:751
Optional< std::string > hwenc_blacklist
Definition: video_config_i.h:753
Optional< int32_t > av_enc_hw_hevc_exceptions
Definition: video_config_i.h:892
Optional< int > frame_width
Definition: video_config_i.h:694
Optional< bool > av_enc_video_use_a264
Definition: video_config_i.h:867
Optional< int > max_bitrate
Definition: video_config_i.h:700
Optional< bool > enable_video_sender_frame_dropper
Definition: video_config_i.h:814
Optional< bool > flexible_mode
Definition: video_config_i.h:710
Optional< int > fps_est_window_size_ms
Definition: video_config_i.h:937
Optional< bool > enable_performance_gating
Definition: video_config_i.h:950
Optional< bool > enable_sr
Definition: video_config_i.h:836
Optional< int > av_enc_default_complexity
Definition: video_config_i.h:920
Optional< uint32_t > hw_encoder_provider
Definition: video_config_i.h:797
Optional< int > vqc_force_use_version
Definition: video_config_i.h:717
Optional< int > num_of_encoder_cores
Definition: video_config_i.h:712
Optional< bool > vqc_quick_adaptNetwork
Definition: video_config_i.h:720
Optional< std::string > hwdec_blacklist
Definition: video_config_i.h:754
Optional< int > vqc_min_holdtime_auto_resize_zoomin
Definition: video_config_i.h:723
Optional< std::string > video_resolution_auto_adjust_param
Definition: video_config_i.h:882
Optional< int32_t > av_enc_video_height_alignment
Definition: video_config_i.h:888
Optional< bool > enable_parser_reject
Definition: video_config_i.h:921
Optional< int > fake_enc_error_code
Definition: video_config_i.h:935
Optional< int > reset_bitrate_ratio
Definition: video_config_i.h:778
Optional< bool > av_enc_video_force_alignment
Definition: video_config_i.h:896
Optional< bool > video_skip_enable
Definition: video_config_i.h:918
Optional< int > vqc_qp_adjust
Definition: video_config_i.h:725
Optional< bool > quality_scale_only_on_average_qp
Definition: video_config_i.h:774
Optional< std::string > vqc_settings_by_resolution
Definition: video_config_i.h:722
Optional< bool > enable_hw_decoder
Definition: video_config_i.h:785
Optional< int > bFrames
Definition: video_config_i.h:930
Optional< bool > enable_nvdia_first
Definition: video_config_i.h:816
Optional< bool > av_enc_video_adjustment_reset
Definition: video_config_i.h:898
Optional< bool > use_sent_ts_enable
Definition: video_config_i.h:847
Optional< bool > enable_smooth_enc_codec_change
Definition: video_config_i.h:936
Optional< int > frame_rate
Definition: video_config_i.h:696
Optional< int > roi_qp_offset
Definition: video_config_i.h:870
Optional< uint32_t > av_enc_common_rate_control_mode
Definition: video_config_i.h:812
Optional< bool > av1_screen_enable
Definition: video_config_i.h:741
Optional< int > min_enc_level
Definition: video_config_i.h:749
Optional< int > video_encoder_rc_limit_value
Definition: video_config_i.h:826
Optional< int > frame_height
Definition: video_config_i.h:695
Optional< std::string > save_encode_bitrate_params
Definition: video_config_i.h:914
Optional< uint32_t > av_enc_common_quality
Definition: video_config_i.h:803
Optional< int > videoFullrange
Definition: video_config_i.h:908
Optional< bool > av_dec_google_enable
Definition: video_config_i.h:902
Optional< int > entropy_coding_mode_flag
Definition: video_config_i.h:765
Optional< bool > enable_minor_stream_intra_request
Definition: video_config_i.h:943
Optional< bool > av1_camera_enable
Definition: video_config_i.h:739
Optional< bool > enable_sr_verify
Definition: video_config_i.h:834
Optional< bool > enable_hw_encoder
Definition: video_config_i.h:794
Definition: video_node_i.h:28
Optional< int32_t > video_render_d3d9_render_mode
Definition: video_config_i.h:858
Optional< int > video_encoder_impair_net_ref_opt
Definition: video_config_i.h:828
Optional< int > interlayer_pred
Definition: video_config_i.h:711
Optional< bool > low_stream_enable_hw_encoder
Definition: video_config_i.h:945
Optional< bool > av1_dec_enable
Definition: video_config_i.h:738
Optional< bool > automatic_resize_on
Definition: video_config_i.h:761
Optional< bool > enable_pvc
Definition: video_config_i.h:831
Optional< std::string > av_enc_advanced_param_config
Definition: video_config_i.h:884
Optional< int > video_clarity_analysis_flag
Definition: video_config_i.h:873