SwitchboardSDK/com.synervoz.switchboard.sdk.audioengine/AudioEngine

AudioEngine

class AudioEngine(val context: Context, config: AudioEngineConfig) : NDKBinding

Creates an AudioEngine class

Parameters

context

application context

config

config of the audio engine. See AudioEngineConfig for description of the parameters

Constructors

AudioEngine

constructor(context: Context, sampleRate: Int? = null, micInputPreset: MicInputPreset? = null, performanceMode: PerformanceMode? = null, outputUsage: OutputUsage? = null, microphoneEnabled: Boolean? = null, outputEnabled: Boolean? = null)

Creates an AudioEngine class

constructor(context: Context, config: AudioEngineConfig)

Types

Companion

object Companion

Properties

alwaysUseA2DPBluetoothProfile

var alwaysUseA2DPBluetoothProfile: Boolean

Indicates whether the A2DP Bluetooth profile should always be used. Default is false

config

var config: AudioEngineConfig

context

val context: Context

isRunning

val isRunning: Boolean

micInputPreset

var micInputPreset: MicInputPreset

Indicates the microphone input preset of the audio engine. Default is generic

microphoneEnabled

var microphoneEnabled: Boolean

Indicates whether the microphone input is enabled on the audio engine. Default is false

nativeMicInputPreset

var nativeMicInputPreset: Int

nativeMicrophoneEnabled

var nativeMicrophoneEnabled: Boolean

nativeOutputEnabled

var nativeOutputEnabled: Boolean

nativeOutputUsage

var nativeOutputUsage: Int

nativePerformanceMode

var nativePerformanceMode: Int

nativeSampleRate

var nativeSampleRate: Int

outputEnabled

var outputEnabled: Boolean

Indicates whether the audio output is enabled on the audio engine. Default is true

outputUsage

var outputUsage: OutputUsage

Indicates the usage type of the output of the audio engine. Default is media

performanceMode

var performanceMode: PerformanceMode

Indicates the performance mode of the audio engine. Default is none

sampleRate

var sampleRate: Int

Indicates the sample rate of the audio engine in Hz. Default is 48000

Functions

open override fun close()

getCurrentInputLatencyMs

external fun getCurrentInputLatencyMs(): Double

Retrieves the current input latency of the audio stream.

getCurrentOutputLatencyMs

external fun getCurrentOutputLatencyMs(): Double

Retrieves the current output latency of the audio stream.

getInputBufferSizeMs

external fun getInputBufferSizeMs(): Double

Retrieves the size of the input buffer in milliseconds.

getOutputBufferSizeMs

external fun getOutputBufferSizeMs(): Double

Retrieves the size of the output buffer in milliseconds.

init

external fun init(sampleRate: Int, micInputPreset: Int, performanceMode: Int, outputUsage: Int, enableInput: Int, enableOutput: Int)

open fun init()

isLatencyDetectionSupported

external fun isLatencyDetectionSupported(): Boolean

Checks if latency detection is supported on the current device.

setInputAndOutputDeviceId

external fun setInputAndOutputDeviceId(inputId: Int, outputId: Int)

Sets the preferred input and output device id

start

external fun start(audioGraph: AudioGraph)

stop

external fun stop()