SDK Core. More...

#include <asmirasdk.h>

Public Types
typedef void(ASDK_CALL *	VersionProc) (uint8_t versionMajor, uint8_t versionMinor, uint8_t *versionPath)

Public Member Functions
Status	Unload ()
	Unloads SDK library.
Status	Connect (const char ip, const uint16_t port, const uint32_t timeout, const bool highLatency, const char username, const char password, const UserCapabilityValue userCapability, const DeviceCapabilityValue deviceCapability, const char displayName=nullptr)
	Connect to ASMIRA server.
Status	ConnectSecured (const char ip, const uint16_t port, const uint32_t timeout, const bool highLatency, const char username, const char password, const UserCapabilityValue userCapability, const DeviceCapabilityValue deviceCapability, const char certificate, const char *displayName=nullptr)
	Connect to ASMIRA server.
Status	RequestCertificate (const char address, const uint16_t port, const char userName, const char password, CertificateState certificateStateOut, certificate_t *certificateOut, const int timeout=3000)
	Request certificate from ASMIRA server.
Status	CachedCertificate (certificate_t *certificateOut)
	Get cached certificate from ASMIRA server.
Status	Disconnect ()
	Disconnects from ASMIRA server.
Status	SendRequest (const Request request)
	Sends request to ASMIRA server.
Status	SendRequestStr (const Request request, const char str, const char option=nullptr)
	Sends request string to ASMIRA server.
void	SetServerStateCallback (ServerStateFunc func, void *opaque=nullptr)
	Server state callback.
void	SetRoomAnnounceCallback (RoomAnnounceFunc func, void *opaque=nullptr)
	Server room announce callback.
void	SetRoomResponseCallback (RoomResponseFunc func, void *opaque=nullptr)
	Server room response callback.
void	SetRoomClientAddedCallback (RoomClientAddedFunc func, void *opaque=nullptr)
	Server room client added callback.
void	SetRoomClientRemovedCallback (RoomClientRemovedFunc func, void *opaque=nullptr)
	Server room client removed callback.
void	SetAuthenticateResponseCallback (AuthenticateResponseFunc func, void *opaque=nullptr)
	SetAuthenticateResponseCallback callback.
void	SetFrameCallback (FrameFunc func, void *opaque=nullptr)
	Video/Photo Frame callback.
void	SetEncodedStreamCallback (EncodedStreamFunc func, void *opaque=nullptr)
	Encoded Frame or stream callback.
void	SetEncodedAudioFrameCallback (EncodedAudioFrameFunc func, void *opaque=nullptr)
	Encoded Audio Frame callback.
void	SetVideoOptionsCallback (VideoOptionsFunc func, void *opaque=nullptr)
	Video Options callback.
void	SetVideoModeCallback (VideoModeFunc func, void *opaque=nullptr)
	Video Mode callback.
void	SetPositionValuesCallback (PositionValuesFunc func, void *opaque=nullptr)
	Position Values callback.
void	SetBandwidthStatisticsCallback (BandwidthStatisticsFunc func, void *opaque=nullptr)
	Bandwidth Statistics callback.
void	SetRoomPreviewImageCallback (RoomPreviewImageFunc func, void *opaque=nullptr)
	Room Preview Image callback.

Public Attributes
hsdk	library
hsdk	handle
char *	errorStr
Status	status

Detailed Description

SDK Core.

Contains SDK function interfaces

Definition at line 487 of file asmirasdk.h.

Member Typedef Documentation

◆ VersionProc

typedef void(ASDK_CALL * asdk::sdk_t::VersionProc) (uint8_t *versionMajor, uint8_t *versionMinor, uint8_t *versionPath)

Definition at line 488 of file asmirasdk.h.

Member Function Documentation

◆ CachedCertificate()

Status asdk::sdk_t::CachedCertificate ( certificate_t * certificateOut )

inline

Get cached certificate from ASMIRA server.

Parameters

Certificate data.

Returns: Status

Definition at line 600 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ Connect()

Status asdk::sdk_t::Connect	(	const char *	ip,
		const uint16_t	port,
		const uint32_t	timeout,
		const bool	highLatency,
		const char *	username,
		const char *	password,
		const UserCapabilityValue	userCapability,
		const DeviceCapabilityValue	deviceCapability,
		const char *	displayName = nullptr )

inline

Connect to ASMIRA server.

Parameters

Server	IP.
Server	port.
Timeout	in milliseconds.
High	latency client connection.
Server	login user name.
Server	login user password (as plaintext).
User	capability.
Device	capability.
Server	login user display name.

Returns: Status

Examples: example_complete.cpp.

Definition at line 528 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ ConnectSecured()

Status asdk::sdk_t::ConnectSecured	(	const char *	ip,
		const uint16_t	port,
		const uint32_t	timeout,
		const bool	highLatency,
		const char *	username,
		const char *	password,
		const UserCapabilityValue	userCapability,
		const DeviceCapabilityValue	deviceCapability,
		const char *	certificate,
		const char *	displayName = nullptr )

inline

Connect to ASMIRA server.

Parameters

Server	IP.
Server	port.
Timeout	in milliseconds. 9000 is recommended.
High	latency client connection.
Server	login user name.
Server	login user password (as plaintext).
User	capability.
Device	capability.
Server	login user display name.

Returns: Status

Examples: example_complete.cpp.

Definition at line 555 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ Disconnect()

Status asdk::sdk_t::Disconnect ( )

inline

Disconnects from ASMIRA server.

Returns: Status

Definition at line 612 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ RequestCertificate()

Status asdk::sdk_t::RequestCertificate	(	const char *	address,
		const uint16_t	port,
		const char *	userName,
		const char *	password,
		CertificateState *	certificateStateOut,
		certificate_t *	certificateOut,
		const int	timeout = 3000 )

inline

Request certificate from ASMIRA server.

Parameters

Server	IP.
Server	port.
Timeout	in milliseconds. 9000 is recommended.
Server	login user name.
Server	login user password.
Device	capability.
Certificate	string.
Optional	display name.

Returns: Status

Examples: example_complete.cpp.

Definition at line 582 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ SendRequest()

Status asdk::sdk_t::SendRequest ( const Request request )

inline

Sends request to ASMIRA server.

Parameters

Request value

Returns: Status

Examples: example_complete.cpp.

Definition at line 624 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ SendRequestStr()

Status asdk::sdk_t::SendRequestStr	(	const Request	request,
		const char *	str,
		const char *	option = nullptr )

inline

Sends request string to ASMIRA server.

Parameters

Request	value
String	value
String	optional value

Returns: Status

Examples: example_complete.cpp.

Definition at line 638 of file asmirasdk.h.

References asdk::StatusErrorHandle.

◆ SetAuthenticateResponseCallback()

void asdk::sdk_t::SetAuthenticateResponseCallback	(	AuthenticateResponseFunc	func,
		void *	opaque = nullptr )

inline

SetAuthenticateResponseCallback callback.

Parameters

AuthenticateResponseFunc callback

Examples: example_complete.cpp.

Definition at line 700 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetBandwidthStatisticsCallback()

void asdk::sdk_t::SetBandwidthStatisticsCallback	(	BandwidthStatisticsFunc	func,
		void *	opaque = nullptr )

inline

Bandwidth Statistics callback.

Parameters

SetBandwidthStatisticsCallback callback

Definition at line 770 of file asmirasdk.h.

◆ SetEncodedAudioFrameCallback()

void asdk::sdk_t::SetEncodedAudioFrameCallback	(	EncodedAudioFrameFunc	func,
		void *	opaque = nullptr )

inline

Encoded Audio Frame callback.

Parameters

EncodedAudioFrameFunc callback

Definition at line 730 of file asmirasdk.h.

◆ SetEncodedStreamCallback()

void asdk::sdk_t::SetEncodedStreamCallback	(	EncodedStreamFunc	func,
		void *	opaque = nullptr )

inline

Encoded Frame or stream callback.

Parameters

EncodedStreamFunc callback

Examples: example_complete.cpp.

Definition at line 720 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetFrameCallback()

void asdk::sdk_t::SetFrameCallback	(	FrameFunc	func,
		void *	opaque = nullptr )

inline

Video/Photo Frame callback.

Parameters

FrameFunc callback

Examples: example_complete.cpp.

Definition at line 710 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetPositionValuesCallback()

void asdk::sdk_t::SetPositionValuesCallback	(	PositionValuesFunc	func,
		void *	opaque = nullptr )

inline

Position Values callback.

Parameters

SetPositionValuesCallback callback

Definition at line 760 of file asmirasdk.h.

◆ SetRoomAnnounceCallback()

void asdk::sdk_t::SetRoomAnnounceCallback	(	RoomAnnounceFunc	func,
		void *	opaque = nullptr )

inline

Server room announce callback.

Parameters

RoomAnnounceFunc callback

Examples: example_complete.cpp.

Definition at line 660 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetRoomClientAddedCallback()

void asdk::sdk_t::SetRoomClientAddedCallback	(	RoomClientAddedFunc	func,
		void *	opaque = nullptr )

inline

Server room client added callback.

Parameters

RoomClientAddedFunc callback

Examples: example_complete.cpp.

Definition at line 680 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetRoomClientRemovedCallback()

void asdk::sdk_t::SetRoomClientRemovedCallback	(	RoomClientRemovedFunc	func,
		void *	opaque = nullptr )

inline

Server room client removed callback.

Parameters

RoomClientRemovedFunc callback

Examples: example_complete.cpp.

Definition at line 690 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetRoomPreviewImageCallback()

void asdk::sdk_t::SetRoomPreviewImageCallback	(	RoomPreviewImageFunc	func,
		void *	opaque = nullptr )

inline

Room Preview Image callback.

Parameters

SetRoomPreviewImageCallback callback

Examples: example_complete.cpp.

Definition at line 780 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetRoomResponseCallback()

void asdk::sdk_t::SetRoomResponseCallback	(	RoomResponseFunc	func,
		void *	opaque = nullptr )

inline

Server room response callback.

Parameters

RoomResponseFunc callback

Examples: example_complete.cpp.

Definition at line 670 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetServerStateCallback()

void asdk::sdk_t::SetServerStateCallback	(	ServerStateFunc	func,
		void *	opaque = nullptr )

inline

Server state callback.

Parameters

ServerStateFunc callback

Examples: example_complete.cpp.

Definition at line 650 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetVideoModeCallback()

void asdk::sdk_t::SetVideoModeCallback	(	VideoModeFunc	func,
		void *	opaque = nullptr )

inline

Video Mode callback.

Parameters

SetVideoModeCallback callback

Examples: example_complete.cpp.

Definition at line 750 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ SetVideoOptionsCallback()

void asdk::sdk_t::SetVideoOptionsCallback	(	VideoOptionsFunc	func,
		void *	opaque = nullptr )

inline

Video Options callback.

Parameters

VideoOptionsFunc callback

Examples: example_complete.cpp.

Definition at line 740 of file asmirasdk.h.

Referenced by main().

Here is the caller graph for this function:

◆ Unload()

Status asdk::sdk_t::Unload ( )

inline

Unloads SDK library.

Returns: Status

Definition at line 501 of file asmirasdk.h.

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

Member Data Documentation

◆ errorStr

char* asdk::sdk_t::errorStr

Last user generated error message.

Definition at line 493 of file asmirasdk.h.

◆ handle

hsdk asdk::sdk_t::handle

Internal SDK handle.

Definition at line 492 of file asmirasdk.h.

◆ library

hsdk asdk::sdk_t::library

Handle to this library.

Definition at line 491 of file asmirasdk.h.

Referenced by asdk::Initialize(), and Unload().

◆ status

Status asdk::sdk_t::status

Last user generated status.

Definition at line 494 of file asmirasdk.h.

The documentation for this struct was generated from the following file:

asmirasdk.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ VersionProc

Member Function Documentation

◆ CachedCertificate()

◆ Connect()

◆ ConnectSecured()

◆ Disconnect()

◆ RequestCertificate()

◆ SendRequest()

◆ SendRequestStr()

◆ SetAuthenticateResponseCallback()

◆ SetBandwidthStatisticsCallback()

◆ SetEncodedAudioFrameCallback()

◆ SetEncodedStreamCallback()

◆ SetFrameCallback()

◆ SetPositionValuesCallback()

◆ SetRoomAnnounceCallback()

◆ SetRoomClientAddedCallback()

◆ SetRoomClientRemovedCallback()

◆ SetRoomPreviewImageCallback()

◆ SetRoomResponseCallback()

◆ SetServerStateCallback()

◆ SetVideoModeCallback()

◆ SetVideoOptionsCallback()

◆ Unload()

Member Data Documentation

◆ errorStr

◆ handle

◆ library

◆ status