Banuba WebAR JavaScript API Reference
Tutorials
Banuba SDK Docs
Preparing search index...
BanubaSDK
EffectPlayer
Class EffectPlayer
Hierarchy
EmscriptenObject
EffectPlayer
Index
Constructors
constructor
Methods
add
Frame
Data
Listener
Overrided
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
EffectPlayer
()
:
EffectPlayer
Returns
EffectPlayer
Methods
add
Frame
Data
Listener
Overrided
addFrameDataListenerOverrided
(
frameData
:
(
frameData
:
BanubaSDK
.
FrameData
)
=>
void
,
)
:
void
Parameters
frameData
:
(
frameData
:
BanubaSDK
.
FrameData
)
=>
void
Returns
void
add
Frame
Duration
Listener
addFrameDurationListener
(
recognizer
:
FrameDurationListener
,
camera
:
FrameDurationListener
,
render
:
FrameDurationListener
,
)
:
void
Parameters
recognizer
:
FrameDurationListener
camera
:
FrameDurationListener
render
:
FrameDurationListener
Returns
void
clone
clone
()
:
this
Returns
this
delete
delete
()
:
void
Returns
void
delete
Later
deleteLater
()
:
void
Returns
void
draw
draw
()
:
number
Returns
number
draw
With
External
Frame
Data
drawWithExternalFrameData
(
frameData
:
BanubaSDK
.
FrameData
)
:
number
Parameters
frameData
:
BanubaSDK
.
FrameData
Returns
number
effect
Manager
effectManager
()
:
EffectManager
Returns
EffectManager
frame
Processor
frameProcessor
()
:
FrameProcessor
Returns
FrameProcessor
is
Alias
Of
isAliasOf
()
:
boolean
Returns
boolean
is
Deleted
isDeleted
()
:
boolean
Returns
boolean
playback
Pause
playbackPause
()
:
void
Returns
void
playback
Play
playbackPlay
()
:
void
Returns
void
playback
Stop
playbackStop
()
:
void
Returns
void
process
Video
Frame
Data
processVideoFrameData
(
frameData
:
BanubaSDK
.
FrameData
,
iterationsCount
:
number
,
)
:
BanubaSDK
.
FrameData
Parameters
frameData
:
BanubaSDK
.
FrameData
iterationsCount
:
number
Returns
BanubaSDK
.
FrameData
push
Frame
Data
pushFrameData
(
frameData
:
BanubaSDK
.
FrameData
)
:
void
Parameters
frameData
:
BanubaSDK
.
FrameData
Returns
void
push
Frame
Data
With
Number
pushFrameDataWithNumber
(
frameData
:
BanubaSDK
.
FrameData
,
frameNumber
:
number
,
)
:
void
Parameters
frameData
:
BanubaSDK
.
FrameData
frameNumber
:
number
Returns
void
set
Frame
Processor
setFrameProcessor
(
processor
:
FrameProcessor
)
:
void
Parameters
processor
:
FrameProcessor
Returns
void
set
Max
Faces
setMaxFaces
(
maxFaces
:
number
)
:
void
Parameters
maxFaces
:
number
Returns
void
set
Recognizer
Offline
Mode
setRecognizerOfflineMode
(
isOfflineModeEnabled
:
boolean
)
:
void
Parameters
isOfflineModeEnabled
:
boolean
Returns
void
set
Recognizer
Use
Future
Filter
setRecognizerUseFutureFilter
(
isFutureFilterEnabled
:
boolean
)
:
void
Parameters
isFutureFilterEnabled
:
boolean
Returns
void
set
Recognizer
Use
Future
Interpolate
setRecognizerUseFutureInterpolate
(
isFutureInterpolateEnabled
:
boolean
)
:
void
Parameters
isFutureInterpolateEnabled
:
boolean
Returns
void
set
Render
Consistency
Mode
setRenderConsistencyMode
(
mode
:
ConsistencyMode
)
:
void
Parameters
mode
:
ConsistencyMode
Returns
void
start
Video
Processing
startVideoProcessing
(
screenWidth
:
number
,
screenHeight
:
number
,
orientation
:
CameraOrientation
,
resetEffect
:
boolean
,
offlineMode
:
boolean
,
)
:
void
Parameters
screenWidth
:
number
screenHeight
:
number
orientation
:
CameraOrientation
resetEffect
:
boolean
offlineMode
:
boolean
Returns
void
stop
Video
Processing
stopVideoProcessing
(
resetEffect
:
boolean
)
:
void
Parameters
resetEffect
:
boolean
Returns
void
surface
Changed
surfaceChanged
(
width
:
number
,
height
:
number
)
:
void
Parameters
width
:
number
height
:
number
Returns
void
surface
Created
surfaceCreated
(
width
:
number
,
height
:
number
)
:
void
Parameters
width
:
number
height
:
number
Returns
void
surface
Destroyed
surfaceDestroyed
()
:
void
Returns
void
Static
create
create
(
configuration
:
EffectPlayerConfiguration
)
:
EffectPlayer
Parameters
configuration
:
EffectPlayerConfiguration
Returns
EffectPlayer
Settings
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
add
Frame
Data
Listener
Overrided
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
Tutorials
Banuba SDK Docs
Banuba WebAR JavaScript API Reference
Loading...