SIGN UP

VoxImplantClient

Deprecated

Use IClient instead

Methods

answerCall

Deprecated
void answerCall(String callId, String customData, Map<String,String> headers)

Answer incoming call

Parameters

  • callId:

    String

    Id of previously created call

  • customData:

    String

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

  • headers:

    Map<String,String>

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

answerCall

Deprecated
void answerCall(String callId)

Answer incoming call

Parameters

  • callId:

    String

    id of previously created call

closeConnection

Deprecated
void closeConnection()

Closes connection with media server

connect

Deprecated
void connect()

Use IClient.connect() instead

Connect to Voximplant cloud

Throws

  • type:

    IllegalStateException In case if the connection is currently establishing or already established (since 2.3.2).

connect

Deprecated
void connect(boolean connectivityCheck, List<String> serverNames)

Connect to Voximplant cloud

Parameters

  • connectivityCheck:

    boolean

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

  • serverNames:

    List<String>

    Server name of particular media gateway for connection

Throws

  • type:

    IllegalStateException In case if the connection is currently establishing or already established (since 2.3.2).

createCall

Deprecated
String createCall(String to, boolean video, String customData)

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

Parameters

  • to:

    String

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

  • video:

    boolean

    Enable video support in call

  • customData:

    String

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

Returns

  • Return:

    String

    Call id of newly created call, null if the call was not created. Created call id should be used to perform any subsequent call operations

declineCall

Deprecated
void declineCall(String callId, Map<String,String> headers)

Reject incoming alerting call

Parameters

  • callId:

    String

    id of previously created call

  • headers:

    Map<String,String>

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

declineCall

Deprecated
void declineCall(String callId)

Reject incoming alerting call

Parameters

  • callId:

    String

    id of previously created call

disconnectCall

Deprecated
void disconnectCall(String callId, Map<String,String> headers)

Use ICall.hangup(Map) instead

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

Parameters

  • callId:

    String

    id of previously created call

  • headers:

    Map<String,String>

    Optional set of headers to be sent with message. Names must begin with "X-" to be processed by Voximplant

disconnectCall

Deprecated
void disconnectCall(String callId)

Use ICall.hangup(Map) instead

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

Parameters

  • callId:

    String

    id of previously created call

getMissingPermissions

Deprecated
List<String> getMissingPermissions(Context context, boolean videoSupportEnabled)

Returns the list of permissions that have not been granted by user yet

Parameters

  • context:

    Context

    Android context

  • videoSupportEnabled:

    boolean

    Specify if permissions for video calls are required.

Returns

  • Return:

    List<String>

    List of disallowed permissions

handlePushNotification

Deprecated
void handlePushNotification(Map<String,String> notification)

Handle incoming push notification

Parameters

  • notification:

    Map<String,String>

    Incoming push notification that comes from FirebaseMessagingService.onMessageReceived(RemoteMessage remoteMessage)

instance

Deprecated
VoxImplantClient instance()

Returns

login

Deprecated
void login(String username, String password)

Login to specified Voximplant application

Parameters

  • username:

    String

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

  • password:

    String

    User password

loginUsingAccessToken

Deprecated
void loginUsingAccessToken(String user, String accessToken)

Perform login using specified username and access token that was obtained in onLoginSuccessful callback before

Parameters

  • user:

    String

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

  • accessToken:

    String

    access token that was obtained in onLoginSuccessful callback

loginUsingOneTimeKey

Deprecated
void loginUsingOneTimeKey(String user, String hash)

Perform login using one time key that was generated before

Parameters

  • user:

    String

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

  • hash:

    String

    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.

refreshToken

Deprecated
void refreshToken(String user, String refreshToken)

Perform refresh of login tokens required for login using access token

Parameters

  • user:

    String

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

  • refreshToken:

    String

    refresh token that was obtained in onLoginSuccessful callback

registerForPushNotifications

Deprecated
void registerForPushNotifications(String pushRegistrationToken)

Register for push notifications. Application will receive push notifications from Voximplant Server after first log in.

Parameters

  • pushRegistrationToken:

    String

    FCM registration token that can be retrieved by calling FirebaseInstanceID.getToken()

requestOneTimeKey

Deprecated
void requestOneTimeKey(String user)

Generates one time login key to be used for automated login process.

Parameters

  • user:

    String

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

sendDTMF

Deprecated
void sendDTMF(String callId, int digit)

Sends DTMF digit in specified call.

Parameters

  • callId:

    String

    id of previously created call

  • digit:

    int

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

sendInfo

Deprecated
void sendInfo(String callId, String mimeType, String content, Map<String,String> headers)

Sends info within established call

Parameters

  • callId:

    String

    id of previously created call

  • mimeType:

    String

    MIME type of info

  • content:

    String

    Custom string data

  • headers:

    Map<String,String>

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

sendInfo

Deprecated
void sendInfo(String callId, String mimeType, String content)

Sends info within established call

Parameters

  • callId:

    String

    id of previously created call

  • mimeType:

    String

    MIME type of info

  • content:

    String

    Custom string data

sendMessage

Deprecated
void sendMessage(String callId, String text)

Sends instant message within established call

Parameters

  • callId:

    String

    id of previously created call

  • text:

    String

    Message text

sendVideo

Deprecated
void sendVideo(boolean doSendVideo)

Start/stop sending video from local camera

Parameters

  • doSendVideo:

    boolean

    Specify if video should be sent

setAndroidContext

Deprecated
void setAndroidContext(Context context)

Android context is provided to SDK via Voximplant.getClientInstance(Executor, Context, ClientConfig) instead

Set Android context

Parameters

  • context:

    Context

    Android context

Throws

  • type:

    AccessControlException

setAndroidContext

Deprecated
void setAndroidContext(Context context, VoxImplantClient.VoxImplantClientConfig clientConfig)

Android context and client configuration are provided to SDK via Voximplant.getClientInstance(Executor, Context, ClientConfig) instead

Set Android context and VoxImplantClient config

Parameters

Throws

  • type:

    AccessControlException

setCallback

Deprecated
void setCallback(VoxImplantCallback cb)

Sets handler for Voximplant events

Parameters

setCamera

Deprecated
void setCamera(int cam)

Select camera

Parameters

  • cam:

    int

    Must be Camera.CameraInfo.CAMERA_FACING_FRONT or Camera.CameraInfo.CAMERA_FACING_BACK

setCameraResolution

Deprecated
void setCameraResolution(int width, int height)

Set local camera resolution

Parameters

  • width:

    int

    camera resolution width

  • height:

    int

    camera resolution height

setLocalPreview

Deprecated
void setLocalPreview(VideoRenderer.Callbacks videoView)

Set view for local stream

Parameters

  • videoView:

    VideoRenderer.Callbacks

    org.webrtc.SurfaceViewRenderer or custom implementation of org.webrtc.VideoRenderer.Callbacks
    It is recommended to use SurfaceViewRenderer for the most of cases.
    In case of custom implementation of VideoRenderer.Callback class:

    1. VideoRenderer.renderFrameDone(i420Frame) must be called after every VideoRenderer.renderFrame()
    2. See VoxImplantClientConfig parameters to set up video frame format

setMute

Deprecated
void setMute(boolean doMute)

Mute or unmute microphone. This is reset after audio interruption

Parameters

  • doMute:

    boolean

    Enable/disable flag

setRemoteView

Deprecated
void setRemoteView(VideoRenderer.Callbacks videoView)

Set view for remote stream

Parameters

  • videoView:

    VideoRenderer.Callbacks

    org.webrtc.SurfaceViewRenderer or custom implementation of org.webrtc.VideoRenderer.Callbacks
    It is recommended to use SurfaceViewRenderer for the most of cases.
    In case of custom implementation of VideoRenderer.Callback class:

    1. VideoRenderer.renderFrameDone(i420Frame) must be called after every VideoRenderer.renderFrame()
    2. See VoxImplantClientConfig parameters to set up video frame format

setRemoteView

Deprecated
void setRemoteView(String callId, VideoRenderer.Callbacks videoView)

Set view for remote stream for call

Parameters

  • callId:

    String

    id of the call

  • videoView:

    VideoRenderer.Callbacks

    org.webrtc.SurfaceViewRenderer or custom implementation of org.webrtc.VideoRenderer.Callbacks
    It is recommended to use SurfaceViewRenderer for the most of cases.
    In case of custom implementation of VideoRenderer.Callback class:

    1. VideoRenderer.renderFrameDone(i420Frame) must be called after every VideoRenderer.renderFrame()
    2. See VoxImplantClientConfig parameters to set up video frame format

setUseLoudspeaker

Deprecated
boolean setUseLoudspeaker(boolean useLoudSpeaker)

Enable/disable loudspeaker

Parameters

  • useLoudSpeaker:

    boolean

    Enable/disable loudspeaker

Returns

  • Return:

    boolean

startCall

Deprecated
boolean startCall(String callId, Map<String,String> headers)

Use ICall.start(Map) instead

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

Parameters

  • callId:

    String

    id of previously created call

  • headers:

    Map<String,String>

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

Returns

  • Return:

    boolean

    true on success, false if operation has failed

startCall

Deprecated
boolean startCall(String callId)

Use ICall.start(Map) instead

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

Parameters

  • callId:

    String

    id of previously created call

Returns

  • Return:

    boolean

    true on success, false if operation has failed

unregisterFromPushNotifications

Deprecated
void unregisterFromPushNotifications(String pushRegistrationToken)

Unregister from push notifications. Application will no longer receive push notifications from Voximplant server

Parameters

  • pushRegistrationToken:

    String

    FCM registration token that was used to register for push notifications