Constructor
new Mixer()
Create a Mixer belonging to the given pipeline.
Extends
Members
(static) constructorParams
Properties:
Name | Type | Description |
---|---|---|
mediaPipeline |
module:core.MediaPipeline | the MediaPipeline to which the Mixer belongs |
(static) events
Methods
(static) connect(media, source, sink, callbackopt) → {external:Promise}
Connects each corresponding MediaType of the given source port with
the sink port.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
media |
external:MediaType | The sort of media stream to be connected | |
source |
module:core.HubPort | Source port to be connected | |
sink |
module:core.HubPort | Sink port to be connected | |
callback |
module:elements.Mixer~connectCallback |
<optional> |
Returns:
- Type
- external:Promise
(static) disconnect(media, source, sink, callbackopt) → {external:Promise}
Disonnects each corresponding MediaType of the given source port from
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
media |
external:MediaType | The sort of media stream to be disconnected | |
source |
module:core.HubPort | Audio source port to be disconnected | |
sink |
module:core.HubPort | Audio sink port to be disconnected | |
callback |
module:elements.Mixer~disconnectCallback |
<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
connectCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
disconnectCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |