Inherits from NSObject
Declared in VoxImplant.h

Overview

@class VoxImplant

Should not be instantiated directly, use [VoxImplantSDK getVoxImpantSDK] instead

– getVoxDelegate

Returns Current delegate

- (id<VoxImplantDelegate>)getVoxDelegate

Return Value

Current delegate

Discussion

Returns Current delegate

Declared In

VoxImplant.h

– setVoxDelegate:

Set delegate object for SDK

- (void)setVoxDelegate:(id<VoxImplantDelegate>)delegate

Parameters

delegate

Delegate object

Discussion

Set delegate object for SDK

Declared In

VoxImplant.h

+ getInstance

Returns single SDK object instance

+ (VoxImplant *)getInstance

Discussion

Returns single SDK object instance

Declared In

VoxImplant.h

– connect

Connect to VoxImplant cloud

- (void)connect

Discussion

Connect to VoxImplant cloud

Declared In

VoxImplant.h

– createCall:withVideo:andCustomData:

Create new call instance. Call must be then started using startCall

- (NSString *)createCall:(NSString *)to withVideo:(bool)video andCustomData:(NSString *)customData

Parameters

to

SIP URI, username or phone number to make call to. Actual routing is then performed by VoxEngine scenario

video

Enable video support in call

customData

Optional custom data passed with call. Will be available in VoxEngine senario

Discussion

Create new call instance. Call must be then started using startCall

Declared In

VoxImplant.h

– loginWithUsername:andPassword:

Login to VoxImplant using specified username and password

- (void)loginWithUsername:(NSString *)user andPassword:(NSString *)password

Parameters

user

Username combined with application name, for example testuser\@testapp.testaccount.voximplant.com

password

Password in plain text

Discussion

Login to VoxImplant using specified username and password

Declared In

VoxImplant.h

– closeConnection

Closes connection with media server

- (void)closeConnection

Discussion

Closes connection with media server

Declared In

VoxImplant.h

– startCall:withHeaders:

Send start call request If call with specified id is not found - returns false;

- (bool)startCall:(NSString *)callId withHeaders:(NSDictionary *)headers

Parameters

callId

id of previously created call

headers

Optional set of headers to be sent with message. Names must begin with “X-” to be processed by SDK

Discussion

Send start call request If call with specified id is not found - returns false;

Declared In

VoxImplant.h

– attachAudioTo:

Attach audio and video to specified call If call with specified id is not found - returns false;

- (bool)attachAudioTo:(NSString *)callId

Parameters

callId

id of previously created call

Discussion

Attach audio and video to specified call If call with specified id is not found - returns false;

Declared In

VoxImplant.h

– sendDTMF:digit:

Sends DTMF digit in specified call.

- (void)sendDTMF:(NSString *)callId digit:(int)digit

Parameters

callId

id of previously created call

digit

Digit can be 0-9 for 0-9, 10 for * and 11 for #

Discussion

Sends DTMF digit in specified call.

Declared In

VoxImplant.h

– disconnectCall:withHeaders:

Terminates specified call. Call must be either established, or outgoing progressing If call with specified id is not found - returns false;

- (bool)disconnectCall:(NSString *)callId withHeaders:(NSDictionary *)headers

Parameters

callId

id of previously created call

headers

Optional set of headers to be sent with message. Names must begin with “X-” to be processed by SDK

Discussion

Terminates specified call. Call must be either established, or outgoing progressing If call with specified id is not found - returns false;

Declared In

VoxImplant.h

– declineCall:withHeaders:

Rejects incoming alerting call If call with specified id is not found - returns false;

- (void)declineCall:(NSString *)callId withHeaders:(NSDictionary *)headers

Parameters

callId

id of previously created call

headers

Optional set of headers to be sent with message. Names must begin with “X-” to be processed by SDK

Discussion

Rejects incoming alerting call If call with specified id is not found - returns false;

Declared In

VoxImplant.h

– answerCall:withHeaders:

Answers incoming alerting call If call with specified id is not found - returns false;

- (void)answerCall:(NSString *)callId withHeaders:(NSDictionary *)headers

Parameters

callId

id of previously created call

headers

Optional set of headers to be sent with message. Names must begin with “X-” to be processed by SDK

Discussion

Answers incoming alerting call If call with specified id is not found - returns false;

Declared In

VoxImplant.h

– sendMessage:withText:andHeaders:

Sends instant message within established call

- (void)sendMessage:(NSString *)callId withText:(NSString *)text andHeaders:(NSDictionary *)headers

Parameters

callId

id of previously created call

text

Message text

headers

Optional set of headers to be sent with message. Names must begin with “X-” to be processed by SDK

Discussion

Sends instant message within established call

Declared In

VoxImplant.h

– sendInfo:withType:content:andHeaders:

Sends info within established call

- (void)sendInfo:(NSString *)callId withType:(NSString *)mimeType content:(NSString *)content andHeaders:(NSDictionary *)headers

Parameters

callId

id of previously created call

mimeType

MIME type of info

content

Custom string data

headers

Optional set of headers to be sent with message. Names must begin with “X-” to be processed by SDK

Discussion

Sends info within established call

Declared In

VoxImplant.h

– getCallDuration:

Get call duration for established call

- (NSTimeInterval)getCallDuration:(NSString *)callId

Parameters

callId

id of previously created call

Discussion

Get call duration for established call

Declared In

VoxImplant.h

– setMute:

Mute or unmute microphone. This is reset after audio interruption

- (void)setMute:(bool)b

Parameters

b

Enable/disable flag

Discussion

Mute or unmute microphone. This is reset after audio interruption

Declared In

VoxImplant.h

– setUseLoudspeaker:

Enable/disable loudspeaker (doesn’t make sence for iPad, since it has only loudspeaker)

- (bool)setUseLoudspeaker:(bool)b

Parameters

b

Enable/disable flag

Discussion

Enable/disable loudspeaker (doesn’t make sence for iPad, since it has only loudspeaker)

Declared In

VoxImplant.h

– setVideoResizeMode:

Set video display mode. Applies to both incoming and outgoing streams

- (void)setVideoResizeMode:(enum VoxImplantVideoResizeMode)mode

Parameters

mode

@link VoxImplantVideoResizeMode @/link enum

Discussion

Set video display mode. Applies to both incoming and outgoing streams

Declared In

VoxImplant.h

– getVideoResizeMode

Get video display mode. Applies to both incoming and outgoing streams

- (enum VoxImplantVideoResizeMode)getVideoResizeMode

Discussion

Get video display mode. Applies to both incoming and outgoing streams

Declared In

VoxImplant.h

– sendVideo:

Stop/start sending video during the call

- (void)sendVideo:(BOOL)doSend

Discussion

Stop/start sending video during the call

Declared In

VoxImplant.h

– setLocalPreview:

Set container for local video preview

- (void)setLocalPreview:(UIView *)view

Discussion

Set container for local video preview

Declared In

VoxImplant.h

– setRemoteView:

Set container for remote video display

- (void)setRemoteView:(UIView *)view

Discussion

Set container for remote video display

Declared In

VoxImplant.h

– setResolution:andHeight:

Set resolution of video being sent to remote participant

- (void)setResolution:(int)width andHeight:(int)height

Discussion

Set resolution of video being sent to remote participant

Declared In

VoxImplant.h

– hasFrontFacingCamera

Returns true if device has front facing camera

- (BOOL)hasFrontFacingCamera

Discussion

Returns true if device has front facing camera

Declared In

VoxImplant.h

– switchToCameraWithPosition:

Switch to front/back camera

- (BOOL)switchToCameraWithPosition:(AVCaptureDevicePosition)position

Discussion

Switch to front/back camera

Declared In

VoxImplant.h