SDK Version 2.0.1
AnsuR Technologies ASMIRA SDK
Loading...
Searching...
No Matches
asdk::sdk_t Struct Reference

SDK Core. More...

#include <asmirasdk.h>

Public Types

typedef void(*) 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.
Status SendChatMessage (const char *message)
 Sends a chat message to the currently joined room.
Status SendAudioFrame (const int16_t *samples, const uint32_t sampleCount, const uint32_t timeStamp=0)
 Encodes and sends captured audio to the currently joined room.
Status SendEncodedAudioFrame (const void *data, const uint32_t size, const uint32_t timeStamp, const AudioFrameStateValue state)
 Sends an already encoded audio frame to the currently joined room.
Status FlushAudioFrames ()
 Sends the audio frames still held back by the transmit queue.
Status SetAudioOptions (const audio_options_t *audioOptions)
 Sets the audio encoder options.
Status AudioOptions (audio_options_t *audioOptions)
 Gets the audio options in effect.
Status RoomFileSend (const uint32_t roomID, const char *fileName, const void *data, const uint32_t size)
 Uploads a file to a room from memory.
Status RoomFileSendFromPath (const uint32_t roomID, const char *filePath)
 Uploads a file to a room from disk.
Status RoomFileSendResumeFromPath (const uint32_t roomID, const char *filePath)
 Resumes an interrupted upload of a file from disk.
Status RoomFileDownload (const uint32_t roomID, const uint64_t hash)
 Downloads a room file announced by RoomFileAvailableFunc.
Status RoomFileDownloadResume (const uint32_t roomID, const uint64_t hash, const char *fileName, const uint32_t totalSize, const void *haveBytes, const uint32_t haveCount)
 Resumes a room file download the caller already has part of.
Status RoomFileCancel (const uint32_t roomID, const uint64_t hash)
 Cancels a room file transfer in either direction.
Status RoomFileDelete (const uint32_t roomID, const uint64_t hash)
 Deletes a shared room file for the whole room.
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)
 Login result 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.
void SetChatMessageCallback (ChatMessageFunc func, void *opaque=nullptr)
 Chat message callback.
void SetDecodedAudioFrameCallback (DecodedAudioFrameFunc func, void *opaque=nullptr)
 Decoded Audio Frame callback.
void SetRoomFileAvailableCallback (RoomFileAvailableFunc func, void *opaque=nullptr)
 Room File Available callback.
void SetRoomFileDeletedCallback (RoomFileDeletedFunc func, void *opaque=nullptr)
 Room File Deleted callback.
void SetRoomFileDownloadedCallback (RoomFileDownloadedFunc func, void *opaque=nullptr)
 Room File Downloaded callback.
void SetRoomFileProgressCallback (RoomFileProgressFunc func, void *opaque=nullptr)
 Room File Progress callback.
void SetRoomFileSentCallback (RoomFileSentFunc func, void *opaque=nullptr)
 Room File Sent callback.
void SetRoomFileErrorCallback (RoomFileErrorFunc func, void *opaque=nullptr)
 Room File Error callback.

Public Attributes

hsdk library
hsdk handle
char * errorStr
Status status

Detailed Description

SDK Core.

The handle returned by asdk::Initialize(). Every SDK operation is a member of this structure; call asdk::sdk_t::Unload() when done with it.

Examples
example_basic.cpp.

Definition at line 943 of file asmirasdk.h.

Member Typedef Documentation

◆ VersionProc

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

Definition at line 944 of file asmirasdk.h.

Member Data Documentation

◆ library

hsdk asdk::sdk_t::library

Handle to this library.

Definition at line 947 of file asmirasdk.h.

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

◆ handle

hsdk asdk::sdk_t::handle

Internal SDK handle.

Definition at line 948 of file asmirasdk.h.

◆ errorStr

char* asdk::sdk_t::errorStr

Last user generated error message.

Definition at line 949 of file asmirasdk.h.

◆ status

Status asdk::sdk_t::status

Last user generated status.

Definition at line 950 of file asmirasdk.h.


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