@viviedu/applet-sdk
    Preparing search index...

    Function newBoxApplet

    • Initialise a new BoxApplet<Msg, Params> instance. Will error if called in a client applet.

      Due to limitations in Typescript, this function needs to be called in two steps so that Msg & Params can be specified explicitly without breaking inferences for the requiredFeatures option.

      • The generic Msg should be set to the type of the applet-messages to send and receive between.
      • The optional generic Params should be set to the type of the custom parameters that were passed to the applet on start. (from the startApplet message).

      Type Parameters

      • Msg
      • Params extends BaseParams = never

      Returns <
          const ReqFeats extends
              readonly (
                  | "box-captions-text-scaling"
                  | "box-captions"
                  | "box-display-status"
                  | "box-edge-ai"
                  | "box-events"
                  | "box-get-video-announcement-active"
                  | "box-get-vivi-interactive"
                  | "box-headless"
                  | "box-microphone"
                  | "box-play-content-control"
                  | "box-room-code-visibility"
                  | "box-screen-share-control"
                  | "box-stop-applet"
                  | "box-timer-controls"
                  | "box-token"
              )[] = [],
      >(
          opts?: BoxAppletOptions<ReqFeats>,
      ) => Promise<BoxApplet<Msg, Params, ReqFeats[number]>>

    Settings

    Member Visibility