Classes
class	Al

class	AlSession

struct	AlSessionConfig
	Accent Localization session configuration used for int16 and float session creation. More...

struct	BvcConfig
	Background Voice cancelation configuration. More...

struct	EnergyInfo
	Audio frame energy information struct describing noise/voice energy values. More...

struct	ModelInfo
	Model Info containing path to the model or it's content blob. More...

class	Nc
	AI technology removes background noises, reverb, and background voices from the main speaker's voice in real-time, while also providing noise and voice statistics for the audio stream and frame. More...

class	NcSession

struct	NcSessionConfig
	NC session configuration. More...

struct	NcSessionConfigWithAutoModelSelect
	NC/BVC autoselect session configuration. More...

struct	NoiseStats
	Noise stats based on the noise intensity levels. More...

struct	PerFrameStats
	Per-frame information returned after NC processing of the given frame. More...

struct	RingtoneCfg
	Ringtone configuration used with inbound NC models to keep ringtones. More...

struct	SessionStats
	NC stats containing noise and voice information. More...

struct	VersionInfo
	Version information. More...

struct	VoiceStats
	Voice stats. More...

Enumerations
enum class	SamplingRate { Sr8000Hz = 8000 , Sr16000Hz = 16000 , Sr24000Hz = 24000 , Sr32000Hz = 32000 , Sr44100Hz = 44100 , Sr48000Hz = 48000 , Sr88200Hz = 88200 , Sr96000Hz = 96000 }
	Sampling frequency of the audio frame.

enum class	FrameDuration { Fd10ms = 10 }
	Input audio frame duration in ms.

enum class	CleanedSecondarySpeechStatus { Undefined = 0 , Detected = 1 , NotDetected = 2 }
	Cleaned secondary speech status enum. More...

Functions
KRISP_AUDIO_API void	globalInit (const std::wstring &workingPath)
	Initializes the global data needed for the SDK.

KRISP_AUDIO_API void	globalDestroy ()
	Frees all the global resources allocated by SDK.

KRISP_AUDIO_API void	getVersion (VersionInfo &versionInfo)
	Populates the versionInfo structure with API version information upon successful completion.

Detailed Description

Copyright Krisp, Inc

Enumeration Type Documentation

strong

Cleaned secondary speech status enum.

Enumerator
Undefined	Cleaned secondary speech algorithm is not available (if non BVC model provided)
Detected	Cleaned secondary speech detected in the processed frame.
NotDetected	Cleaned secondary speech is not detected in the processed frame.

KRISP_AUDIO_API void Krisp::AudioSdk::getVersion ( VersionInfo & versionInfo )

Populates the versionInfo structure with API version information upon successful completion.

Parameters

[in,out] versionInfo The structure that gets populated upon successful completion of this call.

Exceptions

Throws std exception in case of error.

KRISP_AUDIO_API void Krisp::AudioSdk::globalDestroy ( )

Frees all the global resources allocated by SDK.

Exceptions

Throws std exception in case of error.

KRISP_AUDIO_API void Krisp::AudioSdk::globalInit ( const std::wstring & workingPath )

Initializes the global data needed for the SDK.

Parameters

[in] workingPath The path to the working directory. Can be empty for using default execution directory.

Exceptions

Throws std exception in case of error.