Banuba WebAR JavaScript API Reference
    Preparing search index...

    Banuba WebAR JavaScript API Reference

    Reference for high-level Banuba WebAR SDK.

    import { Webcam, Player, Module, Effect, Dom } from "/BanubaSDK.js"

    const run = async () => {
    const player = await Player.create({ clientToken: "xxx-xxx-xxx" })
    await player.addModule(new Module("face_tracker.zip"))

    player.use(new Webcam())
    player.applyEffect(new Effect("Octopus.zip"))
    player.play()

    Dom.render(player, "#webar-app")
    }

    run()

    Visit the Banuba Web AR Overview to learn the basics.

    Check out the Getting started guide and Tutorials for code examples and integration receipts.

    Input

    Image
    MediaStream
    ReadableStream
    Video
    Webcam
    Input
    ImageSource
    InputOptions
    VideoOptions
    defaultVideoConstraints
    defaultVideoOptions

    Player

    FrameData
    Module
    Player
    BanubaSDKBinaryFileLocator
    PlaybackOptions
    PlayerEventMap
    PlayerOptions
    SDKOptions
    defaultPlayerOptions

    Effect

    Effect

    Output

    ImageCapture
    MediaStreamCapture
    VideoRecorder
    PhotoSettings
    Dom

    Misc

    BanubaSDK
    FS
    Logger
    BanubaSDKBinary
    LoadManyOptions
    LoadOptions
    Progress
    ProgressListener
    Url
    isSimdSupported
    VERSION
    isBrowserSupported