Constructor
new AlphaBlending()
Create for the given pipeline
Extends
Members
(static) constructorParams
Properties:
Name | Type | Description |
---|---|---|
mediaPipeline |
module:core.MediaPipeline | the MediaPipeline to which the dispatcher belongs |
(static) events
Methods
(static) setMaster(source, zOrder, callbackopt) → {external:Promise}
Sets the source port that will be the master entry to the mixer
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
source |
module:core.HubPort | The reference to the HubPort setting as master port | |
zOrder |
external:Integer | The order in z to draw the master image | |
callback |
module:elements.AlphaBlending~setMasterCallback |
<optional> |
Returns:
- Type
- external:Promise
(static) setPortProperties(relativeX, relativeY, zOrder, relativeWidth, relativeHeight, port, callbackopt) → {external:Promise}
Configure the blending mode of one port.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
relativeX |
external:Number | The x position relative to the master port. Values from 0 to 1 are accepted. | |
relativeY |
external:Number | The y position relative to the master port. Values from 0 to 1 are accepted. | |
zOrder |
external:Integer | The order in z to draw the images. The greatest value of z is in the top. | |
relativeWidth |
external:Number | The image width relative to the master port width. Values from 0 to 1 are accepted. | |
relativeHeight |
external:Number | The image height relative to the master port height. Values from 0 to 1 are accepted. | |
port |
module:core.HubPort | The reference to the confingured port. | |
callback |
module:elements.AlphaBlending~setPortPropertiesCallback |
<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
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
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
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
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
setMasterCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
setPortPropertiesCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |