1. References
  2. Android SDK
  3. Voximplant
Rate this page:

Voximplant

Primary interface of the Voximplant SDK.

Methods

createAudioFile

Static
Copy URL
IAudioFile
 createAudioFile(
String
 url, 
AudioFileUsage
 usage)

Creates an IAudioFile instance to play an audio file from URL.

Parameters

  • url:

    String

    HTTP URL of the stream to play

  • usage:

    AudioFileUsage

    Audio file usage mode

Returns

createAudioFile

Static
Copy URL
IAudioFile
 createAudioFile(
Context
 context, 
Uri
 uri, 
AudioFileUsage
 usage)

Creates an IAudioFile instance to play an audio file from Uri.

Parameters

  • context:

    Context

    Application context

  • uri:

    Uri

    Uri to get the audio file

  • usage:

    AudioFileUsage

    Audio file usage mode

Returns

createAudioFile

Static
Copy URL
IAudioFile
 createAudioFile(
Context
 context, 
int
 resId, 
AudioFileUsage
 usage)

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

Parameters

  • context:

    Context

    Application context

  • resId:

    int

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

  • usage:

    AudioFileUsage

    Audio file usage mode

Returns

getAudioDeviceManager

Static
Copy URL
IAudioDeviceManager
 getAudioDeviceManager()

Gets the IAudioDeviceManager instance to control audio hardware settings.

Returns

getCameraManager

Static
Copy URL
ICameraManager
 getCameraManager(
Context
 context)

Gets the 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()

Gets an ICustomVideoSource instance to send video frames from a custom source.

Returns

getMessenger

Static
Copy URL
IMessenger
 getMessenger()

Gets the messaging subsystem instance.

Returns

getMessengerPushNotificationProcessing

Static
Copy URL
IMessengerPushNotificationProcessing
 getMessengerPushNotificationProcessing()

Gets an IMessengerPushNotificationProcessing instance.

Returns

getMissingPermissions

Static
Copy URL
List<String>
 getMissingPermissions(
Context
 context, 
boolean
 videoSupportEnabled)

Gets 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

    Whether the permissions for video calls are required

Returns

  • type:

    List<String>

setLogListener

Static
Copy URL
void
 setLogListener(
ILogListener
 logListener)

Sets a log listener to handle the Voximplant Android SDK's log messages.

Parameters

Returns

  • type:

    void