mirror of https://github.com/OpenVidu/openvidu.git
Library doc links to docs.openvidu.io
pabloFuente
parent
30d76c5a90
commit
68dfd4414a
|
|
@ -216,12 +216,12 @@ export class OpenVidu {
|
|||
* The [[Publisher]] object will dispatch an `accessAllowed` or `accessDenied` event once it has been granted access to the requested input devices or not.
|
||||
*
|
||||
* The [[Publisher]] object will dispatch a `videoElementCreated` event once a HTML video element has been added to DOM (only if you
|
||||
* [let OpenVidu take care of the video players](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)). See [[VideoElementEvent]] to learn more.
|
||||
* [let OpenVidu take care of the video players](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)). See [[VideoElementEvent]] to learn more.
|
||||
*
|
||||
* The [[Publisher]] object will dispatch a `streamPlaying` event once the local streams starts playing. See [[StreamManagerEvent]] to learn more.
|
||||
*
|
||||
* @param targetElement HTML DOM element (or its `id` attribute) in which the video element of the Publisher will be inserted (see [[PublisherProperties.insertMode]]). If *null* or *undefined* no default video will be created for this Publisher.
|
||||
* You can always call method [[Publisher.addVideoElement]] or [[Publisher.createVideoElement]] to manage the video elements on your own (see [Manage video players](/docs/how-do-i/manage-videos) section)
|
||||
* You can always call method [[Publisher.addVideoElement]] or [[Publisher.createVideoElement]] to manage the video elements on your own (see [Manage video players](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos) section)
|
||||
* @param completionHandler `error` parameter is null if `initPublisher` succeeds, and is defined if it fails.
|
||||
* `completionHandler` function is called before the Publisher dispatches an `accessAllowed` or an `accessDenied` event
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -200,20 +200,20 @@ export class Session implements EventDispatcher {
|
|||
*
|
||||
* The [[Session]] object of the local participant will dispatch a `sessionDisconnected` event.
|
||||
* This event will automatically unsubscribe the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
* and also deletes any HTML video element associated to each Subscriber (only those [created by OpenVidu Browser](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* and also deletes any HTML video element associated to each Subscriber (only those [created by OpenVidu Browser](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* For every video removed, each Subscriber object will dispatch a `videoElementDestroyed` event.
|
||||
* Call `event.preventDefault()` upon event `sessionDisconnected` to avoid this behavior and take care of disposing and cleaning all the Subscriber objects yourself.
|
||||
* See [[SessionDisconnectedEvent]] and [[VideoElementEvent]] to learn more to learn more.
|
||||
*
|
||||
* The [[Publisher]] object of the local participant will dispatch a `streamDestroyed` event if there is a [[Publisher]] object publishing to the session.
|
||||
* This event will automatically stop all media tracks and delete any HTML video element associated to it (only those [created by OpenVidu Browser](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* This event will automatically stop all media tracks and delete any HTML video element associated to it (only those [created by OpenVidu Browser](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* For every video removed, the Publisher object will dispatch a `videoElementDestroyed` event.
|
||||
* Call `event.preventDefault()` upon event `streamDestroyed` if you want to clean the Publisher object on your own or re-publish it in a different Session (to do so it is a mandatory requirement to call `Session.unpublish()`
|
||||
* or/and `Session.disconnect()` in the previous session). See [[StreamEvent]] and [[VideoElementEvent]] to learn more.
|
||||
*
|
||||
* The [[Session]] object of every other participant connected to the session will dispatch a `streamDestroyed` event if the disconnected participant was publishing.
|
||||
* This event will automatically unsubscribe the Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
* and also deletes any HTML video element associated to that Subscriber (only those [created by OpenVidu Browser](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* and also deletes any HTML video element associated to that Subscriber (only those [created by OpenVidu Browser](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* For every video removed, the Subscriber object will dispatch a `videoElementDestroyed` event.
|
||||
* Call `event.preventDefault()` upon event `streamDestroyed` to avoid this default behavior and take care of disposing and cleaning the Subscriber object yourself.
|
||||
* See [[StreamEvent]] and [[VideoElementEvent]] to learn more.
|
||||
|
|
@ -235,13 +235,13 @@ export class Session implements EventDispatcher {
|
|||
* #### Events dispatched
|
||||
*
|
||||
* The [[Subscriber]] object will dispatch a `videoElementCreated` event once the HTML video element has been added to DOM (only if you
|
||||
* [let OpenVidu take care of the video players](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)). See [[VideoElementEvent]] to learn more.
|
||||
* [let OpenVidu take care of the video players](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)). See [[VideoElementEvent]] to learn more.
|
||||
*
|
||||
* The [[Subscriber]] object will dispatch a `streamPlaying` event once the remote stream starts playing. See [[StreamManagerEvent]] to learn more.
|
||||
*
|
||||
* @param stream Stream object to subscribe to
|
||||
* @param targetElement HTML DOM element (or its `id` attribute) in which the video element of the Subscriber will be inserted (see [[SubscriberProperties.insertMode]]). If *null* or *undefined* no default video will be created for this Subscriber.
|
||||
* You can always call method [[Subscriber.addVideoElement]] or [[Subscriber.createVideoElement]] to manage the video elements on your own (see [Manage video players](/docs/how-do-i/manage-videos) section)
|
||||
* You can always call method [[Subscriber.addVideoElement]] or [[Subscriber.createVideoElement]] to manage the video elements on your own (see [Manage video players](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos) section)
|
||||
* @param completionHandler `error` parameter is null if `subscribe` succeeds, and is defined if it fails.
|
||||
*/
|
||||
subscribe(stream: Stream, targetElement: string | HTMLElement, param3?: ((error: Error | undefined) => void) | SubscriberProperties, param4?: ((error: Error | undefined) => void)): Subscriber {
|
||||
|
|
@ -324,7 +324,7 @@ export class Session implements EventDispatcher {
|
|||
* #### Events dispatched
|
||||
*
|
||||
* The [[Subscriber]] object will dispatch a `videoElementDestroyed` event for each video associated to it that was removed from DOM.
|
||||
* Only videos [created by OpenVidu Browser](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)) will be automatically removed
|
||||
* Only videos [created by OpenVidu Browser](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)) will be automatically removed
|
||||
*
|
||||
* See [[VideoElementEvent]] to learn more
|
||||
*/
|
||||
|
|
@ -406,13 +406,13 @@ export class Session implements EventDispatcher {
|
|||
*
|
||||
* The [[Publisher]] object of the local participant will dispatch a `streamDestroyed` event.
|
||||
* This event will automatically stop all media tracks and delete any HTML video element associated to this Publisher
|
||||
* (only those videos [created by OpenVidu Browser](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* (only those videos [created by OpenVidu Browser](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* For every video removed, the Publisher object will dispatch a `videoElementDestroyed` event.
|
||||
* Call `event.preventDefault()` upon event `streamDestroyed` if you want to clean the Publisher object on your own or re-publish it in a different Session.
|
||||
*
|
||||
* The [[Session]] object of every other participant connected to the session will dispatch a `streamDestroyed` event.
|
||||
* This event will automatically unsubscribe the Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and
|
||||
* delete any HTML video element associated to it (only those [created by OpenVidu Browser](/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* delete any HTML video element associated to it (only those [created by OpenVidu Browser](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#let-openvidu-take-care-of-the-video-players)).
|
||||
* For every video removed, the Subscriber object will dispatch a `videoElementDestroyed` event.
|
||||
* Call `event.preventDefault()` upon event `streamDestroyed` to avoid this default behavior and take care of disposing and cleaning the Subscriber object on your own.
|
||||
*
|
||||
|
|
|
|||
|
|
@ -234,7 +234,7 @@ export class StreamManager implements EventDispatcher {
|
|||
|
||||
/**
|
||||
* Makes `video` element parameter display this [[stream]]. This is useful when you are
|
||||
* [managing the video elements on your own](/docs/how-do-i/manage-videos/#you-take-care-of-the-video-players)
|
||||
* [managing the video elements on your own](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos/#you-take-care-of-the-video-players)
|
||||
*
|
||||
* Calling this method with a video already added to other Publisher/Subscriber will cause the video element to be
|
||||
* disassociated from that previous Publisher/Subscriber and to be associated to this one.
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ export class RecordingEvent extends Event {
|
|||
* For 'recordingStopped' event:
|
||||
* - "recordingStoppedByServer": the recording has been gracefully stopped by the application
|
||||
* - "sessionClosedByServer": the Session has been closed by the application
|
||||
* - "automaticStop": see [Automatic stop of recordings](https://openvidu.io/docs/advanced-features/recording/#automatic-stop-of-recordings)
|
||||
* - "automaticStop": see [Automatic stop of recordings](https://docs.openvidu.io/en/stable/advanced-features/recording/#automatic-stop-of-recordings)
|
||||
* - "mediaServerDisconnect": OpenVidu Media Node has crashed or lost its connection. A new Media Node instance is active and the recording has been stopped (no media streams are available in the new Media Node)
|
||||
*
|
||||
* For 'recordingStarted' empty string
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ import { StreamManager } from '../../OpenVidu/StreamManager';
|
|||
/**
|
||||
* Defines the following events:
|
||||
* - `videoElementCreated`: dispatched by [[Publisher]] and [[Subscriber]] whenever a new HTML video element has been inserted into DOM by OpenVidu Browser library. See
|
||||
* [Manage video players](/docs/how-do-i/manage-videos) section.
|
||||
* [Manage video players](https://docs.openvidu.io/en/stable/cheatsheet/manage-videos) section.
|
||||
* - `videoElementDestroyed`: dispatched by [[Publisher]] and [[Subscriber]] whenever an HTML video element has been removed from DOM by OpenVidu Browser library.
|
||||
*/
|
||||
export class VideoElementEvent extends Event {
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ public class Connection {
|
|||
}
|
||||
|
||||
/**
|
||||
* <a href="/docs/openvidu-pro/" target="_blank" style="display: inline-block;
|
||||
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block;
|
||||
* background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding:
|
||||
* 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px;
|
||||
* line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
|
||||
|
|
|
|||
|
|
@ -108,7 +108,7 @@ public class KurentoOptions {
|
|||
* Defines the maximum number of Kbps that the client owning the token will be
|
||||
* able to receive from Kurento Media Server. 0 means unconstrained. Giving a
|
||||
* value to this property will override the global configuration set in <a href=
|
||||
* "https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* target="_blank">OpenVidu Server configuration</a> (parameter
|
||||
* <code>openvidu.streams.video.max-recv-bandwidth</code>) for every incoming
|
||||
* stream of the user owning the token. <br>
|
||||
|
|
@ -125,7 +125,7 @@ public class KurentoOptions {
|
|||
* Defines the minimum number of Kbps that the client owning the token will try
|
||||
* to receive from Kurento Media Server. 0 means unconstrained. Giving a value
|
||||
* to this property will override the global configuration set in <a href=
|
||||
* "https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* target="_blank">OpenVidu Server configuration</a> (parameter
|
||||
* <code>openvidu.streams.video.min-recv-bandwidth</code>) for every incoming
|
||||
* stream of the user owning the token.
|
||||
|
|
@ -138,7 +138,7 @@ public class KurentoOptions {
|
|||
* Defines the maximum number of Kbps that the client owning the token will be
|
||||
* able to send to Kurento Media Server. 0 means unconstrained. Giving a value
|
||||
* to this property will override the global configuration set in <a href=
|
||||
* "https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* target="_blank">OpenVidu Server configuration</a> (parameter
|
||||
* <code>openvidu.streams.video.max-send-bandwidth</code>) for every outgoing
|
||||
* stream of the user owning the token. <br>
|
||||
|
|
@ -154,7 +154,7 @@ public class KurentoOptions {
|
|||
* Defines the minimum number of Kbps that the client owning the token will try
|
||||
* to send to Kurento Media Server. 0 means unconstrained. Giving a value to
|
||||
* this property will override the global configuration set in <a href=
|
||||
* "https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* "https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server"
|
||||
* target="_blank">OpenVidu Server configuration</a> (parameter
|
||||
* <code>openvidu.streams.video.min-send-bandwidth</code>) for every outgoing
|
||||
* stream of the user owning the token.
|
||||
|
|
@ -166,7 +166,7 @@ public class KurentoOptions {
|
|||
/**
|
||||
* Defines the names of the filters the user owning the token will be able to
|
||||
* apply. See
|
||||
* <a href="https://openvidu.io/docs/advanced-features/filters/" target=
|
||||
* <a href="https://docs.openvidu.io/en/stable/advanced-features/filters/" target=
|
||||
* "_blank">Voice and video filters</a>
|
||||
*/
|
||||
public String[] getAllowedFilters() {
|
||||
|
|
|
|||
|
|
@ -195,7 +195,7 @@ public class Recording {
|
|||
/**
|
||||
* URL of the recording. You can access the file from there. It is
|
||||
* <code>null</code> until recording reaches "ready" or "failed" status. If
|
||||
* <a href="https://openvidu.io/docs/reference-docs/openvidu-server-params/"
|
||||
* <a href="https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/"
|
||||
* target="_blank">OpenVidu Server configuration</a> property
|
||||
* <code>openvidu.recording.public-access</code> is false, this path will be
|
||||
* secured with OpenVidu credentials
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ public enum RecordingLayout {
|
|||
|
||||
/**
|
||||
* Use your own custom recording layout. See <a href=
|
||||
* "https://openvidu.io/docs/advanced-features/recording#custom-recording-layouts"
|
||||
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* target="_blank">Custom recording layouts</a> to learn more
|
||||
*/
|
||||
CUSTOM
|
||||
|
|
|
|||
|
|
@ -103,7 +103,7 @@ public class RecordingProperties {
|
|||
* has been called with value
|
||||
* {@link io.openvidu.java.client.Recording.OutputMode#COMPOSED}.<br>
|
||||
* See <a href=
|
||||
* "https://openvidu.io/docs/advanced-features/recording#custom-recording-layouts"
|
||||
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* target="_blank">Custom recording layouts</a> to learn more
|
||||
*/
|
||||
public RecordingProperties.Builder customLayout(String path) {
|
||||
|
|
@ -198,7 +198,7 @@ public class RecordingProperties {
|
|||
* set to {@link io.openvidu.java.client.RecordingLayout#CUSTOM}, this property
|
||||
* defines the relative path to the specific custom layout you want to use.<br>
|
||||
* See <a href=
|
||||
* "https://openvidu.io/docs/advanced-features/recording#custom-recording-layouts"
|
||||
* "https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts"
|
||||
* target="_blank">Custom recording layouts</a> to learn more
|
||||
*/
|
||||
public String customLayout() {
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ export class Connection {
|
|||
token: string;
|
||||
|
||||
/**
|
||||
* <a href="/docs/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
|
||||
* <a href="https://docs.openvidu.io/en/stable/openvidu-pro/" target="_blank" style="display: inline-block; background-color: rgb(0, 136, 170); color: white; font-weight: bold; padding: 0px 5px; margin-right: 5px; border-radius: 3px; font-size: 13px; line-height:21px; font-family: Montserrat, sans-serif">PRO</a>
|
||||
* Geo location of the connection, with the following format: `"CITY, COUNTRY"` (`"unknown"` if it wasn't possible to locate it)
|
||||
*/
|
||||
location: string;
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ export enum RecordingLayout {
|
|||
HORIZONTAL_PRESENTATION = 'VERTICAL_PRESENTATION',
|
||||
|
||||
/**
|
||||
* Use your own custom recording layout. See [Custom recording layouts](/docs/advanced-features/recording#custom-recording-layouts) to learn more
|
||||
* Use your own custom recording layout. See [Custom recording layouts](https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts) to learn more
|
||||
*/
|
||||
CUSTOM = 'CUSTOM'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ export interface RecordingProperties {
|
|||
/**
|
||||
* The relative path to the specific custom layout you want to use.<br>
|
||||
* Will only have effect if [[RecordingProperties.outputMode]] is `COMPOSED` and [[RecordingProperties.recordingLayout]] is `CUSTOM`<br>
|
||||
* See [Custom recording layouts](https://openvidu.io/docs/advanced-features/recording#custom-recording-layouts) to learn more
|
||||
* See [Custom recording layouts](https://docs.openvidu.io/en/stable/advanced-features/recording#custom-recording-layouts) to learn more
|
||||
*/
|
||||
customLayout?: string;
|
||||
|
||||
|
|
|
|||
|
|
@ -41,20 +41,20 @@ export interface TokenOptions {
|
|||
* Some advanced properties setting the configuration that the WebRTC streams of the user owning the token will have in Kurento Media Server.
|
||||
* You can adjust:
|
||||
* - `videoMaxRecvBandwidth`: maximum number of Kbps that the client owning the token will be able to receive from Kurento Media Server. 0 means unconstrained. Giving a value to this property will override
|
||||
* the global configuration set in [OpenVidu Server configuration](https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* the global configuration set in [OpenVidu Server configuration](https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* (parameter `openvidu.streams.video.max-recv-bandwidth`) for every incoming stream of the user owning the token.
|
||||
* _**WARNING**: the lower value set to this property limits every other bandwidth of the WebRTC pipeline this server-to-client stream belongs to. This includes the user publishing the stream and every other user subscribed to the stream_
|
||||
* - `videoMinRecvBandwidth`: minimum number of Kbps that the client owning the token will try to receive from Kurento Media Server. 0 means unconstrained. Giving a value to this property will override
|
||||
* the global configuration set in [OpenVidu Server configuration](https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* the global configuration set in [OpenVidu Server configuration](https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* (parameter `openvidu.streams.video.min-recv-bandwidth`) for every incoming stream of the user owning the token
|
||||
* - `videoMaxSendBandwidth`: maximum number of Kbps that the client owning the token will be able to send to Kurento Media Server. 0 means unconstrained. Giving a value to this property will override
|
||||
* the global configuration set in [OpenVidu Server configuration](https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* the global configuration set in [OpenVidu Server configuration](https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* (parameter `openvidu.streams.video.max-send-bandwidth`) for every outgoing stream of the user owning the token.
|
||||
* _**WARNING**: this value limits every other bandwidth of the WebRTC pipeline this client-to-server stream belongs to. This includes every other user subscribed to the stream_
|
||||
* - `videoMinSendBandwidth`: minimum number of Kbps that the client owning the token will try to send to Kurento Media Server. 0 means unconstrained. Giving a value to this property will override
|
||||
* the global configuration set in [OpenVidu Server configuration](https://openvidu.io/docs/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* the global configuration set in [OpenVidu Server configuration](https://docs.openvidu.io/en/stable/reference-docs/openvidu-server-params/#configuration-parameters-for-openvidu-server)
|
||||
* (parameter `openvidu.streams.video.min-send-bandwidth`) for every outgoing stream of the user owning the token
|
||||
* - `allowedFilters`: names of the filters the user owning the token will be able to apply. See [Voice and video filters](https://openvidu.io/docs/advanced-features/filters/)
|
||||
* - `allowedFilters`: names of the filters the user owning the token will be able to apply. See [Voice and video filters](https://docs.openvidu.io/en/stable/advanced-features/filters/)
|
||||
*/
|
||||
kurentoOptions?: {
|
||||
videoMaxRecvBandwidth?: number,
|
||||
|
|
|
|||
Loading…
Reference in New Issue