List of config variables set via the App Builder Console as configured by the user.
APP_NAME: string
Name of the App Builder project.
LOGO: string
Logo of the App Builder project stored as a base64 string.
APP_ID: string
Agora APP_ID associated with the App Builder project.
FRONTEND_ENDPOINT: string
Url of the frontend deployed from the App Builder Console. Used to generate invite links for meetings.
BACKEND_ENDPOINT: string
Url of the backend deployed from the App Builder Console. Target for all backend network queries.
PSTN: boolean
Flag to enable/disable ability to join meetings via PSTN Dial-in.
PRECALL: boolean
Flag to enable/disable the precall screen.
CHAT: boolean
Flag to enable/disable the chat functionality.
CLOUD_RECORDING: boolean
Flag to enable/disable cloud recording functionality.
SCREEN_SHARING: boolean
Flag to enable/disable screen sharing functionality.
LANDING_SUB_HEADING: string
Text displayed under the APP_NAME on the create page.
BG: string
Image used as background on all pages of the App Builder project stored as a base64 string.
ENCRYPTION_ENABLED: boolean
Flag to enable/disable packet encryption functionality.
Video profile to be used for user video feeds.
EVENT_MODE: boolean
Flag to enable/disable livestreaming specific features.
RAISE_HAND: boolean
Flag to enable/disable raise hand functionality. Requires EVENT_MODE to be enabled.
GEO_FENCING: boolean
Flag to enable/disable geo fencing functionality.
GEO_FENCING_INCLUDE_AREA: string
Include areas for geo fencing. only applicable if GEO_FENCING is enabled and platform is web
Accepts comma seperated string.
GEO_FENCING_EXCLUDE_AREA: string
Exclude area for geo fencing. only applicable if GEO_FENCING is enabled and platform is web.
AUDIO_ROOM: boolean
Flag to enable/disable audio room specific features.
ICON_TEXT: boolean
Flag to show/hide labels on the top/bottom bar buttons.
PRIMARY_ACTION_BRAND_COLOR: string
Primary brand color for the App.
PRIMARY_ACTION_TEXT_COLOR: string
Primary text color for the App.
SECONDARY_ACTION_COLOR: string
Secondary color for the App.
FONT_COLOR: string
Font color for the App.
BACKGROUND_COLOR: string
Background color for the App.
VIDEO_AUDIO_TILE_COLOR: string
Video tile color.
VIDEO_AUDIO_TILE_OVERLAY_COLOR: string
Video tile overlay color.
VIDEO_AUDIO_TILE_TEXT_COLOR: string
Video tile text color.
VIDEO_AUDIO_TILE_AVATAR_COLOR: string
Video tile avatar color.
SEMANTIC_ERROR: string
Used in error toast and messages.
SEMANTIC_SUCCESS: string
Used in success toast and messages.
SEMANTIC_WARNING: string
Used in warning toast and messages.
SEMANTIC_NEUTRAL: string
Used in info toast and messages.
CARD_LAYER_1_COLOR: string
Used in cards.
CARD_LAYER_2_COLOR: string
Used in cards.
CARD_LAYER_3_COLOR: string
Used in cards.
CARD_LAYER_4_COLOR: string
Used in cards.
CARD_LAYER_5_COLOR: string
Used in cards.
ICON_BG_COLOR: string
Used in icon buttons.
ACTIVE_SPEAKER: boolean
Flag to enable/disable active speaker highlight on the video tile.
ENABLE_IDP_AUTH: boolean
Flag to enable/disable IDP authentication. supports only Turnkey solution. you can either enable IDP or token auth. both authentication can't be enabled at the same time.
ENABLE_TOKEN_AUTH: boolean
Flag to enable/disable token server authentication. supports only SDK Integration. you can either enable IDP or token auth. both authentication can't be enabled at same time.
ENABLE_STT: boolean
Flag to enable/disable speech to text feature.
ENABLE_NOISE_CANCELLATION: boolean
Flag to enable/disable noise cancellation feature.
ENABLE_NOISE_CANCELLATION_BY_DEFAULT: boolean
Flag to turn on noise cancellation functionality by default. only applicable if noise cancellation is enabled.
ENABLE_VIRTUAL_BACKGROUND: boolean
Flag to enable/disable virtual background feature.
ENABLE_WAITING_ROOM: boolean
Flag to enable/disable waiting room feature.
ENABLE_WHITEBOARD: boolean
Flag to enable/disable whiteboard feature.
ENABLE_WHITEBOARD_FILE_UPLOAD: boolean
Flag to enable/disable whiteboard file upload feature. only applicable if whiteboard is enabled.
WHITEBOARD_APPIDENTIFIER: boolean
Used in whiteboard initialization config. only applicable if whiteboard is enabled.
WHITEBOARD_REGION: boolean
Used in whiteboard initialization config. only applicable if whiteboard is enabled.