Constructor
new FaceOverlayFilter()
Extends
Members
(static) constructorParams
Properties:
Name | Type | Description |
---|---|---|
mediaPipeline |
module:core.MediaPipeline | pipeline to which this Filter belons |
(static) events
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> |
Returns:
- Type
- external:Promise
(static) unsetOverlayedImage(callbackopt) → {external:Promise}
Clear the image to be shown over each detected face. Stops overlaying the
faces.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:filters.FaceOverlayFilter~unsetOverlayedImageCallback |
<optional> |
Returns:
- Type
- external:Promise
getChildren(callbackopt) → {external:Promise}
Children of this
MediaObject
.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getChildrenCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getChilds(callbackopt) → {external:Promise}
Children of this
MediaObject
.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getChildsCallback |
<optional> |
- Inherited From:
- Deprecated:
- Use children instead.
- Source:
Returns:
- Type
- external:Promise
getCreationTime(callbackopt) → {external:Promise}
MediaObject
creation time in seconds since Epoch.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getCreationTimeCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getMaxOuputBitrate(callbackopt) → {external:Promise}
Maximum video bandwidth for transcoding.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaElement~getMaxOuputBitrateCallback |
<optional> |
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#maxOutputBitrate instead of this function.
- Source:
Returns:
- Type
- external:Promise
getMaxOutputBitrate(callbackopt) → {external:Promise}
Maximum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: MAXINT.
- 0 = unlimited.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaElement~getMaxOutputBitrateCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getMediaPipeline(callbackopt) → {external:Promise}
MediaPipeline to which this
MediaObject
belongs. It returns itself when invoked for a
pipeline object.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getMediaPipelineCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getMinOuputBitrate(callbackopt) → {external:Promise}
Minimum video bandwidth for transcoding.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaElement~getMinOuputBitrateCallback |
<optional> |
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#minOutputBitrate instead of this function.
- Source:
Returns:
- Type
- external:Promise
getMinOutputBitrate(callbackopt) → {external:Promise}
Minimum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: 0.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaElement~getMinOutputBitrateCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getName(callbackopt) → {external:Promise}
This
MediaObject
's name.
This is just sugar to simplify developers' life debugging, it is not used internally for indexing nor identifying the objects. By default, it's the object's ID.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getNameCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getParent(callbackopt) → {external:Promise}
Parent of this
MediaObject
.
The parent of a Hub or a MediaElement is its MediaPipeline. A MediaPipeline has no parent, so this property will be null.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getParentCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getSendTagsInEvents(callbackopt) → {external:Promise}
Flag activating or deactivating sending the element's tags in fired events.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getSendTagsInEventsCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
setMaxOuputBitrate(maxOuputBitrate, callbackopt) → {external:Promise}
Maximum video bandwidth for transcoding.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
maxOuputBitrate |
external:Integer | ||
callback |
module:core/abstracts.MediaElement~setMaxOuputBitrateCallback |
<optional> |
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#maxOutputBitrate instead of this function.
- Source:
Returns:
- Type
- external:Promise
setMaxOutputBitrate(maxOutputBitrate, callbackopt) → {external:Promise}
Maximum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: MAXINT.
- 0 = unlimited.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
maxOutputBitrate |
external:Integer | ||
callback |
module:core/abstracts.MediaElement~setMaxOutputBitrateCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
setMinOuputBitrate(minOuputBitrate, callbackopt) → {external:Promise}
Minimum video bandwidth for transcoding.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
minOuputBitrate |
external:Integer | ||
callback |
module:core/abstracts.MediaElement~setMinOuputBitrateCallback |
<optional> |
- Inherited From:
- Deprecated:
- Deprecated due to a typo. Use module:core/abstracts.MediaElement#minOutputBitrate instead of this function.
- Source:
Returns:
- Type
- external:Promise
setMinOutputBitrate(minOutputBitrate, callbackopt) → {external:Promise}
Minimum video bitrate for transcoding.
- Unit: bps (bits per second).
- Default: 0.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
minOutputBitrate |
external:Integer | ||
callback |
module:core/abstracts.MediaElement~setMinOutputBitrateCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
setName(name, callbackopt) → {external:Promise}
This
MediaObject
's name.
This is just sugar to simplify developers' life debugging, it is not used internally for indexing nor identifying the objects. By default, it's the object's ID.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
name |
external:String | ||
callback |
module:core/abstracts.MediaObject~setNameCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
setSendTagsInEvents(sendTagsInEvents, callbackopt) → {external:Promise}
Flag activating or deactivating sending the element's tags in fired events.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
sendTagsInEvents |
external:Boolean | ||
callback |
module:core/abstracts.MediaObject~setSendTagsInEventsCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
Type Definitions
setOverlayedImageCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
unsetOverlayedImageCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |