Rate this page:

VICallSettings

Call settings with additional call parameters, such as preferred video codec, custom data, extra headers etc.

Props

customData

Copy URL
@property (strong, nullable, nonatomic) 

NSString *

customData

A custom string associated with the call session.

It can be passed to the cloud to be obtained from the CallAlerting event or Call History using HTTP API.

Maximum size is 200 bytes. Use the [VICall sendMessage:] method to pass a string over the limit; in order to pass a large data use media_session_access_url on your backend.

Returns

  • type:

    NSString *

enableSimulcast

Copy URL
@property (assign, nonatomic) 

BOOL

enableSimulcast

Specify if simulcast feature should be enabled in the conference call.

NO by default.

Valid only for conference calls.

Returns

  • type:

    BOOL

extraHeaders

Copy URL
@property (strong, nullable, nonatomic) 

NSDictionary<NSString *, NSString *> *

extraHeaders

An optional set of headers to be sent to the Voximplant cloud. Names must begin with "X-" to be processed by SDK.

Returns

  • type:

    NSDictionary<NSString *, NSString *> *

preferredVideoCodec

Copy URL
@property (assign, nonatomic) 

VIVideoCodec

preferredVideoCodec

A preferred video codec for a particular call that this VICallSettings are applied to. VIVideoCodecAuto by default.

Returns

receiveAudio

Copy URL
@property (assign, nonatomic) 

BOOL

receiveAudio

Specify if audio can be received within the call. Default value - YES.

Returns

  • type:

    BOOL

statsCollectionInterval

Copy URL
@property (assign, nonatomic) 

NSUInteger

statsCollectionInterval

Call statistics collection interval in milliseconds.

Default value - 5000.

Interval value should be multiple of 500, otherwise the provided value is rounded to a less value that is multiple of 500.

Returns

  • type:

    NSUInteger

videoFlags

Copy URL
@property (strong, nonatomic) 

VIVideoFlags *

videoFlags

Specify video settings (send and receive) for the new call. Video is enabled by default.

Returns