ngx-agora
Version:
Angular wrapper for Agora RTC client (https://www.agora.io/en/)
98 lines • 10.6 kB
JavaScript
/**
* @fileoverview added by tsickle
* Generated from: lib/data/models/client-config.model.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* A class defining the properties of the config parameter in the
* [createClient](https://docs.agora.io/en/Video/API%20Reference/web/globals.html#createclient) method.
*
* \@remark
* - Ensure that you do not leave mode and codec as empty.
* - Ensure that you set these properties before calling Client.join.
*
* Define [proxyServer](https://docs.agora.io/en/Video/API%20Reference/web/interfaces/agorartc.clientconfig.html#proxyserver) and
* [turnServer](https://docs.agora.io/en/Video/API%20Reference/web/interfaces/agorartc.clientconfig.html#turnserver)
* if you need to set a proxy server. For a tutorial on deploying the Proxy server on a Web client, see
* [Deploy the Enterprise Proxy](https://docs.agora.io/en/Video/proxy_web).
*
* Proxy services by different service providers may result in slow performance if you are using the Firefox browser.
* Therefore, Agora recommends using the same service provider for the proxy services.
* If you use different service providers, Agora recommends not using the Firefox browser.
*
* \@example
* import { ClientConfig } from 'ngx-agora';
*
* const config: ClientConfig = {
* mode: "live",
* codec: "vp8",
* proxyServer: "YOUR NGINX PROXY SERVER IP",
* turnServer: {
* turnServerURL: "YOUR TURNSERVER URL",
* username: "YOUR USERNAME",
* password: "YOUR PASSWORD",
* udpport: "THE UDP PORT YOU WANT TO ADD",
* tcpport: "THE TCP PORT YOU WANT TO ADD",
* forceturn: false
* }
* }
* this.ngxAgoraService.createClient(config);
* @record
*/
export function ClientConfig() { }
if (false) {
/**
* The codec the Web browser uses for encoding and decoding.
* - `'vp8'`: Sets the browser to use VP8 for encoding and decoding.
* - `'h264'`: Sets the browser to use H264 for encoding and decoding.
*
* \@remark
* Set codec as "h264" as long as Safari is involved in the session.
* @type {?}
*/
ClientConfig.prototype.codec;
/**
* The channel profile.
*
* Agora Web SDK needs to know the application scenario to apply different optimization methods.
*
* Currently Agora Web SDK supports the following channel profiles:
* - "live": Sets the channel profile as live broadcast.
* Host and audience roles that can be set by calling the
* [Client.setClientRole](https://docs.agora.io/en/Video/API%20Reference/web/interfaces/agorartc.client.html#setclientrole) method.
* The host sends and receives voice/video, while the audience can only receive voice/video.
* - "rtc": Sets the channel profile as communication. This is used in one-on-one calls or group calls,
* where all users in the channel can talk freely.
*
* \@remark
* If you need to communicate with Agora Native SDK, Agora recommends the following settings:
* - For Native SDK v2.3.2 and later:
* Set [mode](https://docs.agora.io/en/Video/API%20Reference/web/interfaces/agorartc.clientconfig.html#mode)
* as "rtc" or "live" if the Native SDK uses the communication channel profile.
* Set [mode](https://docs.agora.io/en/Video/API%20Reference/web/interfaces/agorartc.clientconfig.html#mode)
* as "live" if the Native SDK uses the live broadcast channel profile.
* - For Native SDK before v2.3.2, set mode as "live" regardless of which channel profile the Native SDK uses.
*
* If you set [mode](https://docs.agora.io/en/Video/API%20Reference/web/interfaces/agorartc.clientconfig.html#mode)
* as "rtc", the Agora Recording SDK is not supported.
* @type {?}
*/
ClientConfig.prototype.mode;
/**
* Your Nginx server domain name.
*
* ASCII characters only, and the string length must be greater than 0 and less than 256 bytes.
* Enterprise users with a company firewall can use this property to pass signaling messages to the Agora SD-RTN through the Nginx Server.
* @type {?|undefined}
*/
ClientConfig.prototype.proxyServer;
/**
* TURN server settings.
*
* Enterprise users with a company firewall can use this property to pass audio and video data to the Agora SD-RTN through
* the TURN Server.
* @type {?|undefined}
*/
ClientConfig.prototype.turnServer;
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpZW50LWNvbmZpZy5tb2RlbC5qcyIsInNvdXJjZVJvb3QiOiJuZzovL25neC1hZ29yYS8iLCJzb3VyY2VzIjpbImxpYi9kYXRhL21vZGVscy9jbGllbnQtY29uZmlnLm1vZGVsLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBcUNBLGtDQWtEQzs7Ozs7Ozs7Ozs7SUF6Q0MsNkJBQXNCOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7SUEwQnRCLDRCQUFxQjs7Ozs7Ozs7SUFPckIsbUNBQXFCOzs7Ozs7OztJQU9yQixrQ0FBd0IiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyBUdXJuU2VydmVyIH0gZnJvbSAnLi90dXJuLXNlcnZlci5tb2RlbCc7XG5cbi8qKlxuICogQSBjbGFzcyBkZWZpbmluZyB0aGUgcHJvcGVydGllcyBvZiB0aGUgY29uZmlnIHBhcmFtZXRlciBpbiB0aGVcbiAqIFtjcmVhdGVDbGllbnRdKGh0dHBzOi8vZG9jcy5hZ29yYS5pby9lbi9WaWRlby9BUEklMjBSZWZlcmVuY2Uvd2ViL2dsb2JhbHMuaHRtbCNjcmVhdGVjbGllbnQpIG1ldGhvZC5cbiAqXG4gKiBAcmVtYXJrXG4gKiAtIEVuc3VyZSB0aGF0IHlvdSBkbyBub3QgbGVhdmUgbW9kZSBhbmQgY29kZWMgYXMgZW1wdHkuXG4gKiAtIEVuc3VyZSB0aGF0IHlvdSBzZXQgdGhlc2UgcHJvcGVydGllcyBiZWZvcmUgY2FsbGluZyBDbGllbnQuam9pbi5cbiAqXG4gKiBEZWZpbmUgW3Byb3h5U2VydmVyXShodHRwczovL2RvY3MuYWdvcmEuaW8vZW4vVmlkZW8vQVBJJTIwUmVmZXJlbmNlL3dlYi9pbnRlcmZhY2VzL2Fnb3JhcnRjLmNsaWVudGNvbmZpZy5odG1sI3Byb3h5c2VydmVyKSBhbmRcbiAqIFt0dXJuU2VydmVyXShodHRwczovL2RvY3MuYWdvcmEuaW8vZW4vVmlkZW8vQVBJJTIwUmVmZXJlbmNlL3dlYi9pbnRlcmZhY2VzL2Fnb3JhcnRjLmNsaWVudGNvbmZpZy5odG1sI3R1cm5zZXJ2ZXIpXG4gKiBpZiB5b3UgbmVlZCB0byBzZXQgYSBwcm94eSBzZXJ2ZXIuIEZvciBhIHR1dG9yaWFsIG9uIGRlcGxveWluZyB0aGUgUHJveHkgc2VydmVyIG9uIGEgV2ViIGNsaWVudCwgc2VlXG4gKiBbRGVwbG95IHRoZSBFbnRlcnByaXNlIFByb3h5XShodHRwczovL2RvY3MuYWdvcmEuaW8vZW4vVmlkZW8vcHJveHlfd2ViKS5cbiAqXG4gKiBQcm94eSBzZXJ2aWNlcyBieSBkaWZmZXJlbnQgc2VydmljZSBwcm92aWRlcnMgbWF5IHJlc3VsdCBpbiBzbG93IHBlcmZvcm1hbmNlIGlmIHlvdSBhcmUgdXNpbmcgdGhlIEZpcmVmb3ggYnJvd3Nlci5cbiAqIFRoZXJlZm9yZSwgQWdvcmEgcmVjb21tZW5kcyB1c2luZyB0aGUgc2FtZSBzZXJ2aWNlIHByb3ZpZGVyIGZvciB0aGUgcHJveHkgc2VydmljZXMuXG4gKiBJZiB5b3UgdXNlIGRpZmZlcmVudCBzZXJ2aWNlIHByb3ZpZGVycywgQWdvcmEgcmVjb21tZW5kcyBub3QgdXNpbmcgdGhlIEZpcmVmb3ggYnJvd3Nlci5cbiAqXG4gKiBAZXhhbXBsZVxuICogaW1wb3J0IHsgQ2xpZW50Q29uZmlnIH0gZnJvbSAnbmd4LWFnb3JhJztcbiAqXG4gKiBjb25zdCBjb25maWc6IENsaWVudENvbmZpZyA9IHtcbiAqICAgbW9kZTogXCJsaXZlXCIsXG4gKiAgIGNvZGVjOiBcInZwOFwiLFxuICogICBwcm94eVNlcnZlcjogXCJZT1VSIE5HSU5YIFBST1hZIFNFUlZFUiBJUFwiLFxuICogICB0dXJuU2VydmVyOiB7XG4gKiAgICAgdHVyblNlcnZlclVSTDogXCJZT1VSIFRVUk5TRVJWRVIgVVJMXCIsXG4gKiAgICAgdXNlcm5hbWU6IFwiWU9VUiBVU0VSTkFNRVwiLFxuICogICAgIHBhc3N3b3JkOiBcIllPVVIgUEFTU1dPUkRcIixcbiAqICAgICB1ZHBwb3J0OiBcIlRIRSBVRFAgUE9SVCBZT1UgV0FOVCBUTyBBRERcIixcbiAqICAgICB0Y3Bwb3J0OiBcIlRIRSBUQ1AgUE9SVCBZT1UgV0FOVCBUTyBBRERcIixcbiAqICAgICBmb3JjZXR1cm46IGZhbHNlXG4gKiAgIH1cbiAqIH1cbiAqIHRoaXMubmd4QWdvcmFTZXJ2aWNlLmNyZWF0ZUNsaWVudChjb25maWcpO1xuICovXG5leHBvcnQgaW50ZXJmYWNlIENsaWVudENvbmZpZyB7XG4gIC8qKlxuICAgKiBUaGUgY29kZWMgdGhlIFdlYiBicm93c2VyIHVzZXMgZm9yIGVuY29kaW5nIGFuZCBkZWNvZGluZy5cbiAgICogLSBgJ3ZwOCdgOiBTZXRzIHRoZSBicm93c2VyIHRvIHVzZSBWUDggZm9yIGVuY29kaW5nIGFuZCBkZWNvZGluZy5cbiAgICogLSBgJ2gyNjQnYDogU2V0cyB0aGUgYnJvd3NlciB0byB1c2UgSDI2NCBmb3IgZW5jb2RpbmcgYW5kIGRlY29kaW5nLlxuICAgKlxuICAgKiBAcmVtYXJrXG4gICAqIFNldCBjb2RlYyBhcyBcImgyNjRcIiBhcyBsb25nIGFzIFNhZmFyaSBpcyBpbnZvbHZlZCBpbiB0aGUgc2Vzc2lvbi5cbiAgICovXG4gIGNvZGVjOiAndnA4JyB8ICdoMjY0JztcbiAgLyoqXG4gICAqIFRoZSBjaGFubmVsIHByb2ZpbGUuXG4gICAqXG4gICAqIEFnb3JhIFdlYiBTREsgbmVlZHMgdG8ga25vdyB0aGUgYXBwbGljYXRpb24gc2NlbmFyaW8gdG8gYXBwbHkgZGlmZmVyZW50IG9wdGltaXphdGlvbiBtZXRob2RzLlxuICAgKlxuICAgKiBDdXJyZW50bHkgQWdvcmEgV2ViIFNESyBzdXBwb3J0cyB0aGUgZm9sbG93aW5nIGNoYW5uZWwgcHJvZmlsZXM6XG4gICAqIC0gXCJsaXZlXCI6IFNldHMgdGhlIGNoYW5uZWwgcHJvZmlsZSBhcyBsaXZlIGJyb2FkY2FzdC5cbiAgICogICBIb3N0IGFuZCBhdWRpZW5jZSByb2xlcyB0aGF0IGNhbiBiZSBzZXQgYnkgY2FsbGluZyB0aGVcbiAgICogICBbQ2xpZW50LnNldENsaWVudFJvbGVdKGh0dHBzOi8vZG9jcy5hZ29yYS5pby9lbi9WaWRlby9BUEklMjBSZWZlcmVuY2Uvd2ViL2ludGVyZmFjZXMvYWdvcmFydGMuY2xpZW50Lmh0bWwjc2V0Y2xpZW50cm9sZSkgbWV0aG9kLlxuICAgKiAgIFRoZSBob3N0IHNlbmRzIGFuZCByZWNlaXZlcyB2b2ljZS92aWRlbywgd2hpbGUgdGhlIGF1ZGllbmNlIGNhbiBvbmx5IHJlY2VpdmUgdm9pY2UvdmlkZW8uXG4gICAqIC0gXCJydGNcIjogU2V0cyB0aGUgY2hhbm5lbCBwcm9maWxlIGFzIGNvbW11bmljYXRpb24uIFRoaXMgaXMgdXNlZCBpbiBvbmUtb24tb25lIGNhbGxzIG9yIGdyb3VwIGNhbGxzLFxuICAgKiAgIHdoZXJlIGFsbCB1c2VycyBpbiB0aGUgY2hhbm5lbCBjYW4gdGFsayBmcmVlbHkuXG4gICAqXG4gICAqIEByZW1hcmtcbiAgICogSWYgeW91IG5lZWQgdG8gY29tbXVuaWNhdGUgd2l0aCBBZ29yYSBOYXRpdmUgU0RLLCBBZ29yYSByZWNvbW1lbmRzIHRoZSBmb2xsb3dpbmcgc2V0dGluZ3M6XG4gICAqICAtIEZvciBOYXRpdmUgU0RLIHYyLjMuMiBhbmQgbGF0ZXI6XG4gICAqICAgU2V0IFttb2RlXShodHRwczovL2RvY3MuYWdvcmEuaW8vZW4vVmlkZW8vQVBJJTIwUmVmZXJlbmNlL3dlYi9pbnRlcmZhY2VzL2Fnb3JhcnRjLmNsaWVudGNvbmZpZy5odG1sI21vZGUpXG4gICAqICAgYXMgXCJydGNcIiBvciBcImxpdmVcIiBpZiB0aGUgTmF0aXZlIFNESyB1c2VzIHRoZSBjb21tdW5pY2F0aW9uIGNoYW5uZWwgcHJvZmlsZS5cbiAgICogICBTZXQgW21vZGVdKGh0dHBzOi8vZG9jcy5hZ29yYS5pby9lbi9WaWRlby9BUEklMjBSZWZlcmVuY2Uvd2ViL2ludGVyZmFjZXMvYWdvcmFydGMuY2xpZW50Y29uZmlnLmh0bWwjbW9kZSlcbiAgICogICBhcyBcImxpdmVcIiBpZiB0aGUgTmF0aXZlIFNESyB1c2VzIHRoZSBsaXZlIGJyb2FkY2FzdCBjaGFubmVsIHByb2ZpbGUuXG4gICAqICAtIEZvciBOYXRpdmUgU0RLIGJlZm9yZSB2Mi4zLjIsIHNldCBtb2RlIGFzIFwibGl2ZVwiIHJlZ2FyZGxlc3Mgb2Ygd2hpY2ggY2hhbm5lbCBwcm9maWxlIHRoZSBOYXRpdmUgU0RLIHVzZXMuXG4gICAqXG4gICAqIElmIHlvdSBzZXQgW21vZGVdKGh0dHBzOi8vZG9jcy5hZ29yYS5pby9lbi9WaWRlby9BUEklMjBSZWZlcmVuY2Uvd2ViL2ludGVyZmFjZXMvYWdvcmFydGMuY2xpZW50Y29uZmlnLmh0bWwjbW9kZSlcbiAgICogYXMgXCJydGNcIiwgdGhlIEFnb3JhIFJlY29yZGluZyBTREsgaXMgbm90IHN1cHBvcnRlZC5cbiAgICovXG4gIG1vZGU6ICdsaXZlJyB8ICdydGMnO1xuICAvKipcbiAgICogWW91ciBOZ2lueCBzZXJ2ZXIgZG9tYWluIG5hbWUuXG4gICAqXG4gICAqIEFTQ0lJIGNoYXJhY3RlcnMgb25seSwgYW5kIHRoZSBzdHJpbmcgbGVuZ3RoIG11c3QgYmUgZ3JlYXRlciB0aGFuIDAgYW5kIGxlc3MgdGhhbiAyNTYgYnl0ZXMuXG4gICAqIEVudGVycHJpc2UgdXNlcnMgd2l0aCBhIGNvbXBhbnkgZmlyZXdhbGwgY2FuIHVzZSB0aGlzIHByb3BlcnR5IHRvIHBhc3Mgc2lnbmFsaW5nIG1lc3NhZ2VzIHRvIHRoZSBBZ29yYSBTRC1SVE4gdGhyb3VnaCB0aGUgTmdpbnggU2VydmVyLlxuICAgKi9cbiAgcHJveHlTZXJ2ZXI/OiBzdHJpbmc7XG4gIC8qKlxuICAgKiBUVVJOIHNlcnZlciBzZXR0aW5ncy5cbiAgICpcbiAgICogRW50ZXJwcmlzZSB1c2VycyB3aXRoIGEgY29tcGFueSBmaXJld2FsbCBjYW4gdXNlIHRoaXMgcHJvcGVydHkgdG8gcGFzcyBhdWRpbyBhbmQgdmlkZW8gZGF0YSB0byB0aGUgQWdvcmEgU0QtUlROIHRocm91Z2hcbiAgICogdGhlIFRVUk4gU2VydmVyLlxuICAgKi9cbiAgdHVyblNlcnZlcj86IFR1cm5TZXJ2ZXI7XG59XG4iXX0=