LeiaSR SDK 720218b2 v1.32.7.6322 2025-02-13T14:55:38Z
Stable
Classes | Macros | Typedefs | Functions
admin_c.h File Reference

Go to the source code of this file.

Classes

struct  SR_applicationList
 C-compatible struct to represent the contents of the std::vector<std::string> returned in the C++ interface. More...
 

Macros

#define SRAPI
 

Typedefs

typedef void * SRContext
 
typedef void * SR_applicationSense
 Application Programming Interface to be used by (Admin) C SR applications. More...
 

Functions

SRAPI SR_applicationSense createApplicationSense (SRContext context)
 Create an application sense instance to gain information about running SR applications. More...
 
SRAPI SR_applicationList getApplicationNames (SR_applicationSense applicationSense)
 Returns a list of applications that are currently connected to the SR Service. More...
 
SRAPI void cleanupApplicationList (SR_applicationList applicationList)
 Clears the memory allocated for the list of applications returned by getApplicationNames. More...
 

Macro Definition Documentation

◆ SRAPI

#define SRAPI

Typedef Documentation

◆ SR_applicationSense

typedef void* SR_applicationSense

Application Programming Interface to be used by (Admin) C SR applications.

◆ SRContext

typedef void* SRContext

Copyright (C) 2025 Leia, Inc.

Function Documentation

◆ cleanupApplicationList()

SRAPI void cleanupApplicationList ( SR_applicationList  applicationList)

Clears the memory allocated for the list of applications returned by getApplicationNames.

Parameters
anunmodified instance of SR_applicationList as returned by getApplicationNames

◆ createApplicationSense()

SRAPI SR_applicationSense createApplicationSense ( SRContext  context)

Create an application sense instance to gain information about running SR applications.

Parameters
contextis the environment in which created senses are kept track of
Returns
SR_applicationSense which is a pointer to an instance of the class with the underlying implementation

◆ getApplicationNames()

SRAPI SR_applicationList getApplicationNames ( SR_applicationSense  applicationSense)

Returns a list of applications that are currently connected to the SR Service.

Parameters
aSR_applicationSense pointer to the underlying implementation as returned by createApplicationSense
Returns
SR_applicationList with an array of null-terminated strings