openvidu/openvidu-browser/lib/OpenViduInternal/Interfaces/Public/OpenViduAdvancedConfigurati...

22 lines
1.5 KiB
TypeScript
Raw Normal View History

2018-06-27 16:29:31 +02:00
/**
* See [[OpenVidu.setAdvancedConfiguration]]
*/
2018-04-26 15:33:47 +02:00
export interface OpenViduAdvancedConfiguration {
/**
2018-06-27 16:29:31 +02:00
* Array of [RTCIceServer](https://developer.mozilla.org/en-US/docs/Web/API/RTCIceServer) to be used by OpenVidu Browser. By default OpenVidu will generate the required credentials to use the COTURN server hosted along OpenVidu Server
* You can also set this property to string 'freeice' to force the use of free STUN servers instead (got thanks to [freeice](https://github.com/DamonOehlman/freeice) library).
2018-04-26 15:33:47 +02:00
*/
2018-06-27 16:29:31 +02:00
iceServers?: RTCIceServer[] | string;
2018-04-26 15:33:47 +02:00
/**
* URL to a custom screen share extension for Chrome (always based on ours: [openvidu-screen-sharing-chrome-extension](https://github.com/OpenVidu/openvidu-screen-sharing-chrome-extension)) to be used instead of the default one.
* Must be something like this: `https://chrome.google.com/webstore/detail/YOUR_WEBSTORE_EXTENSION_NAME/YOUR_EXTENSION_ID`
*/
screenShareChromeExtension?: string;
/**
* Custom configuration for the [[PublisherSpeakingEvent]] feature. It is an object which includes the following optional properties:
* - `interval`: (number) how frequently the analyser polls the audio stream to check if speaking has started or stopped. Default **50** (ms)
* - `threshold`: (number) the volume at which _publisherStartSpeaking_ and _publisherStopSpeaking_ events will be fired. Default **-50** (dB)
*/
publisherSpeakingEventsOptions?: any;
}