Skip to main content

Config Library

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 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 backdrop on all pages of the App Builder project stored as a base64 string

ENCRYPTION_ENABLED: boolean

Flag to enable/disable packet encryption functionality.

PROFILE: VideoProfile

Video profile to be used for user video feeds.

PRIMARY_COLOR: string

Primary color used in the App Builder project. Used for various UI Elements (ex: Primary Button)

PRIMARY_FONT_COLOR: string

Primary font color used in the App Builder project. Used for various UI Text Elements (ex: Heading, Sub-headings)

SECONDARY_FONT_COLOR: string

Secondary font color used in the App Builder project. Used for various UI Text Elements (ex: Button labels)

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.

AUDIO_ROOM: boolean

Flag to enable/disable audio room specific features.