Share via


CallCompositeOptions type

Optional features of the CallComposite.

type CallCompositeOptions = {
  branding?: {
    backgroundImage?: { url: string }
    logo?: { alt?: string; shape?: "unset" | "circle"; url: string }
  }
  callControls?: boolean | CallControlOptions
  captionsBanner?: { height: "full" | "default" }
  disableAutoShowDtmfDialer?: boolean | DtmfDialPadOptions
  errorBar?: boolean
  galleryOptions?: {
    layout?: VideoGalleryLayout
    localScreenShareView?: LocalScreenShareView
  }
  joinCallOptions?: { microphoneCheck?: "requireMicrophoneAvailable" | "skip" }
  localVideoTile?: boolean | LocalVideoTileOptions
  notificationOptions?: NotificationOptions_2
  remoteVideoTileMenuOptions?: RemoteVideoTileMenuOptions
  spotlight?: { hideSpotlightButtons?: boolean }
  surveyOptions?: {
    disableSurvey?: boolean
    onSurveyClosed?: (
      surveyState: "sent" | "skipped" | "error",
      surveyError?: string
    ) => void
    onSurveySubmitted?: (
      callId: string,
      surveyId: string,
      submittedSurvey: CallSurvey,
      improvementSuggestions: CallSurveyImprovementSuggestions
    ) => Promise<void>
  }
  videoTilesOptions?: VideoTilesOptions
}