Class: FaceFilterPlugin
@geenee/bodyrenderers-common.FaceFilterPlugin
Face filter plugin
Simple plugin filtering a list of detected faces by the provided predicate. Useful when application may need to ignore certain head poses, for example when rotation angle is too big for virtual try-on.
Hierarchy
-
↳
FaceFilterPlugin
Constructors
constructor
• new FaceFilterPlugin(predicate
)
Constructor
Parameters
Name | Type | Description |
---|---|---|
predicate | (f : Face ) => boolean | Predicate of face filter |
Overrides
Properties
loaded
• loaded: boolean
Loaded state
Inherited from
ordinal
• ordinal: number
Ordinal number
Inherited from
predicate
• Protected
predicate: (f
: Face
) => boolean
Type declaration
▸ (f
): boolean
Predicate of face filter
Parameters
Name | Type |
---|---|
f | Face |
Returns
boolean
renderer
• Protected
Optional
renderer: Renderer
<FaceResult
>
Renderer loaded the plugin
Inherited from
Methods
dispose
▸ dispose(): void
Dispose video plugin
Returns
void
Inherited from
load
▸ load(renderer
): Promise
<void
>
Initialize plugin
Initializes resources/instances needed by plugin. Overridden by derived classes for particular task.
Parameters
Name | Type | Description |
---|---|---|
renderer | Renderer <FaceResult > | Renderer this plugin is attached to |
Returns
Promise
<void
>
Promise resolving when initialization is finished
Inherited from
setupCamera
▸ setupCamera(ratio
, angle
): void
Set camera parameters
Could be overridden to adjust plugin's pipeline.
Parameters
Name | Type | Description |
---|---|---|
ratio | number | Aspect ration of input video |
angle | number | Vertical field of view in radians |
Returns
void
Inherited from
setupVideo
▸ setupVideo(size
): void
Set video size
Could be overridden to adjust plugin's pipeline.
Parameters
Name | Type | Description |
---|---|---|
size | Size | Resolution of input video |
Returns
void
Inherited from
unload
▸ unload(): void
Reset plugin
Releases all resources/instances created in load(). Overridden by derived classes for particular task.
Returns
void
Inherited from
update
▸ update(result
, stream
): Promise
<void
>
Update
Override filters detected faces in place using predicate provided to constructor.
Parameters
Name | Type | Description |
---|---|---|
result | FaceResult | Results of face detection |
stream | HTMLCanvasElement | Captured video frame |
Returns
Promise
<void
>
Promise resolving when update is finished