sdk_factory.h File Reference

#include "audio_format.h"
#include "pipeline.h"

Go to the source code of this file.

Classes
class	audio_effects_sdk::IAuthResult
	Contains authorization process results. More...
class	audio_effects_sdk::ISDKFactory
	SDK entry point for creating pipelines and handling authorization. More...

Macros
#define	AESDK_CALLBACK   __cdecl
#define	AESDK_API_EXPORT   __declspec(dllexport)
#define	AESDK_API_DECL   __cdecl

Typedefs
typedef void(AESDK_CALLBACK *	audio_effects_sdk::pfnOnAuthCompletedCallback) (IAuthResult *result, void *ctx)
	Callback triggered when the authorization process is complete.

Enumerations
enum	audio_effects_sdk::AuthStatus : int { audio_effects_sdk::error = 0 , audio_effects_sdk::active = 1 , audio_effects_sdk::inactive = 2 , audio_effects_sdk::expired = 3 }
	Describes result of authorization process. More...

Functions
AESDK_API_EXPORT audio_effects_sdk::ISDKFactory *AESDK_API_DECL	createAudioEffectsSDKFactory ()
	Creates an instance of ISDKFactory.

Typedef Documentation

pfnOnAuthCompletedCallback

typedef void(AESDK_CALLBACK * audio_effects_sdk::pfnOnAuthCompletedCallback) (IAuthResult *result, void *ctx)

Callback triggered when the authorization process is complete.

Parameters

result	The result of authorization process. DO NOT call IAuthResult::release() on this instance.
ctx	Opaque pointer passed to ISDKFactory::auth()

Enumeration Type Documentation

AuthStatus

enum audio_effects_sdk::AuthStatus : int

Describes result of authorization process.

Enumerator
error	Authorization finished with error (e.g., missing internet connection).
active	Authorization finished successfully, the SDK can be used.
inactive	Such customer has no license or the license revoked.
expired	The license is expired.