Rate this page:

Voximplant

Voximplant is primary interface of Voximplant SDK

Methods

createAudioFile

Static
Copy URL

IAudioFile

createAudioFile(

String

url,

AudioFileUsage

usage
)

Create a IAudioFile instance to play audio file from URL.

Parameters

  • url:

    String

    HTTP URL of the stream to play

  • Audio file usage mode

Returns

createAudioFile

Static
Copy URL

IAudioFile

createAudioFile(

Context

context,

Uri

uri,

AudioFileUsage

usage
)

Create a IAudioFile instance to play audio file from Uri

Parameters

  • context:

    Context

    Application context

  • uri:

    Uri

    the Uri from which to get the audio file

  • Audio file usage mode

Returns

createAudioFile

Static
Copy URL

IAudioFile

createAudioFile(

Context

context,

int

resId,

AudioFileUsage

usage
)

Create a IAudioFile instance to play audio file from the application resources.

Parameters

  • context:

    Context

    Application context

  • resId:

    int

    The raw resource id (R.raw.<something>) for the resource

  • Audio file usage mode

Returns

getAudioDeviceManager

Static
Copy URL

IAudioDeviceManager

getAudioDeviceManager()

Get IAudioDeviceManager instance to control audio hardware settings

getCameraManager

Static
Copy URL

ICameraManager

getCameraManager(

Context

context
)

Get ICameraManager instance to control camera hardware settings

Parameters

  • context:

    Context

    Android context

Returns

getClientInstance

Static
Copy URL

IClient

getClientInstance(

Executor

executor,

Context

context,

ClientConfig

clientConfig
)

Get IClient instance to connect and login to Voximplant Cloud, make and receive calls

Parameters

  • executor:

    Executor

    Executor on which all Voximplant Android SDK events will be received

  • context:

    Context

    Android context

  • clientConfig:

    ClientConfig

    ClientConfig instance with configuration for IClient instance

Returns

Throws

ClientException if it has failed to load the native library required for the SDK functionality. In this case the SDK API cannot be used. (since 2.38.0)

getCustomVideoSource

Static
Copy URL

ICustomVideoSource

getCustomVideoSource()

Get ICustomVideoSource instance to send video frames from custom source

Returns

getMessenger

Static
Copy URL

IMessenger

getMessenger()

Get instance of messaging subsystem

Returns

getMessengerPushNotificationProcessing

Static
Copy URL

IMessengerPushNotificationProcessing

getMessengerPushNotificationProcessing()

getMissingPermissions

Static
Copy URL

List<String>

getMissingPermissions(

Context

context,

boolean

videoSupportEnabled
)

Get the list of required permissions that have not been granted by a user yet.

The following "dangerous" permissions are checked for audio calls (videoSupportEnabled is set to false):

  • RECORD_AUDIO
  • BLUETOOTH_CONNECT (if target sdk is 31 or higher)

The following "dangerous" permissions are checked for video calls (videoSupportEnabled is set to true):

  • RECORD_AUDIO
  • BLUETOOTH_CONNECT (if target sdk is 31 or higher)
  • CAMERA

It also checks the following "normal" permissions that should be granted automatically:

  • INTERNET
  • ACCESS_NETWORK_STATE
  • CHANGE_NETWORK_STATE
  • MODIFY_AUDIO_SETTINGS

Parameters

  • context:

    Context

    Android context

  • videoSupportEnabled:

    boolean

    Specify if the permissions for video calls are required.

Returns

  • type:

    List<String>

setLogListener

Static
Copy URL

void

setLogListener(

ILogListener

logListener
)

Set log listener to handle Voximplant Android SDK log messages.

Parameters

Returns

  • type:

    void