Voximplant
Primary interface of the Voximplant SDK.
Methods
createAudioFile
createAudioFile(url: String
, usage: ): Creates an IAudioFile instance to play an audio file from URL.
Parameters
url:
String
HTTP URL of the stream to play
usage:
Audio file usage mode
Returns
type:
createAudioFile
createAudioFile(context: Context
, uri: Uri
, 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:
Audio file usage mode
Returns
type:
createAudioFile
createAudioFile(context: Context
, resId: int
, 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:
Audio file usage mode
Returns
type:
getAudioDeviceManager
getAudioDeviceManager(): Gets the IAudioDeviceManager instance to control audio hardware settings.
Returns
type:
getCameraManager
getCameraManager(context: Context
): Gets the ICameraManager instance to control camera hardware settings.
Parameters
context:
Context
Android context
Returns
type:
getClientInstance
getClientInstance(executor: Executor
, context: Context
, 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 instance with configuration for IClient instance
Returns
type:
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
getCustomVideoSource(): Gets an ICustomVideoSource instance to send video frames from a custom source.
Returns
type:
getMessenger
getMessenger(): Gets the messaging subsystem instance.
Returns
type:
getMessengerPushNotificationProcessing
getMessengerPushNotificationProcessing(): Gets an IMessengerPushNotificationProcessing instance.
Returns
getMissingPermissions
getMissingPermissions(context: Context
, videoSupportEnabled: boolean
): List<String>
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
setLogListener(logListener: ): void
Sets a log listener to handle the Voximplant Android SDK's log messages.
Parameters
logListener:
ILogListener instance
Returns
type:
void