Agora C++ API Reference for All Platforms

Variables
agora::extension Namespace Reference

## Variables
static const char *const | SCAP_PROP_KEY_CAP_USE_MGF = "cap_use_mgf"
static const char *const | SCAP_PROP_KEY_CAP_USE_DXGI = "cap_use_dxgi"
static const char *const | SCAP_PROP_KEY_CAP_USE_WGC = "cap_use_wgc"
static const char *const | SCAP_PROP_KEY_CAP_SHOW_WGC_BORDER = "cap_show_wgc_border"
static const char *const | SCAP_PROP_KEY_CAP_FORCE_SCREEN = "cap_force_screen"
static const char *const | SCAP_PROP_KEY_CAP_WINDOW_FOCUS = "cap_window_focus"
static const char *const | SCAP_PROP_KEY_CAP_IMPL_TYPE = "cap_impl_type"
static const char *const | SCAP_PROP_KEY_CAP_COLOR_MATRIX = "cap_color_matrix"
static const char *const | SCAP_PROP_KEY_CAP_COLOR_RANGE = "cap_color_range"
static const char *const | SCAP_PROP_KEY_CAP_MODE = "cap_mode"
static const char *const | SCAP_PROP_KEY_CAP_PROMOTE_GPU_PRIORITY = "cap_allow_eanble_promote_gpu_priority"
static const char *const | SCAP_PROP_KEY_CAP_FORCE_USE_BITBLT_ON_WIN7 = "cap_force_use_bitblt_on_win7"
static const char *const | SCAP_PROP_KEY_CAP_FALLBACK_TO_GDI_WITH_WGC_BORDER_ISSUE = "cap_fallback_to_gdi_with_wgc_border_issue"
static const char *const | SCAP_PROP_KEY_CAP_FORCE_DISABLE_WGC_FRAME_DIFF = "cap_force_disable_wgc_frame_diff"
static const char *const | SCAP_PROP_KEY_CAP_OFFICE_TARGET_EXE_LIST = "cap_office_target_exe_list"
static const char *const | SCAP_PROP_KEY_CAP_WPS_TARGET_EXE_LIST = "cap_wps_target_exe_list"
static const char *const | SCAP_PROP_VAL_CAP_IMPL_MAGNIFY = "cap_impl_magnification"
static const char *const | SCAP_PROP_VAL_CAP_IMPL_DXGI = "cap_impl_dxgi"
static const char *const | SCAP_PROP_VAL_CAP_IMPL_GDI = "cap_impl_gdi"
static const char *const | SCAP_PROP_VAL_CAP_IMPL_AUTO = "cap_impl_auto"
static const char *const | SCAP_EVENT_WINDOW_CLOSED = "cap_window_closed"
static const char *const | SCAP_EVENT_WINDOW_MINIMIZED = "cap_window_minimized"
static const char *const | SCAP_EVENT_WINDOW_HIDDEN = "cap_window_hidden"
static const char *const | SCAP_EVENT_WINDOW_RECOVER_FROM_HIDDEN = "cap_window_recover_from_hidden"
static const char *const | SCAP_EVENT_WINDOW_RECOVER_FROM_MINIMIZED = "cap_window_recover_from_minimized"
static const char *const | SCAP_EVENT_NO_PERMISION = "cap_no_permision"
static const char *const | SCAP_EVENT_OK = "cap_ok"
static const char *const | SCAP_EVENT_CAPTURE_CONNECTED = "cap_connected"
static const char *const | SCAP_EVENT_CAPTURE_DISCONNECTED = "cap_disconnected"
static const char *const | SCAP_EVENT_CAPTURE_FAILED = "cap_failed"
static const char *const | SCAP_EVENT_DISPLAY_DISCONNECTED = "cap_display_disconnected"
static const char *const | SCAP_EVENT_AUTO_FALLBACK = "cap_auto_fallback"
static const char *const | SCAP_EVENT_CAPTURE_PAUSED = "cap_paused"
static const char *const | SCAP_EVENT_CAPTURE_RESUMED = "cap_resumed"
static const char *const | SCAP_PROP_KEY_IPC_PORT = "cap_ipc_port"
static const char *const | SCAP_PROP_KEY_CAP_AUDIO = "cap_audio"
static const char *const | SCAP_PROP_KEY_CAP_VIDEO = "cap_video"
static const char *const | SCAP_PROP_KEY_CAP_MAX_AUDIO_FRAME = "cap_max_audio_frame"
static const char *const | SCAP_PROP_KEY_CAP_CROP_WIN = "cap_crop_window"
static const char *const | SCAP_PROP_KEY_CAP_MASK_OCCLUED = "cap_maskocclued_window"
static const char *const | SCAP_PROP_KEY_CAP_MUTI_GPU = "cap_mutigpu_exclude"
static const char *const | SCAP_PROP_KEY_CAP_EXCLUDE_HIGHLIGHT_BORDER = "cap_exclude_highlight_border"
static const char *const | SCAP_PROP_KEY_CAP_CAPTURE_TO_TEXTURE = "cap_capture_to_texture"
static const char *const | SCAP_PROP_KEY_CAP_EXCLUDE_HIGHLIGHT_BORDER_FOR_MAGNIFIER = "cap_exclude_highlight_border_for_magnifier"
static const char *const | SCAP_PROP_KEY_CAP_FORCE_USE_NV12_TEXTURE = "cap_force_use_nv12_texture"
static const char *const | SCAP_PROP_KEY_CAP_SHOW_AGORA_BORDER_WHEN_WINDOW_MAXIMIZED = "cap_show_agora_border_when_window_maximized"

## Variable Documentation

## ◆ SCAP_PROP_KEY_CAP_USE_MGF

const char* const agora::extension::SCAP_PROP_KEY_CAP_USE_MGF = "cap_use_mgf"
| static

## ◆ SCAP_PROP_KEY_CAP_USE_DXGI

const char* const agora::extension::SCAP_PROP_KEY_CAP_USE_DXGI = "cap_use_dxgi"
| static

## ◆ SCAP_PROP_KEY_CAP_USE_WGC

const char* const agora::extension::SCAP_PROP_KEY_CAP_USE_WGC = "cap_use_wgc"
| static

## ◆ SCAP_PROP_KEY_CAP_SHOW_WGC_BORDER

const char* const agora::extension::SCAP_PROP_KEY_CAP_SHOW_WGC_BORDER = "cap_show_wgc_border"
| static

## ◆ SCAP_PROP_KEY_CAP_FORCE_SCREEN

const char* const agora::extension::SCAP_PROP_KEY_CAP_FORCE_SCREEN = "cap_force_screen"
| static

## ◆ SCAP_PROP_KEY_CAP_WINDOW_FOCUS

const char* const agora::extension::SCAP_PROP_KEY_CAP_WINDOW_FOCUS = "cap_window_focus"
| static

## ◆ SCAP_PROP_KEY_CAP_IMPL_TYPE

const char* const agora::extension::SCAP_PROP_KEY_CAP_IMPL_TYPE = "cap_impl_type"
| static

## ◆ SCAP_PROP_KEY_CAP_COLOR_MATRIX

const char* const agora::extension::SCAP_PROP_KEY_CAP_COLOR_MATRIX = "cap_color_matrix"
| static

## ◆ SCAP_PROP_KEY_CAP_COLOR_RANGE

const char* const agora::extension::SCAP_PROP_KEY_CAP_COLOR_RANGE = "cap_color_range"
| static

## ◆ SCAP_PROP_KEY_CAP_MODE

const char* const agora::extension::SCAP_PROP_KEY_CAP_MODE = "cap_mode"
| static

## ◆ SCAP_PROP_KEY_CAP_PROMOTE_GPU_PRIORITY

const char* const agora::extension::SCAP_PROP_KEY_CAP_PROMOTE_GPU_PRIORITY = "cap_allow_eanble_promote_gpu_priority"
| static

## ◆ SCAP_PROP_KEY_CAP_FORCE_USE_BITBLT_ON_WIN7

const char* const agora::extension::SCAP_PROP_KEY_CAP_FORCE_USE_BITBLT_ON_WIN7 = "cap_force_use_bitblt_on_win7"
| static

## ◆ SCAP_PROP_KEY_CAP_FALLBACK_TO_GDI_WITH_WGC_BORDER_ISSUE

const char* const agora::extension::SCAP_PROP_KEY_CAP_FALLBACK_TO_GDI_WITH_WGC_BORDER_ISSUE = "cap_fallback_to_gdi_with_wgc_border_issue"
| static

## ◆ SCAP_PROP_KEY_CAP_FORCE_DISABLE_WGC_FRAME_DIFF

const char* const agora::extension::SCAP_PROP_KEY_CAP_FORCE_DISABLE_WGC_FRAME_DIFF = "cap_force_disable_wgc_frame_diff"
| static

## ◆ SCAP_PROP_KEY_CAP_OFFICE_TARGET_EXE_LIST

const char* const agora::extension::SCAP_PROP_KEY_CAP_OFFICE_TARGET_EXE_LIST = "cap_office_target_exe_list"
| static

## ◆ SCAP_PROP_KEY_CAP_WPS_TARGET_EXE_LIST

const char* const agora::extension::SCAP_PROP_KEY_CAP_WPS_TARGET_EXE_LIST = "cap_wps_target_exe_list"
| static

## ◆ SCAP_PROP_VAL_CAP_IMPL_MAGNIFY

const char* const agora::extension::SCAP_PROP_VAL_CAP_IMPL_MAGNIFY = "cap_impl_magnification"
| static

## ◆ SCAP_PROP_VAL_CAP_IMPL_DXGI

const char* const agora::extension::SCAP_PROP_VAL_CAP_IMPL_DXGI = "cap_impl_dxgi"
| static

## ◆ SCAP_PROP_VAL_CAP_IMPL_GDI

const char* const agora::extension::SCAP_PROP_VAL_CAP_IMPL_GDI = "cap_impl_gdi"
| static

## ◆ SCAP_PROP_VAL_CAP_IMPL_AUTO

const char* const agora::extension::SCAP_PROP_VAL_CAP_IMPL_AUTO = "cap_impl_auto"
| static

## ◆ SCAP_EVENT_WINDOW_CLOSED

const char* const agora::extension::SCAP_EVENT_WINDOW_CLOSED = "cap_window_closed"
| static

## ◆ SCAP_EVENT_WINDOW_MINIMIZED

const char* const agora::extension::SCAP_EVENT_WINDOW_MINIMIZED = "cap_window_minimized"
| static

## ◆ SCAP_EVENT_WINDOW_HIDDEN

const char* const agora::extension::SCAP_EVENT_WINDOW_HIDDEN = "cap_window_hidden"
| static

## ◆ SCAP_EVENT_WINDOW_RECOVER_FROM_HIDDEN

const char* const agora::extension::SCAP_EVENT_WINDOW_RECOVER_FROM_HIDDEN = "cap_window_recover_from_hidden"
| static

## ◆ SCAP_EVENT_WINDOW_RECOVER_FROM_MINIMIZED

const char* const agora::extension::SCAP_EVENT_WINDOW_RECOVER_FROM_MINIMIZED = "cap_window_recover_from_minimized"
| static

## ◆ SCAP_EVENT_NO_PERMISION

const char* const agora::extension::SCAP_EVENT_NO_PERMISION = "cap_no_permision"
| static

## ◆ SCAP_EVENT_OK

const char* const agora::extension::SCAP_EVENT_OK = "cap_ok"
| static

## ◆ SCAP_EVENT_CAPTURE_CONNECTED

const char* const agora::extension::SCAP_EVENT_CAPTURE_CONNECTED = "cap_connected"
| static

## ◆ SCAP_EVENT_CAPTURE_DISCONNECTED

const char* const agora::extension::SCAP_EVENT_CAPTURE_DISCONNECTED = "cap_disconnected"
| static

## ◆ SCAP_EVENT_CAPTURE_FAILED

const char* const agora::extension::SCAP_EVENT_CAPTURE_FAILED = "cap_failed"
| static

## ◆ SCAP_EVENT_DISPLAY_DISCONNECTED

const char* const agora::extension::SCAP_EVENT_DISPLAY_DISCONNECTED = "cap_display_disconnected"
| static

## ◆ SCAP_EVENT_AUTO_FALLBACK

const char* const agora::extension::SCAP_EVENT_AUTO_FALLBACK = "cap_auto_fallback"
| static

## ◆ SCAP_EVENT_CAPTURE_PAUSED

const char* const agora::extension::SCAP_EVENT_CAPTURE_PAUSED = "cap_paused"
| static

## ◆ SCAP_EVENT_CAPTURE_RESUMED

const char* const agora::extension::SCAP_EVENT_CAPTURE_RESUMED = "cap_resumed"
| static

## ◆ SCAP_PROP_KEY_IPC_PORT

const char* const agora::extension::SCAP_PROP_KEY_IPC_PORT = "cap_ipc_port"
| static

## ◆ SCAP_PROP_KEY_CAP_AUDIO

const char* const agora::extension::SCAP_PROP_KEY_CAP_AUDIO = "cap_audio"
| static

## ◆ SCAP_PROP_KEY_CAP_VIDEO

const char* const agora::extension::SCAP_PROP_KEY_CAP_VIDEO = "cap_video"
| static

## ◆ SCAP_PROP_KEY_CAP_MAX_AUDIO_FRAME

const char* const agora::extension::SCAP_PROP_KEY_CAP_MAX_AUDIO_FRAME = "cap_max_audio_frame"
| static

## ◆ SCAP_PROP_KEY_CAP_CROP_WIN

const char* const agora::extension::SCAP_PROP_KEY_CAP_CROP_WIN = "cap_crop_window"
| static

## ◆ SCAP_PROP_KEY_CAP_MASK_OCCLUED

const char* const agora::extension::SCAP_PROP_KEY_CAP_MASK_OCCLUED = "cap_maskocclued_window"
| static

## ◆ SCAP_PROP_KEY_CAP_MUTI_GPU

const char* const agora::extension::SCAP_PROP_KEY_CAP_MUTI_GPU = "cap_mutigpu_exclude"
| static

## ◆ SCAP_PROP_KEY_CAP_EXCLUDE_HIGHLIGHT_BORDER

const char* const agora::extension::SCAP_PROP_KEY_CAP_EXCLUDE_HIGHLIGHT_BORDER = "cap_exclude_highlight_border"
| static

## ◆ SCAP_PROP_KEY_CAP_CAPTURE_TO_TEXTURE

const char* const agora::extension::SCAP_PROP_KEY_CAP_CAPTURE_TO_TEXTURE = "cap_capture_to_texture"
| static

## ◆ SCAP_PROP_KEY_CAP_EXCLUDE_HIGHLIGHT_BORDER_FOR_MAGNIFIER

const char* const agora::extension::SCAP_PROP_KEY_CAP_EXCLUDE_HIGHLIGHT_BORDER_FOR_MAGNIFIER = "cap_exclude_highlight_border_for_magnifier"
| static

## ◆ SCAP_PROP_KEY_CAP_FORCE_USE_NV12_TEXTURE

const char* const agora::extension::SCAP_PROP_KEY_CAP_FORCE_USE_NV12_TEXTURE = "cap_force_use_nv12_texture"
| static

## ◆ SCAP_PROP_KEY_CAP_SHOW_AGORA_BORDER_WHEN_WINDOW_MAXIMIZED

const char* const agora::extension::SCAP_PROP_KEY_CAP_SHOW_AGORA_BORDER_WHEN_WINDOW_MAXIMIZED = "cap_show_agora_border_when_window_maximized"
| static