Functions
AxisRuntimeErrors	Refract::AXIS::SetConfig (const AxisSDKConfig_t *config)
	SetConfig before calling Start.

AxisRuntimeErrors	Refract::AXIS::Start ()
	Start the SDK. Call SetConfig first.

AxisRuntimeErrors	Refract::AXIS::SendDongleCommand (const AxisDongleCommand_t *command)
	Sends a command to the dongle.

bool	Refract::AXIS::IsDongleConnected ()
	Check whether the dongle is connected or not.

AxisRuntimeErrors	Refract::AXIS::SearchForAxisHub (AxisHubInfoCallback callback)
	Search for Axis Hubs.

AxisRuntimeErrors	Refract::AXIS::GetHubInfoPageNumber (uint8_t pageNumber, AxisHubInfoCallback callback)
	Returns specific page of Refract::AXIS::AxisHubsInfo_t.

AxisRuntimeErrors	Refract::AXIS::IsAxisHubConnected (AxisRuntimeErrorCallback callback)
	Check whether the hub is connected or not.

AxisRuntimeErrors	Refract::AXIS::PairWithHub (const char *ipAddress, int port, AxisRuntimeErrorCallback callback)
	Pair with Hub.

AxisRuntimeErrors	Refract::AXIS::GetHubStatus (AxisHubStatusCallback callback)
	Get Hub Status.

AxisRuntimeErrors	Refract::AXIS::StartHubStream (AxisRuntimeErrorCallback callback)
	Tells connected Axis Hub to start streaming.

AxisRuntimeErrors	Refract::AXIS::StopHubStream (AxisRuntimeErrorCallback callback)
	Tells connected Axis Hub to stop streaming.

AxisRuntimeErrors	Refract::AXIS::ResetHubStream (AxisRuntimeErrorCallback callback)
	Tells connected Axis Hub to reset position tracking.

AxisRuntimeErrors	Refract::AXIS::SetHubLocation (AxisHubLocations location)
	Set the location of the Axis Hub (whether mounted on user's back or front)

AxisRuntimeErrors	Refract::AXIS::SetHipProviderMode (AxisHipProviderModes mode)
	Set where the sdk should get the hip information from.

AxisRuntimeErrors	Refract::AXIS::SetSteamVRTrackerProfile (const SteamVRTrackerProfile_t *trackers)
	Set which trackers for SteamVR are enabled/disabled.

AxisRuntimeErrors	Refract::AXIS::SetSteamVRUserHeight (float height)
	Set height for user which is used to guesstimate limb lengths.

AxisRuntimeErrors	Refract::AXIS::EnableSteamVR (const AxisSteamVRConfig_t *config)
	Enables SteamVR integration.

AxisRuntimeErrors	Refract::AXIS::DisableSteamVR ()
	Disables SteamVR integration.

void	Refract::AXIS::Stop ()
	Stop the SDK.

AxisRuntimeErrors	Refract::AXIS::EnableVRChatOSCOutput ()
	Enables output to VR Chat via OSC.

void	Refract::AXIS::DisableOSC ()
	Disables OSC output.

void	Refract::AXIS::SetVMCBoneConfig (AxisVMCBoneConfig_t *config)
	Sets which bones to output to OSC. Default is all on.

AxisRuntimeErrors	Refract::AXIS::SetHubIP (const char *ipAddress, int port)
	Set the IP of the Axis Hub.

Detailed Description

Function Documentation

◆ SetConfig()

AxisRuntimeErrors Refract::AXIS::SetConfig ( const AxisSDKConfig_t * config )

SetConfig before calling Start.

Parameters

config AxisSDKConfig_t

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::PacketCallbackNotSet if no packetCallback was set in the config

◆ Start()

AxisRuntimeErrors Refract::AXIS::Start ( )

Start the SDK. Call SetConfig first.

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::PacketCallbackNotSet if SetConfig has not been called yet

◆ SendDongleCommand()

AxisRuntimeErrors Refract::AXIS::SendDongleCommand ( const AxisDongleCommand_t * command )

Sends a command to the dongle.

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidDongleCommand if command was not configured properly; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet

◆ IsDongleConnected()

bool Refract::AXIS::IsDongleConnected ( )

Check whether the dongle is connected or not.

Returns: true if dongle is connected; false if dongle is not connected

◆ SearchForAxisHub()

AxisRuntimeErrors Refract::AXIS::SearchForAxisHub ( AxisHubInfoCallback callback )

Search for Axis Hubs.

Parameters

callback

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors.; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if callback is null; Refract::AXIS::AxisRuntimeErrors::NoLANAdapter if there was no LAN adapter that could be used to search for Axis Hubs; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs

◆ GetHubInfoPageNumber()

AxisRuntimeErrors Refract::AXIS::GetHubInfoPageNumber	(	uint8_t	pageNumber,
		AxisHubInfoCallback	callback )

Returns specific page of Refract::AXIS::AxisHubsInfo_t.

Parameters

pageNumber
callback

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors.; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if pageNumber is out of range or callback is null; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet

◆ IsAxisHubConnected()

AxisRuntimeErrors Refract::AXIS::IsAxisHubConnected ( AxisRuntimeErrorCallback callback )

Check whether the hub is connected or not.

Parameters

callback Refract::AXIS::AxisRuntimeErrors::OK, Refract::AXIS::AxisRuntimeErrors::HTTPError or Refract::AXIS::AxisRuntimeErrors::HTTPException

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors. Callback might be different result; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if callback is null; Refract::AXIS::AxisRuntimeErrors::InvalidIPAddress if hub IP has not been set; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs

◆ PairWithHub()

AxisRuntimeErrors Refract::AXIS::PairWithHub	(	const char *	ipAddress,
		int	port,
		AxisRuntimeErrorCallback	callback )

Pair with Hub.

Parameters

ipAddress	Pointer to null terminated string standard text format.
port
callback	callback with any errors. Refract::AXIS::AxisRuntimeErrors::OK if paired successfully.

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidIPAddress if ipAddress is invalid; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if port is invalid or callback is null; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs; Refract::AXIS::AxisRuntimeErrors::NoSubnet if there was no lan adapter matching the ipAddress given

◆ GetHubStatus()

AxisRuntimeErrors Refract::AXIS::GetHubStatus ( AxisHubStatusCallback callback )

Get Hub Status.

Parameters

callback

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidIPAddress if no paired hub; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if callback is null; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs

◆ StartHubStream()

AxisRuntimeErrors Refract::AXIS::StartHubStream ( AxisRuntimeErrorCallback callback )

Tells connected Axis Hub to start streaming.

Parameters

callback Refract::AXIS::AxisRuntimeErrors::OK, Refract::AXIS::AxisRuntimeErrors::HTTPError or Refract::AXIS::AxisRuntimeErrors::HTTPException

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if callback is null; Refract::AXIS::AxisRuntimeErrors::InvalidIPAddress if hub IP has not been set; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs

◆ StopHubStream()

AxisRuntimeErrors Refract::AXIS::StopHubStream ( AxisRuntimeErrorCallback callback )

Tells connected Axis Hub to stop streaming.

Parameters

callback Refract::AXIS::AxisRuntimeErrors::OK, Refract::AXIS::AxisRuntimeErrors::HTTPError or Refract::AXIS::AxisRuntimeErrors::HTTPException

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if callback is null; Refract::AXIS::AxisRuntimeErrors::InvalidIPAddress if hub IP has not been set; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs

◆ ResetHubStream()

AxisRuntimeErrors Refract::AXIS::ResetHubStream ( AxisRuntimeErrorCallback callback )

Tells connected Axis Hub to reset position tracking.

Parameters

callback

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if callback is null; Refract::AXIS::AxisRuntimeErrors::InvalidIPAddress if hub IP has not been set; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet; Refract::AXIS::AxisRuntimeErrors::PreviousOpInProgress if Stop() was called and there are still requests pending; Refract::AXIS::AxisRuntimeErrors::SocketException if there was an error creating the sockets needed connecting with Axis Hubs

◆ SetHubLocation()

AxisRuntimeErrors Refract::AXIS::SetHubLocation ( AxisHubLocations location )

Set the location of the Axis Hub (whether mounted on user's back or front)

Parameters

location

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if location is not valid

◆ SetHipProviderMode()

AxisRuntimeErrors Refract::AXIS::SetHipProviderMode ( AxisHipProviderModes mode )

Set where the sdk should get the hip information from.

Parameters

mode

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if mode is not valid

◆ SetSteamVRTrackerProfile()

AxisRuntimeErrors Refract::AXIS::SetSteamVRTrackerProfile ( const SteamVRTrackerProfile_t * trackers )

Set which trackers for SteamVR are enabled/disabled.

Parameters

trackers

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if trackers is null

◆ SetSteamVRUserHeight()

AxisRuntimeErrors Refract::AXIS::SetSteamVRUserHeight ( float height )

Set height for user which is used to guesstimate limb lengths.

Parameters

height Unit is centimeters.

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if height is negative / NaN

◆ EnableSteamVR()

AxisRuntimeErrors Refract::AXIS::EnableSteamVR ( const AxisSteamVRConfig_t * config )

Enables SteamVR integration.

Parameters

config

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::InvalidParameter if config is null; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet

◆ DisableSteamVR()

AxisRuntimeErrors Refract::AXIS::DisableSteamVR ( )

Disables SteamVR integration.

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet

◆ EnableVRChatOSCOutput()

AxisRuntimeErrors Refract::AXIS::EnableVRChatOSCOutput ( )

Enables output to VR Chat via OSC.

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::SDKNotStarted if Start has not been called yet

◆ SetVMCBoneConfig()

void Refract::AXIS::SetVMCBoneConfig ( AxisVMCBoneConfig_t * config )

Sets which bones to output to OSC. Default is all on.

Parameters

config Setting null here will set the config to default.

◆ SetHubIP()

AxisRuntimeErrors Refract::AXIS::SetHubIP	(	const char *	ipAddress,
		int	port )

Set the IP of the Axis Hub.

Parameters

ipAddress	Pointer to null terminated string standard text format.
port

Returns: Refract::AXIS::AxisRuntimeErrors::OK if no errors; Refract::AXIS::AxisRuntimeErrors::Invalid IP if IP is not valid

Functions

Detailed Description

Function Documentation

◆ SetConfig()

◆ Start()

◆ SendDongleCommand()

◆ IsDongleConnected()

◆ SearchForAxisHub()

◆ GetHubInfoPageNumber()

◆ IsAxisHubConnected()

◆ PairWithHub()

◆ GetHubStatus()

◆ StartHubStream()

◆ StopHubStream()

◆ ResetHubStream()

◆ SetHubLocation()

◆ SetHipProviderMode()

◆ SetSteamVRTrackerProfile()

◆ SetSteamVRUserHeight()

◆ EnableSteamVR()

◆ DisableSteamVR()

◆ EnableVRChatOSCOutput()

◆ SetVMCBoneConfig()

◆ SetHubIP()