Constructor
new ImageOverlayFilter()
ImageOverlayFilter interface. This type of Filter draws an image in a configured position
over a video feed.
Extends
Members
(static) constructorParams
Properties:
Name | Type | Description |
---|---|---|
mediaPipeline |
module:core.MediaPipeline | pipeline to which this Filter belongs |
(static) events
Methods
(static) addImage(id, uri, offsetXPercent, offsetYPercent, widthPercent, heightPercent, keepAspectRatio, center, callbackopt) → {external:Promise}
Add an image to be used as overlay.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
id |
external:String | image ID | |
uri |
external:String | URI where the image is located | |
offsetXPercent |
external:Number | Percentage relative to the image width to calculate the X coordinate of the position (left upper corner) [0..1] | |
offsetYPercent |
external:Number | Percentage relative to the image height to calculate the Y coordinate of the | |
widthPercent |
external:Number | Proportional width of the overlaid image, relative to the width of the video | |
heightPercent |
external:Number | Proportional height of the overlaid image, relative to the height of the video [0..1]. | |
keepAspectRatio |
external:Boolean | Keep the aspect ratio of the original image. | |
center |
external:Boolean | If the image doesn't fit in the dimensions, the image will be center into the region defined by height and width. | |
callback |
module:filters.ImageOverlayFilter~addImageCallback |
<optional> |
Returns:
- Type
- external:Promise
(static) removeImage(id, callbackopt) → {external:Promise}
Remove the image with the given ID.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
id |
external:String | Image ID to be removed | |
callback |
module:filters.ImageOverlayFilter~removeImageCallback |
<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
addImageCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
removeImageCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |