Tutorials
Demo App
Banuba SDK Docs
Preparing search index...
The search index is not available
Banuba WebAR JavaScript API Reference
Banuba WebAR JavaScript API Reference
BanubaSDK
EffectPlayer
Class EffectPlayer
Hierarchy
EmscriptenObject
EffectPlayer
Index
Constructors
constructor
Methods
add
Frame
Data
Listener
add
Frame
Duration
Listener
clone
delete
delete
Later
draw
draw
With
External
Frame
Data
effect
Manager
frame
Processor
is
Alias
Of
is
Deleted
playback
Pause
playback
Play
playback
Stop
process
Video
Frame
Data
push
Frame
Data
push
Frame
Data
With
Number
set
Frame
Processor
set
Max
Faces
set
Recognizer
Offline
Mode
set
Recognizer
Use
Future
Filter
set
Recognizer
Use
Future
Interpolate
set
Render
Consistency
Mode
start
Video
Processing
stop
Video
Processing
surface
Changed
surface
Created
surface
Destroyed
create
Constructors
constructor
new
Effect
Player
(
)
:
EffectPlayer
Returns
EffectPlayer
Methods
add
Frame
Data
Listener
add
Frame
Data
Listener
(
frameData
)
:
void
Parameters
frameData
:
(
(
frameData
)
=>
void
)
(
frameData
)
:
void
Parameters
frameData
:
BanubaSDK
.
FrameData
Returns
void
Returns
void
add
Frame
Duration
Listener
add
Frame
Duration
Listener
(
recognizer
,
camera
,
render
)
:
void
Parameters
recognizer
:
FrameDurationListener
camera
:
FrameDurationListener
render
:
FrameDurationListener
Returns
void
clone
clone
(
)
:
EffectPlayer
Returns
EffectPlayer
delete
delete
(
)
:
void
Returns
void
delete
Later
delete
Later
(
)
:
void
Returns
void
draw
draw
(
)
:
number
Returns
number
draw
With
External
Frame
Data
draw
With
External
Frame
Data
(
frameData
)
:
number
Parameters
frameData
:
BanubaSDK
.
FrameData
Returns
number
effect
Manager
effect
Manager
(
)
:
EffectManager
Returns
EffectManager
frame
Processor
frame
Processor
(
)
:
FrameProcessor
Returns
FrameProcessor
is
Alias
Of
is
Alias
Of
(
)
:
boolean
Returns
boolean
is
Deleted
is
Deleted
(
)
:
boolean
Returns
boolean
playback
Pause
playback
Pause
(
)
:
void
Returns
void
playback
Play
playback
Play
(
)
:
void
Returns
void
playback
Stop
playback
Stop
(
)
:
void
Returns
void
process
Video
Frame
Data
process
Video
Frame
Data
(
frameData
,
iterationsCount
)
:
BanubaSDK
.
FrameData
Parameters
frameData
:
BanubaSDK
.
FrameData
iterationsCount
:
number
Returns
BanubaSDK
.
FrameData
push
Frame
Data
push
Frame
Data
(
frameData
)
:
void
Parameters
frameData
:
BanubaSDK
.
FrameData
Returns
void
push
Frame
Data
With
Number
push
Frame
Data
With
Number
(
frameData
,
frameNumber
)
:
void
Parameters
frameData
:
BanubaSDK
.
FrameData
frameNumber
:
number
Returns
void
set
Frame
Processor
set
Frame
Processor
(
processor
)
:
void
Parameters
processor
:
FrameProcessor
Returns
void
set
Max
Faces
set
Max
Faces
(
maxFaces
)
:
void
Parameters
maxFaces
:
number
Returns
void
set
Recognizer
Offline
Mode
set
Recognizer
Offline
Mode
(
isOfflineModeEnabled
)
:
void
Parameters
isOfflineModeEnabled
:
boolean
Returns
void
set
Recognizer
Use
Future
Filter
set
Recognizer
Use
Future
Filter
(
isFutureFilterEnabled
)
:
void
Parameters
isFutureFilterEnabled
:
boolean
Returns
void
set
Recognizer
Use
Future
Interpolate
set
Recognizer
Use
Future
Interpolate
(
isFutureInterpolateEnabled
)
:
void
Parameters
isFutureInterpolateEnabled
:
boolean
Returns
void
set
Render
Consistency
Mode
set
Render
Consistency
Mode
(
mode
)
:
void
Parameters
mode
:
ConsistencyMode
Returns
void
start
Video
Processing
start
Video
Processing
(
screenWidth
,
screenHeight
,
orientation
,
resetEffect
,
offlineMode
)
:
void
Parameters
screenWidth
:
number
screenHeight
:
number
orientation
:
CameraOrientation
resetEffect
:
boolean
offlineMode
:
boolean
Returns
void
stop
Video
Processing
stop
Video
Processing
(
resetEffect
)
:
void
Parameters
resetEffect
:
boolean
Returns
void
surface
Changed
surface
Changed
(
width
,
height
)
:
void
Parameters
width
:
number
height
:
number
Returns
void
surface
Created
surface
Created
(
width
,
height
)
:
void
Parameters
width
:
number
height
:
number
Returns
void
surface
Destroyed
surface
Destroyed
(
)
:
void
Returns
void
Static
create
create
(
configuration
)
:
EffectPlayer
Parameters
configuration
:
EffectPlayerConfiguration
Returns
EffectPlayer
Settings
Theme
OS
Light
Dark
On This Page
constructor
add
Frame
Data
Listener
add
Frame
Duration
Listener
clone
delete
delete
Later
draw
draw
With
External
Frame
Data
effect
Manager
frame
Processor
is
Alias
Of
is
Deleted
playback
Pause
playback
Play
playback
Stop
process
Video
Frame
Data
push
Frame
Data
push
Frame
Data
With
Number
set
Frame
Processor
set
Max
Faces
set
Recognizer
Offline
Mode
set
Recognizer
Use
Future
Filter
set
Recognizer
Use
Future
Interpolate
set
Render
Consistency
Mode
start
Video
Processing
stop
Video
Processing
surface
Changed
surface
Created
surface
Destroyed
create
Banuba
WebAR
Java
Script API
Reference
BanubaSDK
Animation
Mode
Attachment
Type
Blending
Mode
Camera
Orientation
Camera
Texture
Format
Component
Type
Consistency
Mode
Geometry
Topology
Image
Type
Morphing
Type
Pixel
Format
Projection
Type
Realtime
Processor
Mode
Render
Backend
Type
Segmentation
Mask
Type
Severity
Level
Texture
Filtering
Mode
BPC8
Image
Effect
Player
Effect
Player
Configuration
Feature
Parameter
Frame
Data
Frame
Processor
Full
Image
Data
Image
Format
Processor
Configuration
Unordered
Map
Utility
Manager
Vector
Feature
Parameter
Vector
Float
Vector
Int32
Vector
String
Vector
Uint8
Asset
Manager
Attachment
Audio
Track
Beauty
Morphing
Camera
Camera
Parameters
Camera
Texture
Component
Cubemap
Effect
Effect
Manager
Entity
Eyes
Status
Face
Face
Morphing
Face
Tracker
Image
Layer
Mat2x4
Mat3x4
Mat4x4
Material
Media
Mesh
Mesh
Instance
Morphing
Parameter
Physics
Simulator
Processor
Result
Render
Info
Render
List
Render
Target
Scene
Segmentation
Mask
State
Text
Texture
Texture
Transformation3d
Vec3
Vec4
Video
Weighted
Lut
Frame
Duration
Listener
Effect
Frame
Data
Image
Image
Capture
Media
Stream
Media
Stream
Capture
Module
Player
Video
Video
Recorder
Webcam
Input
Logger
BanubaSDKBinary
BanubaSDKBinary
File
Locator
Image
Source
Input
Options
Load
Many
Options
Load
Options
Photo
Settings
Playback
Options
Player
Event
Map
Player
Options
Progress
Progress
Listener
SDKOptions
Url
Video
Options
Dom
VERSION
default
Player
Options
default
Video
Constraints
default
Video
Options
is
Browser
Supported
is
Simd
Supported