NERtc Unity SDK  V4.5.907
Public Attributes | List of all members
nertc.RtcConstants Class Reference

Public Attributes

readonly string kNERtcKeyRecordHostEnabled = "record_host_enabled"
 
readonly string kNERtcKeyRecordAudioEnabled = "record_audio_enabled"
 
readonly string kNERtcKeyRecordVideoEnabled = "record_video_enabled"
 
readonly string kNERtcKeyRecordType = "record_type"
 
readonly string kNERtcKeyAutoSubscribeAudio = "auto_subscribe_audio"
 
readonly string kNERtcKeyEnableAudioASLManualSubscribe = "enable_audio_asl_manual_subscribe"
 
readonly string kNERtcKeyPublishSelfStreamEnabled = "publish_self_stream_enabled"
 
readonly string kNERtcKeyLogLevel = "log_level"
 
readonly string kNERtcKeyAudioProcessingAECEnable = "audio_processing_aec_enable"
 
readonly string kNERtcKeyAudioAECLowLevelEnable = "audio_aec_low_level_enable"
 
readonly string kNERtcKeyAudioProcessingAGCEnable = "audio_processing_agc_enable"
 
readonly string kNERtcKeyAudioProcessingNSEnable = "audio_processing_ns_enable"
 
readonly string kNERtcKeyAudioProcessingAINSEnable = "audio_processing_ai_ns_enable"
 
readonly string kNERtcKeyAudioProcessingExternalAudioMixEnable = "audio_processing_external_audiomix_enable"
 
readonly string kNERtcKeyAudioProcessingEarphone = "audio_processing_earphone"
 
readonly string kNERtcKeyVideoSendOnPubType = "video_sendonpub_type"
 
readonly string kNERtcKeyChannel1V1ModeEnabled = "channel_1v1_mode_enabled"
 
readonly string kNERtcKeyExtraInfo = "extra_info"
 
readonly string kNERtcKeyAudioDeviceAutoSelectType = "audio_device_auto_select_type"
 
readonly string kNERtcKeyEnableReportVolumeWhenMute = "enable_report_volume_when_mute"
 
readonly string kNERtcKeyEnableVideoCaptureObserver = "enable_video_capture_observer"
 
readonly string kNERtcKeyVideoPreferHWEncode = "video_prefer_hw_encode"
 
readonly string kNERtcKeyVideoPreferHWDecode = "video_prefer_hw_decode"
 
readonly string kNERtcKeyEnableDynamicToken = "enable_dynamic_token"
 
readonly string kNERtcExternalVideoDeviceID = "nertc-video-external-device"
 
readonly string kNERtcAudioDeviceAutoID = "nertc-audio-device-auto"
 

Detailed Description

Configure the SDK using a JSON file to provide technical preview or special custom functionalities. Standardize JSON options. For more information, see setParameters. *

Member Data Documentation

◆ kNERtcKeyRecordHostEnabled

readonly string nertc.RtcConstants.kNERtcKeyRecordHostEnabled = "record_host_enabled"

bool value. True: Record the presenter. False: Do not record the presenter. The setting is valid before the call.

◆ kNERtcKeyRecordAudioEnabled

readonly string nertc.RtcConstants.kNERtcKeyRecordAudioEnabled = "record_audio_enabled"

bool value, which determines whether to enable server audio recording. The default value is false. The setting is valid before the call.

◆ kNERtcKeyRecordVideoEnabled

readonly string nertc.RtcConstants.kNERtcKeyRecordVideoEnabled = "record_video_enabled"

bool value, which determines whether to enable server video recording. The default value is false. The setting is valid before the call.

◆ kNERtcKeyRecordType

readonly string nertc.RtcConstants.kNERtcKeyRecordType = "record_type"

int value, NERtcRecordType. The setting is valid before the call.

◆ kNERtcKeyAutoSubscribeAudio

readonly string nertc.RtcConstants.kNERtcKeyAutoSubscribeAudio = "auto_subscribe_audio"

bool value, which determines whether to automatically subscribe to the audio stream when other users open the audio. The default value is true. The setting is valid before the call.

◆ kNERtcKeyEnableAudioASLManualSubscribe

readonly string nertc.RtcConstants.kNERtcKeyEnableAudioASLManualSubscribe = "enable_audio_asl_manual_subscribe"

bool value, which determines whether to manually subscribe to the audio stream when other users open the audio on ASL mode. The default value is false. The setting is valid before the call.

◆ kNERtcKeyPublishSelfStreamEnabled

readonly string nertc.RtcConstants.kNERtcKeyPublishSelfStreamEnabled = "publish_self_stream_enabled"

bool value, which determines whether to enable CDN relayed streaming. The default value is true. The setting is valid before the call.

◆ kNERtcKeyLogLevel

readonly string nertc.RtcConstants.kNERtcKeyLogLevel = "log_level"

int value, NERtcLogLevel, SDK outputs logs that are of less than or equal to this level. The default is kNERtcLogLevelInfo.

◆ kNERtcKeyAudioProcessingAECEnable

readonly string nertc.RtcConstants.kNERtcKeyAudioProcessingAECEnable = "audio_processing_aec_enable"

bool value. Disable or enable AEC. The default value is true.

◆ kNERtcKeyAudioAECLowLevelEnable

readonly string nertc.RtcConstants.kNERtcKeyAudioAECLowLevelEnable = "audio_aec_low_level_enable"

bool value. Enable or disable low level AEC. The default value is false, The option takes effect only of kNERtcKeyAudioProcessingAECEnable is enabled.

◆ kNERtcKeyAudioProcessingAGCEnable

readonly string nertc.RtcConstants.kNERtcKeyAudioProcessingAGCEnable = "audio_processing_agc_enable"

bool value. Enable or disable AGC. The default value is true.

◆ kNERtcKeyAudioProcessingNSEnable

readonly string nertc.RtcConstants.kNERtcKeyAudioProcessingNSEnable = "audio_processing_ns_enable"

bool value. Enable or disable NS. The default value is true.

◆ kNERtcKeyAudioProcessingAINSEnable

readonly string nertc.RtcConstants.kNERtcKeyAudioProcessingAINSEnable = "audio_processing_ai_ns_enable"

bool value. Enable or disable AI NS. We recommend that you modify this option before calls. The default value is false.

◆ kNERtcKeyAudioProcessingExternalAudioMixEnable

readonly string nertc.RtcConstants.kNERtcKeyAudioProcessingExternalAudioMixEnable = "audio_processing_external_audiomix_enable"

bool value. Enable or disable the audio mixing. The default value is false.

◆ kNERtcKeyAudioProcessingEarphone

readonly string nertc.RtcConstants.kNERtcKeyAudioProcessingEarphone = "audio_processing_earphone"

bool value, which determines whether to use an earphone. true: uses an earphone. false: does not use an earphone. The default value is false.

◆ kNERtcKeyVideoSendOnPubType

readonly string nertc.RtcConstants.kNERtcKeyVideoSendOnPubType = "video_sendonpub_type"

int value. NERtcSendOnPubType. Sets the video sending strategy, and sends the mainstream by calling kNERtcSendOnPubHigh by default. The setting is valid before the call.

◆ kNERtcKeyChannel1V1ModeEnabled

readonly string nertc.RtcConstants.kNERtcKeyChannel1V1ModeEnabled = "channel_1v1_mode_enabled"

bool value. Enable or disable the 1v1 mode. The default value is disabled. The setting is valid before the call.

◆ kNERtcKeyExtraInfo

readonly string nertc.RtcConstants.kNERtcKeyExtraInfo = "extra_info"

string value. APP identification, used to identify the user's product name.

◆ kNERtcKeyAudioDeviceAutoSelectType

readonly string nertc.RtcConstants.kNERtcKeyAudioDeviceAutoSelectType = "audio_device_auto_select_type"

int value. Automatic audio device selection policy. The default value is 0.

  • 0: Default device priority
  • 1: Available device priority

◆ kNERtcKeyEnableReportVolumeWhenMute

readonly string nertc.RtcConstants.kNERtcKeyEnableReportVolumeWhenMute = "enable_report_volume_when_mute"

Whether to return original volume when the local user is muted. Boolean value, default: false.

◆ kNERtcKeyEnableVideoCaptureObserver

readonly string nertc.RtcConstants.kNERtcKeyEnableVideoCaptureObserver = "enable_video_capture_observer"

BOOL - Specifies whether to enable the callback to return captured video data. This enables developers to get the raw video data. You can clear the video data by calling destroyEngine. The default value is NO.

◆ kNERtcKeyVideoPreferHWEncode

readonly string nertc.RtcConstants.kNERtcKeyVideoPreferHWEncode = "video_prefer_hw_encode"

BOOL - Specifies whether to prefer using hardware to encode video data. The default value is YES. We recommend that you set this value before you call IRtcEngine.Initialize to initialize the IRtcEngine instance through the IRtcEngine.SetParameters method. Otherwise, the setting is applied the next time.

◆ kNERtcKeyVideoPreferHWDecode

readonly string nertc.RtcConstants.kNERtcKeyVideoPreferHWDecode = "video_prefer_hw_decode"

BOOL - Specifies whether to prefer using hardware to decode video data. The default value is YES. We recommend that you set this value before you call IRtcEngine.Initialize to initialize the IRtcEngine instance through the IRtcEngine.SetParameters method. Otherwise, the setting is applied the next time.

◆ kNERtcKeyEnableDynamicToken

readonly string nertc.RtcConstants.kNERtcKeyEnableDynamicToken = "enable_dynamic_token"

Whether to use a dynamic token to join the call. Boolean value, the default value is false.

Note
A dynamic token is not used by default, this method must be called before calling
  • true:use a dynamic token.
  • false:Do not use a dynamic token.

◆ kNERtcExternalVideoDeviceID

readonly string nertc.RtcConstants.kNERtcExternalVideoDeviceID = "nertc-video-external-device"

Device ID of an external video input source. After you enable external input, you must set this device ID using setDevice(windows only).

◆ kNERtcAudioDeviceAutoID

readonly string nertc.RtcConstants.kNERtcAudioDeviceAutoID = "nertc-audio-device-auto"

The audio device automatically selects the ID. When the ID is set as the device, the SDK will automatically select the appropriate audio device based on the device management system settings(windows only).


The documentation for this class was generated from the following file: