Core and lifecycle

Classes
struct	asdk::sdk_t
	SDK Core. More...

Typedefs
typedef void *	asdk::hsdk

Enumerations
enum	asdk::Status {   asdk::StatusUndef ,   asdk::StatusOK ,   asdk::StatusDisconnected ,   asdk::StatusError ,   asdk::StatusErrorHandle ,   asdk::StatusErrorVideoModule ,   asdk::StatusErrorImageModule ,   asdk::StatusErrorInitialized ,   asdk::StatusErrorConnect ,   asdk::StatusErrorTransmit ,   asdk::StatusErrorAudioModule ,   asdk::StatusErrorFile ,   asdk::StatusErrorNotPermitted }
	Result of an SDK call. More...

Functions
Status	asdk::sdk_t::Unload ()
	Unloads SDK library.
sdk_t *	asdk::Initialize ()
	Loads the SDK shared library and creates an SDK handle.

Variables
static const uint8_t	asdk::VERSION_MAJOR = 2
static const uint8_t	asdk::VERSION_MINOR = 0
static const uint8_t	asdk::VERSION_PATCH = 1

Detailed Description

Loading the shared library, the SDK handle, and the status codes returned by every call. Start at asdk::Initialize().

Typedef Documentation

hsdk

typedef void* asdk::hsdk

Opaque handle to a loaded shared library

Definition at line 127 of file asmirasdk.h.

Enumeration Type Documentation

Status

enum asdk::Status

Result of an SDK call.

Enumerator
StatusUndef	Undefined
StatusOK	General OK
StatusDisconnected	Disconnected from server
StatusError	General Error
StatusErrorHandle	SDK handle invalid or not initialized
StatusErrorVideoModule	Failed to load video module from disk
StatusErrorImageModule	Failed to load image module from disk
StatusErrorInitialized	Failed to initialize
StatusErrorConnect	Error on connect
StatusErrorTransmit	Error transmitting user request
StatusErrorAudioModule	Audio module missing or without the requested codec
StatusErrorFile	Local file cannot be read, is empty or too large
StatusErrorNotPermitted	The connected user's capability does not allow the operation

Definition at line 159 of file asmirasdk.h.

Function Documentation

Unload()

Status asdk::sdk_t::Unload ( )

inline

Unloads SDK library.

Returns

Status

Definition at line 958 of file asmirasdk.h.

References ASDK_FreeLib, library, asdk::StatusErrorHandle, and asdk::StatusOK.

Initialize()

sdk_t * asdk::Initialize ( )

inline

Loads the SDK shared library and creates an SDK handle.

Opens asmirasdk.dll on Windows and asmirasdk.so elsewhere, checks that the library reports the same major version this header was built against, and returns a ready handle. A differing minor version is accepted with a warning printed to stdout; a differing major version is refused.

Register the callbacks that matter before connecting, then call asdk_t::ConnectSecured. Release the handle with sdk_t::Unload().

Returns

A new SDK handle, or nullptr if the library is missing, does not export the expected entry points, or reports an incompatible major version.

Examples

example_basic.cpp, and example_complete.cpp.

Definition at line 1745 of file asmirasdk.h.

References ASDK_CALL, ASDK_FreeLib, ASDK_GetProc, ASDK_LoadLib, Initialize(), asdk::sdk_t::library, VERSION_MAJOR, and VERSION_MINOR.

Referenced by Initialize().

Variable Documentation

VERSION_MAJOR

const uint8_t asdk::VERSION_MAJOR = 2

static

SDK major version this header declares. asdk::Initialize() refuses a library that reports a different one.

Definition at line 132 of file asmirasdk.h.

Referenced by Initialize().

VERSION_MINOR

const uint8_t asdk::VERSION_MINOR = 0

static

SDK minor version this header declares. A library reporting a different one is accepted with a warning printed to stdout.

Definition at line 136 of file asmirasdk.h.

Referenced by Initialize().

VERSION_PATCH

const uint8_t asdk::VERSION_PATCH = 1

static

SDK patch version this header declares.

Definition at line 139 of file asmirasdk.h.