VGClientConfig

@interface VGClientConfig : NSObject

Object containing Client configuration options.

  • The API URL of your chosen datacenter.

    Declaration

    Objective-C

    @property (nonatomic, nonnull) NSString *apiUrl;

  • The WebSocket URL of your chosen datacenter.

    Declaration

    Objective-C

    @property (nonatomic, nonnull) NSString *websocketUrl;

  • The Path component appended to the Websocket URL

    Declaration

    Objective-C

    @property (nonatomic, nonnull) NSString *websocketPath;

  • Allow client to receive call invites via websocket.

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableWebsocketInvites;

  • Allow client to send RTC stats report.

    Declaration

    Objective-C

    @property (nonatomic) BOOL rtcStatsTelemetry;

  • Allow client to automatically reconnect media when network interface changes.

    Declaration

    Objective-C

    @property (nonatomic) BOOL autoReconnectMedia;

  • Allow client to use noise suppression to reduce background noise during a call.

    Declaration

    Objective-C

    @property (nonatomic) BOOL enableNoiseSuppression;

  • The primary region URL for emergency services.

    Declaration

    Objective-C

    @property (nonatomic, nonnull) NSString *emergencyPrimaryRegion;

  • The secondary region URL for emergency services (fallback).

    Declaration

    Objective-C

    @property (nonatomic, nonnull) NSString *emergencySecondaryRegion;

  • Create a new instance providing a configuration region.

    Default values:

    apiURL: https://api-{region}.vonage.com

    websocketUrl: https://ws-{region}.vonage.com

    websocketPath: /v2/rtc

    enableWebSocketInvites: false

    rtcStatsTelemetry: true

    autoReconnectMedia: true

    emergencyPrimaryRegion: https://api-us.vonage.com

    emergencySecondaryRegion: https://api-us-2.vonage.com

    Declaration

    Objective-C

    - (nonnull instancetype)initWithRegion:(VGConfigRegion)region;