Constructor
new FaceOverlayFilter()
FaceOverlayFilter interface. This type of
- Source:
Extends
Members
(static) constructorParams
Properties:
- Source:
(static) events
- Source:
Methods
(static) setOverlayedImage(uri, offsetXPercent, offsetYPercent, widthPercent, heightPercent, callbackopt) → {external:Promise
Sets the image to use as overlay on the detected faces.
Parameters:
Name |
Type |
Attributes |
Description |
uri |
external:String
|
|
URI where the image is located |
offsetXPercent |
external:Number
|
|
the offset applied to the image, from the X coordinate of the detected face
upper right corner. A positive value indicates right displacement, while a
negative value moves the overlaid image to the left. This offset is
specified as a percentage of the face width.
For example, to cover the detected face with the overlaid image, the
parameter has to be 0.0 . Values of 1.0 or
-1.0 indicate that the image upper right corner will be at the
face´s X coord, +- the face´s width.
Note
The parameter name is misleading, the value is not a percent but a ratio |
offsetYPercent |
external:Number
|
|
the offset applied to the image, from the Y coordinate of the detected face
upper right corner. A positive value indicates up displacement, while a
negative value moves the overlaid image down. This offset is specified as a
percentage of the face width.
For example, to cover the detected face with the overlaid image, the
parameter has to be 0.0 . Values of 1.0 or
-1.0 indicate that the image upper right corner will be at the
face´s Y coord, +- the face´s width.
Note
The parameter name is misleading, the value is not a percent but a ratio |
widthPercent |
external:Number
|
|
proportional width of the overlaid image, relative to the width of the
detected face. A value of 1.0 implies that the overlaid image will have the
same width as the detected face. Values greater than 1.0 are allowed, while
negative values are forbidden.
Note
The parameter name is misleading, the value is not a percent but a ratio |
heightPercent |
external:Number
|
|
proportional height of the overlaid image, relative to the height of the
detected face. A value of 1.0 implies that the overlaid image will have the
same height as the detected face. Values greater than 1.0 are allowed, while
Note
The parameter name is misleading, the value is not a percent but a ratio |
callback |
module:filters.FaceOverlayFilter~setOverlayedImageCallback
|
<optional>
|
|
- Source:
Returns:
-
Type
-
external:Promise
(static) unsetOverlayedImage(callbackopt) → {external:Promise}
Clear the image to be shown over each detected face. Stops overlaying the
faces.
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
children of this MediaObject
.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Parameters:
- Inherited From:
- Deprecated:
- (Use children instead) children of this
MediaObject
.
- Source:
Returns:
-
Type
-
external:Promise
getCreationTime(callbackopt) → {external:Promise}
MediaObject
creation time in seconds since Epoch.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getMaxOuputBitrate(callbackopt) → {external:Promise}
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use maxOutputBitrate instead of this function.
Maximum video bandwidth for transcoding. 0 = unlimited.
Unit: bps(bits per second).
Default value: MAXINT
- Source:
Returns:
-
Type
-
external:Promise
getMaxOutputBitrate(callbackopt) → {external:Promise}
Maximum video bitrate for transcoding. 0 = unlimited.
Unit: bps(bits per second).
Default value: MAXINT
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
MediaPipeline to which this
MediaObject
belongs. It returns itself when invoked for a
pipeline object.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getMinOuputBitrate(callbackopt) → {external:Promise}
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use minOutputBitrate instead of this function.
Minimum video bandwidth for transcoding.
Unit: bps(bits per second).
Default value: 0
- Source:
Returns:
-
Type
-
external:Promise
getMinOutputBitrate(callbackopt) → {external:Promise}
Minimum video bitrate for transcoding.
Unit: bps(bits per second).
Default value: 0
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
this MediaObject
's name. This is just a comodity to simplify
developers' life debugging, it is not used internally for indexing nor
idenfiying the objects. By default, it's the object's ID.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
parent of this
MediaObject
. The parent of a
Hub or a
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
flag activating or deactivating sending the element's tags in fired events.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
setMaxOuputBitrate(maxOuputBitrate, callbackopt) → {external:Promise}
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use maxOutputBitrate instead of this function.
Maximum video bandwidth for transcoding. 0 = unlimited.
Unit: bps(bits per second).
Default value: MAXINT
- Source:
Returns:
-
Type
-
external:Promise
setMaxOutputBitrate(maxOutputBitrate, callbackopt) → {external:Promise}
Maximum video bitrate for transcoding. 0 = unlimited.
Unit: bps(bits per second).
Default value: MAXINT
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
setMinOuputBitrate(minOuputBitrate, callbackopt) → {external:Promise}
Parameters:
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use minOutputBitrate instead of this function.
Minimum video bandwidth for transcoding.
Unit: bps(bits per second).
Default value: 0
- Source:
Returns:
-
Type
-
external:Promise
setMinOutputBitrate(minOutputBitrate, callbackopt) → {external:Promise}
Minimum video bitrate for transcoding.
Unit: bps(bits per second).
Default value: 0
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
this MediaObject
's name. This is just a comodity to simplify
developers' life debugging, it is not used internally for indexing nor
idenfiying the objects. By default, it's the object's ID.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
flag activating or deactivating sending the element's tags in fired events.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Type Definitions
setOverlayedImageCallback(error)
Parameters:
- Source:
unsetOverlayedImageCallback(error)
Parameters:
- Source: