Constructor
new PlayerEndpoint()
Create a PlayerEndpoint
Fires:
Extends
Members
(static) constructorParams
Properties:
Name | Type | Attributes | Description |
---|---|---|---|
mediaPipeline |
module:core.MediaPipeline | The MediaPipeline this PlayerEndpoint belongs to. | |
networkCache |
external:Integer |
<optional> |
When using rtsp sources. Amount of ms to buffer |
uri |
external:String | URI pointing to the video. It has to be accessible to the KMS process.
|
|
useEncodedMedia |
external:Boolean |
<optional> |
use encoded instead of raw media. If the parameter is false then the element |
(static) events
Methods
(static) play(callbackopt) → {external:Promise}
Starts reproducing the media, sending it to the :rom:cls:`MediaSource`. If
the endpoint
has been connected to other endpoints, those will start receiving
media.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:elements.PlayerEndpoint~playCallback |
<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}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getChildsCallback |
<optional> |
- Inherited From:
- Deprecated:
- (Use children instead) children of this
MediaObject
.
- (Use children instead) children of this
- 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}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaElement~getMaxOuputBitrateCallback |
<optional> |
- 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:
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}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaElement~getMinOuputBitrateCallback |
<optional> |
- 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:
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 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:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getNameCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getParent(callbackopt) → {external:Promise}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.MediaObject~getParentCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getPosition(callbackopt) → {external:Promise
Get or set the actual position of the video in ms.
Note Setting the position only works for seekable videos
Note Setting the position only works for seekable videos
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:elements.PlayerEndpoint~getPositionCallback |
<optional> |
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
getState(callbackopt) → {external:Promise}
State of the endpoint
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.UriEndpoint~getStateCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getUri(callbackopt) → {external:Promise}
The uri for this endpoint.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:core/abstracts.UriEndpoint~getUriCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
getVideoInfo(callbackopt) → {external:Promise}
Returns info about the source being played
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
callback |
module:elements.PlayerEndpoint~getVideoInfoCallback |
<optional> |
Returns:
- Type
- external:Promise
setMaxOuputBitrate(maxOuputBitrate, callbackopt) → {external:Promise}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
maxOuputBitrate |
external:Integer | ||
callback |
module:core/abstracts.MediaElement~setMaxOuputBitrateCallback |
<optional> |
- 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:
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}
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
minOuputBitrate |
external:Integer | ||
callback |
module:core/abstracts.MediaElement~setMinOuputBitrateCallback |
<optional> |
- 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:
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 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:
Name | Type | Attributes | Description |
---|---|---|---|
name |
external:String | ||
callback |
module:core/abstracts.MediaObject~setNameCallback |
<optional> |
- Inherited From:
- Source:
Returns:
- Type
- external:Promise
setPosition(position, callbackopt) → {external:Promise}
Get or set the actual position of the video in ms.
Note Setting the position only works for seekable videos
Note Setting the position only works for seekable videos
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
position |
external:int64 | ||
callback |
module:elements.PlayerEndpoint~setPositionCallback |
<optional> |
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
getPositionCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
external:int64 |
getVideoInfoCallback(error, result)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error | |
result |
module:elements/complexTypes.VideoInfo |
playCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |
setPositionCallback(error)
Parameters:
Name | Type | Description |
---|---|---|
error |
external:Error |