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_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_MINOR_STREAM_CODEC_INDEX "engine.video.minor_stream_codec_index"
#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_HARDWARE_ENCODEING

#define KEY_RTC_VIDEO_HARDWARE_ENCODEING "che.hardware_encoding"

## ◆ 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_HARDWARE_DECODING

#define KEY_RTC_VIDEO_HARDWARE_DECODING "che.hardware_decoding"

## ◆ 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_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_MINOR_STREAM_CODEC_INDEX

#define KEY_RTC_VIDEO_MINOR_STREAM_CODEC_INDEX "engine.video.minor_stream_codec_index"

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

## ◆ KEY_RTC_VIDEO_CODEC_INDEX

#define KEY_RTC_VIDEO_CODEC_INDEX "che.video.videoCodecIndex"

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