Constructor
new PlayerEndpoint()
Create a PlayerEndpoint
- Source:
Fires:
Extends
Members
(static) constructorParams
Properties:
Name |
Type |
Attributes |
Description |
mediaPipeline |
module:core.MediaPipeline
|
|
The MediaPipeline this PlayerEndpoint
belongs to. |
networkCache |
external:Integer
|
<optional>
|
RTSP buffer length.
When receiving media from an RTSP source, the streamed video can suffer
spikes
or stuttering, caused by hardware or network issues. Having a reception
buffer
helps alleviate these problems, because it smoothes the stream of incoming
data to the receiving endpoint.
Finding a buffer length that works best for your connection might take
some
tweaking, which can be done with this optional property. Note that a
longer
buffer will be able to fix bigger network spikes, but at the cost of
introducing more latency to the media playback.
- Unit: milliseconds.
- Default: 2000.
|
uri |
external:String
|
|
URI pointing to the video. It has to be accessible to the KMS process.
- Local resources: The user running the Kurento Media
Server must have read permission over the file.
- Remote resources: Must be accessible from the server
where the media server is running.
|
useEncodedMedia |
external:Boolean
|
<optional>
|
Feed the input media as-is to the Media Pipeline, instead of first decoding
it.
When this property is not enabled, the input media gets always
When this property is enabled, the explained behavior gets
disabled. Instead, The endpoint will provide any input media
directly to the Media Pipeline, without prior decoding.
Enabling this mode of operation could have a severe effect on
stability, because lost video keyframes will not be
regenerated; however, avoiding a full cycle of decoding and
encoding can be very useful for certain applications, because
it improves performance by greatly reducing the CPU processing
Keep in mind that if this property is enabled, the original
source media MUST already have an encoding format which is
compatible with the destination target. For example: given a
pipeline which uses this endpoint to read a file and then
streams it to a WebRTC browser such as Chrome, then the file
must already be encoded with a VP8 or H.264 codec profile
which Chrome is able to decode. Note that for this example,
most browsers don't support ANY combination of H.264 encoding
options; instead, they tend to support only a very specific
subset of the codec features (also known as 'profiles').
We strongly recommend to avoid using this option, because
correct behavior cannot be guaranteed.
|
- Source:
(static) events
- Source:
Methods
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:
- Source:
Returns:
-
Type
-
external:Promise
Children of this MediaObject
.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Children of this MediaObject
.
Parameters:
- Inherited From:
- Deprecated:
- Source:
Returns:
-
Type
-
external:Promise
getCreationTime(callbackopt) → {external:Promise}
MediaObject
creation time in seconds since Epoch.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getElementGstreamerDot(callbackopt) → {external:Promise}
Returns the GStreamer DOT string for this element's private pipeline
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
getMaxOuputBitrate(callbackopt) → {external:Promise}
Maximum video bandwidth for transcoding.
Parameters:
- 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:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
MediaPipeline to which this
MediaObject
belongs. It returns itself when invoked for a
pipeline object.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
getMinOuputBitrate(callbackopt) → {external:Promise}
Minimum video bandwidth for transcoding.
Parameters:
- 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:
- Inherited From:
- Source:
Returns:
-
Type
-
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:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Get or set the actual position of the video in ms.
Note Setting
the position only works for seekable videos
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
Flag activating or deactivating sending the element's tags in fired events.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
State of the endpoint
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
The uri for this endpoint.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Returns info about the source being played
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
setMaxOuputBitrate(maxOuputBitrate, callbackopt) → {external:Promise}
Maximum video bandwidth for transcoding.
Parameters:
- 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:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
setMinOuputBitrate(minOuputBitrate, callbackopt) → {external:Promise}
Minimum video bandwidth for transcoding.
Parameters:
- 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:
- Inherited From:
- Source:
Returns:
-
Type
-
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:
- 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
Parameters:
- Source:
Returns:
-
Type
-
external:Promise
Flag activating or deactivating sending the element's tags in fired events.
Parameters:
- Inherited From:
- Source:
Returns:
-
Type
-
external:Promise
Type Definitions
getElementGstreamerDotCallback(error, result)
Parameters:
- Source:
getPositionCallback(error, result)
Parameters:
- Source:
getVideoInfoCallback(error, result)
Parameters:
- Source:
playCallback(error)
Parameters:
- Source:
setPositionCallback(error)
Parameters:
- Source: