Rate this page:

VICallSettings

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

Props

customData

Copy URL
@property (strong, nullable, nonatomic) 

NSString *

customData

Custom string associated with a call session.

It can be passed to the cloud to be obtained from the CallAlerting event or Call History via 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

Whether simulcast feature should be enabled in a conference call.

The default value is NO.

Valid only for conference calls.

Returns

  • type:

    BOOL

extraHeaders

Copy URL
@property (strong, nullable, nonatomic) 

NSDictionary<NSString *, NSString *> *

extraHeaders

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

Preferred video codec for a particular call that this VICallSettings are applied to. The default codec is VIVideoCodecAuto.

Returns

receiveAudio

Copy URL
@property (assign, nonatomic) 

BOOL

receiveAudio

Whether audio can be received within a call. Default value is YES.

Returns

  • type:

    BOOL

statsCollectionInterval

Copy URL
@property (assign, nonatomic) 

NSUInteger

statsCollectionInterval

Call statistics collection interval in milliseconds.

Default value is 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

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

Returns