Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
kurento-client-elements
Advanced tools
kurento-client-elements - npm Package Compare versions
Comparing version 6.13.0 to 6.14.0
@@ -29,3 +29,3 @@ /* Autogenerated with Kurento Idl */ | ||
| Object.defineProperty(exports, 'name', {value: 'elements'}); | ||
| Object.defineProperty(exports, 'version', {value: '6.13.0'}); | ||
| Object.defineProperty(exports, 'version', {value: '6.14.0'}); | ||
@@ -32,0 +32,0 @@ |
@@ -46,7 +46,6 @@ /* Autogenerated with Kurento Idl */ | ||
| * <p> | ||
| * The recorder can store in local files or in a network resource. It | ||
| * receives a | ||
| * media stream from another {@link module:core/abstracts.MediaElement | ||
| * MediaElement} (i.e. the source), and | ||
| * stores it in the designated location. | ||
| * The Recorder can store media in local files or in a network resource. It | ||
| * receives a media stream from another {@link | ||
| * module:core/abstracts.MediaElement MediaElement} (i.e. the | ||
| * source), and stores it in the designated location. | ||
| * </p> | ||
@@ -59,7 +58,8 @@ * <p> | ||
| * <li> | ||
| * URI of the resource where media will be stored. Following schemas are | ||
| * supported: | ||
| * <strong>Destination URI</strong>, where media will be stored. These | ||
| * formats | ||
| * are supported: | ||
| * <ul> | ||
| * <li> | ||
| * Files: mounted in the local file system. | ||
| * File: A file path that exists in the local file system. | ||
| * <ul> | ||
@@ -70,7 +70,9 @@ * <li><code>file:///path/to/file</code></li> | ||
| * <li> | ||
| * HTTP: Requires the server to support method PUT | ||
| * HTTP: Method PUT used against a remote server. | ||
| * <ul> | ||
| * <li><code>http(s)://{server-ip}/path/to/file</code></li> | ||
| * <li> | ||
| * <code>http(s)://username:password@{server-ip}/path/to/file</code> | ||
| * <code> | ||
| * http(s)://{username}:{password}@{server-ip}/path/to/file | ||
| * </code> | ||
| * </li> | ||
@@ -82,6 +84,5 @@ * </ul> | ||
| * <li> | ||
| * Relative URIs (with no schema) are supported. They are completed | ||
| * prepending | ||
| * a default URI defined by property <i>defaultPath</i>. This property is | ||
| * defined in the configuration file | ||
| * Relative URIs (with no schema) are supported. They are completed by | ||
| * prepending a default URI defined by property <i>defaultPath</i>. This | ||
| * property is defined in the configuration file | ||
| * <i>/etc/kurento/modules/kurento/UriEndpoint.conf.ini</i>, and the | ||
@@ -92,7 +93,6 @@ * default | ||
| * <li> | ||
| * The media profile ({@link | ||
| * module:elements.RecorderEndpoint#MediaProfileSpecType}) used to store | ||
| * the file. | ||
| * This will determine the encoding. See below for more details about media | ||
| * profile. | ||
| * The <stron>Media Profile</stron> ({@link | ||
| * module:elements.RecorderEndpoint#MediaProfileSpecType}) used for | ||
| * storage. This will determine the video and audio encoding. See below for | ||
| * more details about Media Profile. | ||
| * </li> | ||
@@ -102,16 +102,13 @@ * <li> | ||
| * once | ||
| * the EndOfStream event is detected. | ||
| * the <strong>EndOfStream</strong> event is detected. | ||
| * </li> | ||
| * </ul> | ||
| * <p> | ||
| * RecorderEndpoint requires access to the resource where stream is going to | ||
| * be | ||
| * recorded. If it's a local file (<code>file://</code>), the system user | ||
| * running | ||
| * the media server daemon (kurento by default), needs to have write | ||
| * permissions | ||
| * for that URI. If it's an HTTP server, it must be accessible from the | ||
| * machine | ||
| * where media server is running, and also have the correct access rights. | ||
| * Otherwise, the media server won't be able to store any information, and an | ||
| * <strong> | ||
| * RecorderEndpoint requires access to the resource where stream is going | ||
| * to be | ||
| * recorded | ||
| * </strong> | ||
| * . Otherwise, the media server won't be able to store any information, and | ||
| * an | ||
| * {@link ErrorEvent} will be fired. Please note that if you haven't | ||
@@ -122,2 +119,13 @@ * subscribed to | ||
| * </p> | ||
| * <ul> | ||
| * <li> | ||
| * To write local files (if you use <code>file://</code>), the user running | ||
| * media server (by default, user <code>kurento</code>) needs to have write | ||
| * permissions for the requested path. | ||
| * </li> | ||
| * <li> | ||
| * To save into an HTTP server, the server must be accessible through the | ||
| * network, and also have the correct access rights. | ||
| * </li> | ||
| * </ul> | ||
| * <p> | ||
@@ -162,11 +170,18 @@ * The media profile is quite an important parameter, as it will determine | ||
| * <p> | ||
| * Recording will start as soon as the user invokes the record method. The | ||
| * recorder will then store, in the location indicated, the media that the | ||
| * source | ||
| * is sending to the endpoint's sink. If no media is being received, or no | ||
| * endpoint has been connected, then the destination will be empty. The | ||
| * recorder | ||
| * starts storing information into the file as soon as it gets it. | ||
| * Recording will start as soon as the user invokes the | ||
| * <code>record</code> method. The recorder will then store, in the location | ||
| * indicated, the media that the source is sending to the endpoint. If no | ||
| * media | ||
| * is being received, or no endpoint has been connected, then the destination | ||
| * will be empty. The recorder starts storing information into the file as | ||
| * soon | ||
| * as it gets it. | ||
| * </p> | ||
| * <p> | ||
| * Stopping the recording process is done through the | ||
| * <code>stopAndWait</code> method, which will return only after all the | ||
| * information was stored correctly. If the file is empty, this means that no | ||
| * media arrived at the recorder. | ||
| * </p> | ||
| * <p> | ||
| * When another endpoint is connected to the recorder, by default both AUDIO | ||
@@ -193,18 +208,31 @@ * and | ||
| * <p> | ||
| * It is recommended to start recording only after media arrives, either to | ||
| * the | ||
| * endpoint that is the source of the media connected to the recorder, to the | ||
| * recorder itself, or both. Users may use the MediaFlowIn and MediaFlowOut | ||
| * events, and synchronize the recording with the moment media comes in. In | ||
| * any | ||
| * case, nothing will be stored in the file until the first media packets | ||
| * arrive. | ||
| * <strong> | ||
| * It is recommended to start recording only after media arrives | ||
| * </strong> | ||
| * . For this, you may use the <code>MediaFlowInStateChange</code> and | ||
| * <code>MediaFlowOutStateChange</code> | ||
| * events of your endpoints, and synchronize the recording with the moment | ||
| * media | ||
| * comes into the Recorder. For example: | ||
| * </p> | ||
| * <p> | ||
| * Stopping the recording process is done through the stopAndWait method, | ||
| * which | ||
| * will return only after all the information was stored correctly. If the | ||
| * file | ||
| * is empty, this means that no media arrived at the recorder. | ||
| * </p> | ||
| * <ol> | ||
| * <li> | ||
| * When the remote video arrives to KMS, your WebRtcEndpoint will start | ||
| * generating packets into the Kurento Pipeline, and it will trigger a | ||
| * <code>MediaFlowOutStateChange</code> event. | ||
| * </li> | ||
| * <li> | ||
| * When video packets arrive from the WebRtcEndpoint to the | ||
| * RecorderEndpoint, | ||
| * the RecorderEndpoint will raise a <code>MediaFlowInStateChange</code> | ||
| * event. | ||
| * </li> | ||
| * <li> | ||
| * You should only start recording when RecorderEndpoint has notified a | ||
| * <code>MediaFlowInStateChange</code> for ALL streams (so, if you record | ||
| * AUDIO+VIDEO, your application must receive a | ||
| * <code>MediaFlowInStateChange</code> event for audio, and another | ||
| * <code>MediaFlowInStateChange</code> event for video). | ||
| * </li> | ||
| * </ol> | ||
| * | ||
@@ -211,0 +239,0 @@ * @extends module:core/abstracts.UriEndpoint |
@@ -397,21 +397,19 @@ /* Autogenerated with Kurento Idl */ | ||
| /** | ||
| * External (public) IP address of the media server. | ||
| * External IP address of the media server. | ||
| * <p> | ||
| * If you know what will be the external or public IP address of the media | ||
| * server | ||
| * (e.g. because your deployment has an static IP), you can specify it here. | ||
| * Doing so has the advantage of not needing to configure STUN/TURN for the | ||
| * media | ||
| * server. | ||
| * This setting is normally NOT needed. Only use it if you know what you're | ||
| * doing, and understand 100% WHY you want it. For the majority of cases, you | ||
| * should prefer configuring STUN or TURN servers over using this setting. | ||
| * </p> | ||
| * <p> | ||
| * STUN/TURN are needed only when the media server sits behind a NAT and needs | ||
| * find out its own external IP address. However, if you set a static external | ||
| * address with this parameter, then there is no need for the STUN/TURN | ||
| * auto-discovery. | ||
| * This setting implements a hack that will mangle all local ICE candidates so | ||
| * that their candidate address is replaced with the provided external | ||
| * address, | ||
| * even for candidates of type 'host'. In doing so, this KMS will not need a | ||
| * STUN or TURN server, but remote peers will still be able to contact it. | ||
| * </p> | ||
| * <p> | ||
| * The effect of this parameter is that ALL local ICE candidates that are | ||
| * gathered (for WebRTC) will contain the provided external IP address instead | ||
| * the local one. | ||
| * You can try using this setting if KMS is deployed on a publicly accessible | ||
| * server, without NAT, and with a static public IP address. But if it doesn't | ||
| * work for you, just go back to using the STUN or TURN settings above. | ||
| * </p> | ||
@@ -457,21 +455,19 @@ * <p> | ||
| /** | ||
| * External (public) IP address of the media server. | ||
| * External IP address of the media server. | ||
| * <p> | ||
| * If you know what will be the external or public IP address of the media | ||
| * server | ||
| * (e.g. because your deployment has an static IP), you can specify it here. | ||
| * Doing so has the advantage of not needing to configure STUN/TURN for the | ||
| * media | ||
| * server. | ||
| * This setting is normally NOT needed. Only use it if you know what you're | ||
| * doing, and understand 100% WHY you want it. For the majority of cases, you | ||
| * should prefer configuring STUN or TURN servers over using this setting. | ||
| * </p> | ||
| * <p> | ||
| * STUN/TURN are needed only when the media server sits behind a NAT and needs | ||
| * find out its own external IP address. However, if you set a static external | ||
| * address with this parameter, then there is no need for the STUN/TURN | ||
| * auto-discovery. | ||
| * This setting implements a hack that will mangle all local ICE candidates so | ||
| * that their candidate address is replaced with the provided external | ||
| * address, | ||
| * even for candidates of type 'host'. In doing so, this KMS will not need a | ||
| * STUN or TURN server, but remote peers will still be able to contact it. | ||
| * </p> | ||
| * <p> | ||
| * The effect of this parameter is that ALL local ICE candidates that are | ||
| * gathered (for WebRTC) will contain the provided external IP address instead | ||
| * the local one. | ||
| * You can try using this setting if KMS is deployed on a publicly accessible | ||
| * server, without NAT, and with a static public IP address. But if it doesn't | ||
| * work for you, just go back to using the STUN or TURN settings above. | ||
| * </p> | ||
@@ -478,0 +474,0 @@ * <p> |
| { | ||
| "name": "kurento-client-elements", | ||
| "version": "6.13.0", | ||
| "version": "6.14.0", | ||
| "description": "JavaScript Client API for Kurento Media Server", | ||
@@ -5,0 +5,0 @@ "repository": { |
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.97%
221301
- Lines of code
- increased by0.55%
4936
No dependency changes