Inherits fromNSObject
Declared inVoxImplant.h

Overview

@class VoxImplant

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

+ setLogLevel:

Sets a verbosity level for log messages. Note that this method must be called before creating SDK object instance.

+ (void) setLogLevel: (Enum VoxImplantLogLevel) logLevel

Parameters

logLevel

New log level

Description

Sets a verbosity level for log messages. Note that this method must be called before creating SDK object instance.

Declared In

VoxImplant.h

- getVoxDelegate

Returns currently set delegate object or nil

- (Id<VoxImplantDelegate>) getVoxDelegate

Return Value

Delegate object or nil

Description

Returns currently set delegate object or nil

Declared In

VoxImplant.h

- setVoxDelegate:

Set delegate object for SDK

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

Parameters

delegate

Delegate object

Description

Set delegate object for SDK

Declared In

VoxImplant.h

+ getInstance

Returns the SDK object instance

+ (VoxImplant *) getInstance

Return Value

Pointer to the SDK object instance

Description

Returns the SDK object instance

Declared In

VoxImplant.h

- connect

Connect to VoxImplant cloud

- (void) connect

Description

Connect to VoxImplant cloud

Declared In

VoxImplant.h

- connect:

Connect to VoxImplant cloud

- (void) connect: (Bool) connectivityCheck

Parameters

connectivityCheck

Checks whether UDP traffic will flow correctly between device and VoxImplant cloud. This check reduces connection speed.

Description

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

Return Value

Pointer to a string representation of the call id

Description

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

Description

Login to VoxImplant using specified username and password

Declared In

VoxImplant.h

- loginWithUsername:andOneTimeKey:

Perform login using one time key that was generated before

- (void) loginWithUsername: (NSString*) user andOneTimeKey: (NSString*) hash

Parameters

user

Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

hash

Hash that was generated using following formula: MD5(oneTimeKey+"|"+MD5(user+":voximplant.com:"+password))
Please note that here user is just a user name, without app name, account name or anything else after "@". So if you pass myuser@myapp.myacc.voximplant.com as a username, you should only use myuser while computing this hash

Description

Perform login using one time key that was generated before

Declared In

VoxImplant.h

- loginWithUsername:andToken:

Login to VoxImplant using specified username and password

- (void) loginWithUsername: (NSString*) user andToken: (NSString*) token

Parameters

user

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

token

Access token, received in the onLoginSuccessfulWithDisplayName callback as the accessToken property of callback parameter object.

Description

Login to VoxImplant using specified username and password

Declared In

VoxImplant.h

- refreshTokenWithUsername:andToken:

Perform refresh of login tokens required for login using access token

- (void) refreshTokenWithUsername: (NSString*) user andToken: (NSString*) token

Parameters

user

Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

token

refresh token that was obtained in the onLoginSuccessfulWithDisplayName callback as the refreshToken property of callback parameter object.

Description

Perform refresh of login tokens required for login using access token

Declared In

VoxImplant.h

- requestOneTimeKeyWithUsername:

Generates one time login key to be used for automated login process. See Information about automated login on VoxImplant website and loginUsingOneTimeKey

- (void) requestOneTimeKeyWithUsername: (NSString*) user

Parameters

user

Full user name, including app and account name, like someuser@someapp.youraccount.voximplant.com

Description

Generates one time login key to be used for automated login process. See Information about automated login on VoxImplant website and loginUsingOneTimeKey

Declared In

VoxImplant.h

- closeConnection

Closes connection with media server

- (void) closeConnection

Description

Closes connection with media server

Declared In

VoxImplant.h

- startCall:withHeaders:

Send start call request

- (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

Return Value

false if call with specified id is not found, otherwise true

Description

Send start call request

Declared In

VoxImplant.h

- attachAudioTo:

Attach audio and video to specified call.

- (Bool) attachAudioTo: (NSString*) callId

Parameters

callId

id of previously created call

Return Value

false if the call with the specified id is not found, otherwise true

Description

Attach audio and video to specified call.

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 #

Description

Sends DTMF digit in specified call.

Declared In

VoxImplant.h

- disconnectCall:withHeaders:

Terminates specified call. Call must be either established, or outgoing progressing

- (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

Return Value

false if the call with the specified id is not found, otherwise true

Description

Terminates specified call. Call must be either established, or outgoing progressing

Declared In

VoxImplant.h

- declineCall:withHeaders:

Rejects incoming alerting call

- (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

Description

Rejects incoming alerting call

Declared In

VoxImplant.h

- answerCall:withHeaders:

Answers incoming alerting call

- (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

Description

Answers incoming alerting call

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

Description

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

Description

Sends info within established call

Declared In

VoxImplant.h

- getCallDuration:

Get call duration for established call

- (void) getCallDuration: (NSString*) callId

Parameters

callId

id of previously created call

Description

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

Description

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)

- (void) setUseLoudspeaker: (Bool) b

Parameters

b

Enable/disable flag

Description

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

VoxImplantVideoResizeMode enum

Description

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

Return Value

Video display mode

Description

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

Parameters

doSend

If true, send video, otherwise do not send it

Description

Stop/start sending video during the call

Declared In

VoxImplant.h

- setLocalPreview:

Set container for local video preview

- (void) setLocalPreview: (UIView*) view

Parameters

view

UIView

Description

Set container for local video preview

Declared In

VoxImplant.h

- setRemoteView:

Set container for remote video display

- (void) setRemoteView: (undefined) view

Parameters

view

UIView

Description

Set container for remote video display

Declared In

VoxImplant.h

- setRemoteView:forCall:

Set container for remote video display for call

- (void) setRemoteView: (UIView*) view forCall: (NSString*) callId

Parameters

view

UIView

callId

id of the call

Description

Set container for remote video display for call

Declared In

VoxImplant.h

- setResolution:andHeight:

Set resolution of video being sent to remote participant

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

Parameters

width

Video width, in pixels

height

Video height, in pixels

Description

Set resolution of video being sent to remote participant

Declared In

VoxImplant.h

- switchToCameraWithPosition:

Switch to front/back camera

- (void) switchToCameraWithPosition: (AVCaptureDevicePosition) position

Parameters

position

Camera to select

Description

Switch to front/back camera

Declared In

VoxImplant.h