vrcc.h File Reference

Voisus Remote Control Client (VRCC) Interface. More...

Functions
int	VRCC_Start (int argc, char *argv[])
	Starts the VRC messaging client. More...
void	VRCC_Shutdown ()
	Shuts down the VRC messaging client. More...
int	VRCC_Update (void)
	Update the internal state of the VRC Client. More...
void	Voisus_ConnectServer (const char *target_ip)
	Connects to a Voisus Server. More...
void	Voisus_Disconnect ()
	Disconnects from a Voisus Server. More...
int	Voisus_Error ()
	Gets current Voisus error state. More...
void	Voisus_Save ()
	Saves current client configuration to file. More...
const char *	Voisus_LogPath ()
	Gets the path to the Voisus client log file. More...
const char *	Voisus_ClientBuildVersion ()
	Gets the build version of the Voisus client. More...
const char *	Voisus_ClientMsgVersion ()
	Gets the version of the Voisus client message protocol. More...
const char *	Voisus_ClientMsgDate ()
	Gets the timestamp of the Voisus client message protocol. More...
const char *	Voisus_ServerBuildVersion ()
	Gets the build version of the Voisus server. More...
const char *	Voisus_ServerMsgVersion ()
	Gets the version of the Voisus server message protocol. More...
const char *	Voisus_ServerMsgDate ()
	Gets the timestamp of the Voisus server message protocol. More...
void	Voisus_MonitorPowerEvents (int hwnd)
	Monitors for system power events (on Windows XP/Vista/7/8) More...
void	Voisus_SetServerMasterVolume (float volume)
	Sets the master volume on the server. More...
void	Voisus_SetServerSidetoneVolume (float volume)
	Sets the sidetone volume on the server. More...
const char *	Network_TargetIP ()
	Gets the Voisus Server address. More...
const char *	Network_ClientIP ()
	Gets the Client address used to connect to the Server. More...
int	Network_ConnectionStatus ()
	Gets the connection status of client. More...
int	Network_ConnectState ()
	Gets the detailed connection state of the client. More...
const char *	Network_ClientName ()
	Gets the user-settable client name. More...
void	Network_SetClientName (const char *name)
	Sets the client name. More...
const char *	Network_OperatorId ()
	Gets the unique ID of the Operator. More...
const char *	Network_CloudSet ()
	Gets the last set Cloud to connect to. More...
const char *	Network_CloudActive ()
	Gets the currently connected Cloud. More...
int	Network_ConnectionMode ()
	Get the current connection mode (e.g. Cloud) More...
int	Role_ListCount ()
	Gets the total number of Roles available to the client. More...
int	Role_Version ()
	Gets the version count of Role updates. More...
const char *	Role_Name (int list_index)
	Gets the name of a specified Role. More...
const char *	Role_Id (int list_index)
	Gets the unique ID of a specified Role. More...
const char *	Role_NameActive ()
	Gets the name of the current Role. More...
const char *	Role_IdActive ()
	Gets the unique ID of the current Role. More...
const char *	Role_NameSet ()
	Gets the name of the last-set Role. More...
const char *	Role_IdSet ()
	Gets the unique ID of the last-set Role. More...
int	Role_AutotuneEnabled (const char *role_id)
	Gets whether autotune ability is enabled for a role. More...
int	Role_RadCtrlEnabled (const char *role_id)
	Gets whether live radio control ability is enabled for a role. More...
void	Role_SetRole (const char *role_id)
	Sets a new Role to connect with. More...
int	Role_CallingEnabled (const char *role_id)
	Gets whether calling is enabled for a role. More...
int	Role_CallPTTEnabled (const char *role_id)
	Gets whether PTT is required to transmit audio on a call. More...
int	Role_ChatEnabled (const char *role_id)
	Gets whether chat is enabled for a role. More...
int	Role_ChannelDisplayMap (const char *role_id, int index)
	Get the channel index to display at a given offset. More...
int	EntityState_ListCount ()
	Gets the total number of Entity States (Vehicles) available to the client. More...
int	EntityState_Version ()
	Gets the version count of Entity State updates. More...
const char *	EntityState_Name (int list_index)
	Gets the name of a specified Entity State (Vehicle) More...
const char *	EntityState_Id (int list_index)
	Gets the unique ID of a specified Entity State (Vehicle) More...
const char *	EntityState_NameActive ()
	Gets the name of the current Entity State (Vehicle) More...
const char *	EntityState_IdActive ()
	Gets the unique ID of the currently selected Entity State. More...
const char *	EntityState_NameSet ()
	Gets the name of the last-set Entity State. More...
const char *	EntityState_IdSet ()
	Gets the unique ID of the last-set Entity State (Vehicle) More...
void	EntityState_SetEntityState (const char *id)
	Sets a new Entity State (Vehicle) to connect with. More...
float	Headset_VoxThreshold ()
	Gets the vox threshold. More...
int	Headset_MicrophoneMode ()
	Gets the microphone mode. More...
float	Headset_EarphoneVolume ()
	Gets the earphone volume. More...
float	Headset_MicVolume ()
	Gets the microphone volume. More...
float	Headset_SidetoneVolume ()
	Gets the sidetone volume. More...
int	Headset_HasSidetone ()
	Gets whether headset has sidetone. More...
void	Headset_SetHeadsetPreset (int preset)
	Selects from a preset headset configuration. More...
void	Headset_SetVoxThreshold (float threshold)
	Sets the vox threshold. More...
void	Headset_SetMicrophoneMode (int mode)
	Sets the microphone mode. More...
void	Headset_SetCallMicrophoneMute (int active)
	Sets the microphone mute during an active call. More...
void	Headset_SetEarphoneVolume (float volume)
	Sets the earphone volume. More...
void	Headset_SetMicVolume (float volume)
	Sets the microphone volume. More...
void	Headset_SetSidetoneVolume (float volume)
	Sets the sidetone volume. More...
int	Headset_DeviceConfigured ()
	Gets whether client successfully configure an audio device. More...
void	PTT_SetPressed_Multi (int ptt, int pressed)
	Sets the software push-to-talk (PTT) state for a given PTT. More...
void	PTT_SetPressed (int pressed)
	Sets the software push-to-talk (PTT) state for primary PTT. More...
int	PTT_GetPressed_Multi (int ptt)
	Gets the current pressed state of a specified software push-to-talk (PTT) More...
int	PTT_GetPressed ()
	Gets the current pressed state of the primary software push-to-talk (PTT) state. More...
int	PTT_HWGetPressed_Multi (int ptt)
	Gets the current hardware push-to-talk (PTT) state (multiple) More...
int	PTT_HWGetPressed ()
	Gets the current hardware push-to-talk (PTT) state. More...
int	Radio_ListCount ()
	Gets the current number of radios. More...
const char *	Radio_Name (int radio_index)
	Gets the name of a radio. More...
void	Radio_SetNet (int radio_index, int net_index)
	Sets the net for a radio by index. More...
void	Radio_SetNetRxFrequency (int radio_index, const char *net_id, unsigned long long freq)
	Override the receive frequency for a net assigned to a particular radio. More...
unsigned long long	Radio_NetRxFrequencyActive (int radio_index)
	Get the receive frequency for the currently tuned net of a radio. More...
void	Radio_SetNetTxFrequency (int radio_index, const char *net_id, unsigned long long freq)
	Override the transmit frequency for a net assigned to a particular radio. More...
unsigned long long	Radio_NetTxFrequencyActive (int radio_index)
	Get the transmit frequency for the currently tuned net of a radio. More...
void	Radio_SetNetCrypto (int radio_index, const char *net_id, int system, int key)
	Override the crypto settings for a net assigned to a particular radio. More...
int	Radio_NetCryptoSystemActive (int radio_index)
	Get the crypto system for the currently tuned net of a radio. More...
int	Radio_NetCryptoKeyActive (int radio_index)
	Get the crypto key for the currently tuned net of a radio. More...
int	Radio_NetCryptoEnabledActive (int radio_index)
	Get the crypto enable state for the currently tuned net of a radio. More...
const char *	Radio_NetWaveformActive (int radio_index)
	Get the waveform (mode) for the currently tuned net of a radio. More...
void	Radio_SetNetID (int radio_index, const char *net_id)
	Sets the net for a radio by unique ID. More...
int	Radio_NetListCount (int radio_index)
	Gets the number of nets for a radio. More...
const char *	Radio_NetName (int radio_index, int net_index)
	Gets the name of a net by index for a radio. More...
const char *	Radio_NetNameActive (int radio_index)
	Gets the name of currently selected net for a radio. More...
const char *	Radio_NetID (int radio_index, int net_index)
	Gets the unique ID of a net for a radio. More...
unsigned long long	Radio_NetFrequency (int radio_index, int net_index)
	Gets the frequency of the radio's net. More...
const char *	Radio_NetWaveform (int radio_index, int net_index)
	Gets the waveform of the radio's net. More...
int	Radio_NetCryptoSystem (int radio_index, int net_index)
	Gets the crypto system of the radio's net. More...
int	Radio_NetCryptoKey (int radio_index, int net_index)
	Gets the crypto key of the radio's net. More...
int	Radio_NetCryptoEnabled (int radio_index, int net_index)
	Gets the crypto enabled of the radio's net. More...
int	Radio_NetFreqHopNetId (int radio_index, int net_index)
	Gets the Net ID (for Frequency Hop nets only) More...
int	Radio_NetSatcomChannel (int radio_index, int net_index)
	Gets the SATCOM channel of the radio's net. More...
int	Radio_NetTuningMethod (int radio_index, int net_index)
	Gets the tuning method of the radio's net. More...
const char *	Radio_NetIDActive (int radio_index)
	Gets the unique ID of currently selected net for a radio. More...
void	Radio_SetReceiveEnabled (int radio_index, int enable)
	Sets the receive enable for a radio. More...
void	Radio_SetTransmitEnabled (int radio_index, int enable)
	Sets the transmit enable for a radio. More...
void	Radio_SetCryptoEnable (int radio_index, int enable)
	Sets the crypto enable state for a radio. More...
void	Radio_SetVolume (int radio_index, float volume)
	Sets the receive volume for a radio. More...
void	Radio_SetVolumeStereo (int radio_index, float volume_left, float volume_right)
	Sets the stereo receive volumes for a radio. More...
void	Radio_SetBalance (int radio_index, int balance)
	Sets the audio balance for a radio. More...
void	Radio_SetPTT (int radio_index, int ptt_index)
	Sets the PTT to use for a radio. More...
void	Radio_SetRadioEffects (int radio_index, const char *effects_id)
	Sets the radio effects for a radio. More...
int	Radio_IsReceiveEnabled (int radio_index)
	Gets the receive enable for a radio. More...
int	Radio_IsTransmitEnabled (int radio_index)
	Gets the transmit enable for a radio. More...
int	Radio_IsReceiving (int radio_index)
	Gets the receive state for a radio. More...
int	Radio_IsTransmitting (int radio_index)
	Gets the transmit state for a radio. More...
int	Radio_IsShared (int radio_index)
	Gets whether a radio is shared by two or more operators. Shared radios are accessed through Entity States (Vehicles). More...
float	Radio_Volume (int radio_index)
	Gets the receive volume for a radio. More...
float	Radio_VolumeStereoLeft (int radio_index)
	Gets the stereo (left ear) receive volume for a radio. More...
float	Radio_VolumeStereoRight (int radio_index)
	Gets the stereo (right ear) receive volume for a radio. More...
int	Radio_IsNetLocked (int radio_index)
	Gets whether net selection is locked for a radio. More...
int	Radio_IsRXModeLocked (int radio_index)
	Gets whether the RX enable is locked for a radio. More...
int	Radio_IsTXModeLocked (int radio_index)
	Gets whether the TX enable is locked for a radio. More...
int	Radio_Balance (int radio_index)
	Gets the audio balance for a radio (left, right, center) More...
int	Radio_BalanceLocked (int radio_index)
	Gets whether balance selection is locked for a radio. More...
const char *	Radio_Type (int radio_index)
	Gets the type of radio (e.g. URC-200) More...
int	Radio_CryptoEnabled (int radio_index)
	Gets whether radio has crypto mode enabled. More...
int	Radio_Version ()
	Gets the version count for radio updates. More...
int	Radio_PTT (int radio_index)
	Gets the PTT identifier for the radio. More...
const char *	Radio_RadioEffects (int radio_index)
	Gets the radio effects set for a radio. More...
int	Radio_RadioEffectsLocked (int radio_index)
	Gets whether radio effects selection is locked for a radio. More...
const char *	Radio_RadCtrlId (int radio_index)
	Gets the Radio Control Id of a radio configured to control live radios. More...
float	Radio_AudioLevel (int radio_index)
	Gets the audio level of a radio. More...
int	Radio_AudioLevelEnabled (int radio_index)
	Gets whether audio level calculation is enabled for a radio. More...
void	Radio_SetAudioLevelEnable (int radio_index, int enable)
	Enables or disables audio level calculation for a radio. More...
void	Radio_SetPlaysound (int radio_index, const char *playsound_id)
	Enables or disables background playsound mixed into mic audio for this radio. More...
const char *	Radio_Playsound (int radio_index)
	Gets the unique ID of sound mixed into mic audio for this radio. More...
int	Radio_PlaysoundLocked (int radio_index)
	Gets whether background playsound selection is locked for a radio. More...
int	Radio_ScanEnabled (int radio_index)
	Gets whether scanner is enabled for a radio. More...
int	Radio_ScanActive (int radio_index)
	Gets whether scanner is actively scanning for a radio. More...
float	Radio_ScanHoldTime (int radio_index)
	Gets the hold time for a scanner. More...
float	Radio_ScanHangTime (int radio_index)
	Gets the hang time for a scanner. More...
int	Radio_ScanPlanActive (int radio_index)
	Gets the index of the scan plan in use for a scanner. More...
int	Radio_ScanNetListMax (int radio_index)
	Gets the maximum number of nets for a scan list in a plan. More...
int	Radio_ScanPlanListCount (int radio_index)
	Gets the count of scan plans for a scanner. More...
int	Radio_ScanPlanNetListCount (int radio_index, int plan_index)
	Gets the count of nets in a scan plan for a scanner. More...
const char *	Radio_ScanPlanNetName (int radio_index, int plan_index, int net_index)
	Gets the name of a net in a scan plan net list. More...
const char *	Radio_ScanPlanNetID (int radio_index, int plan_index, int net_index)
	Gets the unique ID of a net in a scan plan net list. More...
const char *	Radio_ScanPlanPriorityTxNetName (int radio_index, int plan_index)
	Gets the name of the priority transmit net for a scanner. More...
const char *	Radio_ScanPlanPriorityTxNetID (int radio_index, int plan_index)
	Gets the unique ID of the priority transmit net for a scanner. More...
int	Radio_ScanPlanPriorityRxNetListCount (int radio_index, int plan_index)
	Gets the count of priority receive nets in a scan plan for a scanner. More...
const char *	Radio_ScanPlanPriorityRxNetName (int radio_index, int plan_index, int rx_index)
	Gets the name of a priority receive net for a scanner. More...
const char *	Radio_ScanPlanPriorityRxNetID (int radio_index, int plan_index, int rx_index)
	Gets the unique ID of a priority receive net for a scanner. More...
int	Radio_ScanPlanInvalidNets (int radio_index, int plan_index)
	Gets whether there are invalid nets in the scan plan. More...
void	Radio_SetScanEnable (int radio_index, int enable)
	Enables or disables a radio scanner. More...
void	Radio_StartScan (int radio_index)
	Starts scanning. More...
void	Radio_StopScan (int radio_index)
	Stops scanning and return to manual scanning mode. More...
void	Radio_ScanNext (int radio_index)
	Changes to next net in scan list (manual scanning) More...
void	Radio_ScanPrev (int radio_index)
	Changes to previous net in scan list (manual scanning) More...
void	Radio_SetScanHoldTime (int radio_index, float seconds)
	Sets the hold time for a scanner. More...
void	Radio_SetScanHangTime (int radio_index, float seconds)
	Sets the hang time for a scanner. More...
void	Radio_SetScanPlanActive (int radio_index, int plan_index)
	Sets the active scan plan for a scanner. More...
void	Radio_SetScanPlanPriorityTx (int radio_index, int plan_index, const char *net_id)
	Sets the priority transmit net for a scanner. More...
void	Radio_SetScanPlanPriorityRx (int radio_index, int plan_index, int rx_index, const char *net_id)
	Sets a priority receive net for a scanner. More...
void	Radio_AppendScanPlanNet (int radio_index, int plan_index, const char *net_id)
	Appends a net to a scan plan net list. More...
void	Radio_RemoveScanPlanNet (int radio_index, int plan_index, int net_index)
	Removes a net from a scan plan net list. More...
const char *	Net_Name (const char *net_id)
	Gets the name of a net using the unique ID. More...
void	Log_Write (const char *function, const char *msg)
	Writes a message to the Voisus client log. More...
void	Earshot_Enable (int enable)
	Enable Earshot support. More...
void	Earshot_SetPTT (int ptt)
	Sets the Earshot push-to-talk (PTT) state. More...
int	Earshot_Receiving (void)
	Gets the receive state for Earshot. More...
int	Earshot_Transmitting (void)
	Gets the transmit state for Earshot. More...
void	WorldPosition_Set (float xcoord, float ycoord, float zcoord)
	Sets the world position for a Voisus operator. More...
int	Joystick_ListCount ()
	Gets the current number of detected joysticks. More...
const char *	Joystick_Name (int list_index)
	Gets the name of a specified joystick. More...
int	Joystick_ButtonCount (int list_index)
	Gets the number of buttons for a specified joystick. More...
int	Joystick_Active_Multi (int ptt)
	Gets the active joystick index for a specified PTT. More...
int	Joystick_Active ()
	Gets the active joystick index. More...
int	Joystick_ButtonActive_Multi (int ptt)
	Gets the active joystick button index. More...
int	Joystick_ButtonActive ()
	Gets the active joystick button index. More...
int	Joystick_Pressed_Multi (int ptt)
	Gets the current joystick pressed state. More...
int	Joystick_Pressed ()
	Gets the current joystick pressed state. More...
void	Joystick_SetButton_Multi (int ptt, int js, int btn)
	Selects the active joystick button. More...
void	Joystick_SetButton (int js, int btn)
	Selects the active joystick button. More...
int	Codec_Get ()
	Gets currently selected Codec. More...
void	Codec_Set (int codec)
	Sets a new Codec. More...
void	Call_GetLock ()
	Gets the lock on all Call and Endpoint data. More...
void	Call_ReleaseLock ()
	Releases the lock on all Call and Endpoint data. More...
const char *	Call_Create ()
	Create a new call and join it. More...
void	Call_Invite (const char *call_id, const char *endpoint_id)
	Send an invitation to another endpoint. More...
void	Call_Invite_Dial (const char *call_id, const char *endpoint_id, const char *dial_number)
	Send an invitation to an endpoint to dial a phone number. More...
void	Call_InviteCrew ()
	Invite all members of crew to a call. More...
const char *	Call_IDFirst ()
	Get the first call in set of calls for this endpoint. More...
const char *	Call_IDNext ()
	Get the next call in set of calls for this endpoint. More...
int	Call_ListCount ()
	Get the size of the set of calls for this endpoint. More...
int	Call_Endpoint_Version ()
	Gets the version count for call and endpoint updates. More...
const char *	Call_Endpoint_IDFirst (const char *call_id)
	Get the first Endpoint for a call. More...
const char *	Call_Endpoint_IDNext (const char *call_id)
	Get the next Endpoint for a call. More...
int	Call_Endpoint_State (const char *call_id, const char *ep_id)
	Get the current state of an Endpoint on a call. More...
int	Call_Invitation_Version ()
	Gets the version count for call invitation updates. More...
int	Call_Invitation_First (CallInvitation_t *invite)
	Get the first Invitation from list. More...
int	Call_Invitation_Next (CallInvitation_t *invite)
	Get the next Invitation from list. More...
void	Call_Invitation_ClearAll ()
	Clear all invitations from list. More...
void	Call_Progress (const char *call_id, int call_state)
	Update current state of user Endpoint for a call. More...
void	Call_Leave (const char *call_id, int leave_reason)
	Leave a call with a specified reason. More...
void	Call_PressKey (const char *call_id, const char *keys)
	Transmit a key press on a call. More...
void	Call_LeaveRequest (const char *call_id, const char *endpoint_id)
	Request an endpoint to leave a call. More...
int	Phone_ListCount ()
	Get the count phones for this endpoint. More...
const char *	Phone_CallActive ()
	Get the active call ID. More...
float	Phone_Volume ()
	Get the receive volume for a phone. More...
void	Phone_SetCall (const char *call_id)
	Set the active call for phone. More...
void	Phone_SetVolume (float volume)
	Sets the receive volume for a phone. More...
void	Voisus_ConnectCloud (const char *cloud_id)
	Connects to a Voisus Cloud. More...
void	Cloud_GetLock ()
	Gets the lock on all Cloud data. More...
void	Cloud_ReleaseLock ()
	Releases the lock on all Cloud data. More...
const char *	Cloud_IDFirst ()
	Get the first Cloud. More...
const char *	Cloud_IDNext ()
	Get the next Cloud. More...
int	Cloud_ListCount ()
	Gets the current number of detected clouds. More...
int	Cloud_GetServerCount (const char *uuid)
	Gets the current number of detected clouds. More...
int	Cloud_Version ()
	Gets the version count for Clouds. More...
void	Operator_GetLock ()
	Gets the lock on all Operator data. More...
void	Operator_ReleaseLock ()
	Releases the lock on all Operator data. More...
const char *	Operator_IDFirst ()
	Get the first Operator. More...
const char *	Operator_IDNext ()
	Get the next Operator. More...
int	Operator_ListCount ()
	Gets the current number of Operators. More...
const char *	Operator_GetField (const char *uuid, const char *field_name)
	Get a field for an Operator. More...
int	Operator_Version ()
	Gets the version count for Operators. More...
int	RadCtrl_ListCount ()
	Gets the number of radios that can be controlled. More...
const char *	RadCtrl_Name (int index)
	Gets the name of a live radio to control. More...
void	RadCtrl_Poll (const char *name)
	Poll server for updated radio state information. More...
const char *	RadCtrl_GetValueStr (const char *name, const char *setting)
	Get live radio setting string value by name. More...
const char *	RadCtrl_GetOptionsStr (const char *name, const char *setting)
	Get list of options for a live radio string setting. More...
int	RadCtrl_GetValueInt (const char *name, const char *setting)
	Get live radio setting int value by name. More...
float	RadCtrl_GetValueFloat (const char *name, const char *setting)
	Get live radio setting float value by name. More...
void	RadCtrl_SetValueStr (const char *name, const char *setting, const char *value)
	Change a string setting of a live radio. More...
void	RadCtrl_SetValueInt (const char *name, const char *setting, int value)
	Change an integer setting of a live radio. More...
void	RadCtrl_SetValueFloat (const char *name, const char *setting, float value)
	Change a float setting of a live radio. More...
const char *	RadCtrl_Error ()
	Get error string for last radio control "set" operation. More...
int	RadCtrl_ErrorVersion ()
	Gets the version count of Radio Control responses to new settings. More...
void	DIS_SetParams (DISParams_t *dis_params)
	Update user-settable DIS parameters for an operator. More...
void	DIS_GetParams (DISParams_t *dis_params)
	Get DIS parameters configured on server for an operator. More...
void	DIS_SetExercise (int exercise)
	Update DIS exercise for operator radios. More...
int	DIS_GetExercise ()
	Get DIS exercise for operator radios. More...
void	AuxAudio_Enable (int enable, unsigned int sample_rate, unsigned int encoding)
	Enable/disable auxiliary audio input to client. More...
void	AuxAudio_Send (unsigned char *samples, unsigned int len)
	Send auxiliary audio to server (substitute for mic audio) More...
void	AuxAudio_Register (AudioCallback func)
	Register callback to receive auxiliary audio from server. More...
int	RadioEffects_Version ()
	Gets the version count for radio effects updates. More...
int	RadioEffects_ListCount ()
	Get the number of radio effects. More...
const char *	RadioEffects_IDFirst ()
	Get the first radio effect in set of radio effects. More...
const char *	RadioEffects_IDNext ()
	Get the next radio effect in set of radio effects. More...
const char *	RadioEffects_Name (const char *radio_effects_id)
	Get the name of a radio effect. More...
int	Jammer_Version ()
	Gets the version count for jammer updates. More...
int	Jammer_ListCount ()
	Gets the current number of jammers. More...
int	Jammer_NetListCount (int jammer_index)
	Gets the number of nets for a jammer. More...
const char *	Jammer_NetName (int jammer_index, int net_index)
	Gets the name of a net for a jammer. More...
const char *	Jammer_NetID (int jammer_index, int net_index)
	Gets the unique ID of a net for a jammer. More...
const char *	Jammer_NetIDActive (int jammer_index)
	Gets the unique ID of currently selected net for a jammer. More...
int	Jammer_IsTransmitting (int jammer_index)
	Gets the transmit state for a jammer. More...
void	Jammer_SetNetID (int jammer_index, const char *net_id)
	Sets the net for a jammer by unique ID. More...
void	Jammer_SetEnable (int jammer_index, int enable)
	Enable/disable a jammer to begin/end transmission. More...
void	Jammer_StartRecording (int jammer_index, int duration_secs)
	Start recording audio received by the jammer. More...
void	Jammer_StopRecording (int jammer_index)
	Stop recording audio received by the jammer. More...
void	Jammer_StartReplaying (int jammer_index, int loop)
	Start transmitting previously recorded audio out the jammer. More...
void	Jammer_StopReplaying (int jammer_index)
	Stop transmitting previously recorded audio out the jammer. More...
int	Jammer_RecordReplayState (int jammer_index)
	Get the current state of the jammer's record/replay functions. More...
int	Jammer_RecordReplayProgress (int jammer_index)
	Get the progress of an active recording or replaying. More...
int	Jammer_RecordReplayDurationMs (int jammer_index)
	Get the duration of the last recording in milliseconds. More...
const char *	AudioDevice_IDActive (AudioDeviceType_t type)
	Gets the unique ID of the active Playback audio device. More...
const char *	AudioDevice_IDFirst (AudioDeviceType_t type)
	Get the first audio device of specified type. More...
const char *	AudioDevice_IDNext (AudioDeviceType_t type)
	Get the next audio device of specified type. More...
const char *	AudioDevice_Name (AudioDeviceType_t type, const char *id)
	Get the name of an audio device of specified type by ID. More...
void	AudioDevice_SetDevice (AudioDeviceType_t type, const char *id)
	Set the audio device (playback or capture) to use. More...
int	AudioDevice_Version ()
	Gets the version count of Audio Device updates. More...
int	License_Request (const char *type)
	Request a new license of specified type. More...
void	License_Release (int license_id)
	Release a license. More...
int	License_Status (int license_id)
	Get status of license request. More...
int	Playsound_ListCount (void)
	Gets the current number of Client Playsounds. More...
const char *	Playsound_Name (const char *playsound_id)
	Gets the name of a specified playsound. More...
const char *	Playsound_Id (int playsound_index)
	Gets the unique ID of a specified playsound. More...
int	Playsound_Version (void)
	Gets the version count of Playsound updates. More...

Detailed Description

Voisus Remote Control Client (VRCC) Interface.

The Voisus Remote Control Client library provides an interface for interacting with the Voisus Client. Using this library, a developer can integrate the same functionality demonstrated in the ASTi Voisus Client into a user application.

Please note that the API is not thread-safe, therefore all calls to API functions must be made from the same thread.

Function Documentation

AudioDevice_IDActive()

const char* AudioDevice_IDActive

(

AudioDeviceType_t

type

)

Gets the unique ID of the active Playback audio device.

Playback devices are speakers and headsets

Parameters

type	Type of audio device (playback/capture) of type AudioDeviceType_t

Returns

audio device ID, or empty string

See also

AudioDevice_ListCount

AudioDevice_IDFirst()

const char* AudioDevice_IDFirst

(

AudioDeviceType_t

type

)

Get the first audio device of specified type.

Parameters

type	Type of audio device (playback/capture) of type AudioDeviceType_t

Returns

Unique ID of device, or empty string if none

AudioDevice_IDNext()

const char* AudioDevice_IDNext

(

AudioDeviceType_t

type

)

Get the next audio device of specified type.

Parameters

type	Type of audio device (playback/capture) of type AudioDeviceType_t

Returns

Unique ID of device, or empty string if none

See also

AudioDevice_IDFirst

AudioDevice_Name()

const char* AudioDevice_Name	(	AudioDeviceType_t	type,
		const char *	id
	)

Get the name of an audio device of specified type by ID.

Parameters

type	Type of audio device (playback/capture) of type AudioDeviceType_t
id	Unique ID of device

Returns

Name of device, or empty string if ID is not found

See also

AudioDevice_IDFirst, AudioDevice_IDNext

AudioDevice_SetDevice()

void AudioDevice_SetDevice	(	AudioDeviceType_t	type,
		const char *	id
	)

Set the audio device (playback or capture) to use.

Parameters

type	Type of audio device (playback/capture) of type AudioDeviceType_t
id	Unique ID of device

See also

AudioDevice_IDFirst, AudioDevice_IDNext

AudioDevice_Version()

int AudioDevice_Version

(

)

Gets the version count of Audio Device updates.

This counter increments when audio device information is updated.

Returns

count of audio device updates

AuxAudio_Enable()

void AuxAudio_Enable	(	int	enable,
		unsigned int	sample_rate,
		unsigned int	encoding
	)

Enable/disable auxiliary audio input to client.

Parameters

enable	1 for enable, 0 for disable
sample_rate	Audio sample rate (in Hz)
encoding	Audio sample encoding (in AudioEncoding_t)

See also

AuxAudio_Send

AuxAudio_Register()

void AuxAudio_Register

(

AudioCallback

func

)

Register callback to receive auxiliary audio from server.

Parameters

func	Audio callback function of type AudioCallback

See also

AuxAudio_Enable, AuxAudio_Send

AuxAudio_Send()

void AuxAudio_Send	(	unsigned char *	samples,
		unsigned int	len
	)

Send auxiliary audio to server (substitute for mic audio)

Parameters

samples	Audio samples
len	Length of audio samples (in bytes)

See also

AuxAudio_Enable

Call_Create()

const char* Call_Create

(

)

Create a new call and join it.

For more information, see documentation on Calls.

Note

This function is blocking and waits for a response before returning.

Returns

32-character unique ID of call

See also

Call_Invite, Phone_SetCall

Call_Endpoint_IDFirst()

const char* Call_Endpoint_IDFirst

(

const char *

call_id

)

Get the first Endpoint for a call.

Returns

32-character unique ID of endpoint, or empty string if none

Call_Endpoint_IDNext()

const char* Call_Endpoint_IDNext

(

const char *

call_id

)

Get the next Endpoint for a call.

Returns

32-character unique ID of endpoint, or empty string if none

See also

Call_Endpoint_IDFirst

Call_Endpoint_State()

int Call_Endpoint_State	(	const char *	call_id,
		const char *	ep_id
	)

Get the current state of an Endpoint on a call.

For more information, see documentation on Calls.

Parameters

call_id	32-character unique ID of call
ep_id	32-character unique ID of endpoint

Returns

state of type ::CallProgress_t

See also

Call_Endpoint_IDFirst

Call_Endpoint_Version()

int Call_Endpoint_Version

(

)

Gets the version count for call and endpoint updates.

This counter increments when any Call or Endpoint information is updated

Returns

count of updates

Call_GetLock()

void Call_GetLock

(

)

Gets the lock on all Call and Endpoint data.

Warning

This method is deprecated in VRCC 5.13.0 and above

See also

Call_ReleaseLock

Call_IDFirst()

const char* Call_IDFirst

(

)

Get the first call in set of calls for this endpoint.

Returns

32-character unique ID of call, or empty string if none

Call_IDNext()

const char* Call_IDNext

(

)

Get the next call in set of calls for this endpoint.

Returns

32-character unique ID of call, or empty string if none

See also

Call_IDFirst

Call_Invitation_ClearAll()

void Call_Invitation_ClearAll

(

)

Clear all invitations from list.

This method should be called after all invitations in the list are read.

Invitations are one-way notifications without state and will not time out.

Call_Invitation_First()

int Call_Invitation_First

(

CallInvitation_t *

invite

)

Get the first Invitation from list.

Invitations will remain until cleared with Call_Invitation_ClearAll

Parameters

invite

pointer to structure of type CallInvitation_t (for return value)

Returns

1 if invitation found, 0 otherwise

Call_Invitation_Next()

int Call_Invitation_Next

(

CallInvitation_t *

invite

)

Get the next Invitation from list.

Invitations will remain until cleared with Call_Invitation_ClearAll

Parameters

invite

pointer to structure of type CallInvitation_t (for return value)

Returns

1 if invitation found, 0 otherwise

See also

Call_Invitation_First

Call_Invitation_Version()

int Call_Invitation_Version

(

)

Gets the version count for call invitation updates.

This counter increments when any invitation is added

Returns

count of updates

Call_Invite()

void Call_Invite	(	const char *	call_id,
		const char *	endpoint_id
	)

Send an invitation to another endpoint.

For more information, see documentation on Invitations.

Parameters

call_id	32-character unique ID of call
endpoint_id	32-character unique ID of endpoint to invite

See also

Call_Endpoint_State

Call_Invite_Dial()

void Call_Invite_Dial	(	const char *	call_id,
		const char *	endpoint_id,
		const char *	dial_number
	)

Send an invitation to an endpoint to dial a phone number.

Intended for use with endpoints representing phone lines.

Warning

If the invited endpoint accepts the invitation, client will

automatically leave current call and be transferred to new call.

For more information, see documentation on Invitations.

Parameters

call_id	32-character unique ID of call
endpoint_id	32-character unique ID of endpoint to invite
dial_number	string containing the phone number to call

See also

Call_Endpoint_State

Call_InviteCrew()

void Call_InviteCrew

(

)

Invite all members of crew to a call.

Call_Leave()

void Call_Leave	(	const char *	call_id,
		int	leave_reason
	)

Leave a call with a specified reason.

For more information, see documentation on Calls.

Parameters

call_id	32-character unique ID of call
leave_reason	reason of type ::CallLeave_t

Call_LeaveRequest()

void Call_LeaveRequest	(	const char *	call_id,
		const char *	endpoint_id
	)

Request an endpoint to leave a call.

Intended for canceling call invitations.

Only endpoints with call state of signaling will leave call.

Endpoints in Connected and Holding states will ignore the request.

Parameters

call_id	32-character unique ID of call
call_id	32-character unique ID of endpoint

Call_ListCount()

int Call_ListCount

(

)

Get the size of the set of calls for this endpoint.

Returns

count of calls

Call_PressKey()

void Call_PressKey	(	const char *	call_id,
		const char *	keys
	)

Transmit a key press on a call.

Intended for sending DTMF tones on phone lines

Parameters

call_id	32-character unique ID of call
keys	string containing the keys to be pressed in sequence (e.g. "123#")

Call_Progress()

void Call_Progress	(	const char *	call_id,
		int	call_state
	)

Update current state of user Endpoint for a call.

For more information, see documentation on Calls.

Parameters

call_id	32-character unique ID of call
call_state	state of type ::CallProgress_t

Call_ReleaseLock()

void Call_ReleaseLock

(

)

Releases the lock on all Call and Endpoint data.

Warning

This method is deprecated in VRCC 5.13.0 and above

See also

Call_GetLock

Cloud_GetLock()

void Cloud_GetLock

(

)

Gets the lock on all Cloud data.

Warning

This method is deprecated in VRCC 5.13.0 and above

See also

Cloud_ReleaseLock

Cloud_GetServerCount()

int Cloud_GetServerCount

(

const char *

uuid

)

Gets the current number of detected clouds.

Returns

number of clouds

See also

Cloud_IDFirst, Cloud_IDNext

Cloud_IDFirst()

const char* Cloud_IDFirst

(

)

Get the first Cloud.

Returns

32-character unique ID of Cloud, or empty string if none

Cloud_IDNext()

const char* Cloud_IDNext

(

)

Get the next Cloud.

Returns

32-character unique ID of Cloud, or empty string if none

See also

Cloud_IDFirst

Cloud_ListCount()

int Cloud_ListCount

(

)

Gets the current number of detected clouds.

Returns

number of clouds

Cloud_ReleaseLock()

void Cloud_ReleaseLock

(

)

Releases the lock on all Cloud data.

Warning

This method is deprecated in VRCC 5.13.0 and above

See also

Cloud_GetLock

Cloud_Version()

int Cloud_Version

(

)

Gets the version count for Clouds.

This counter increments when any cloud information is updated. (e.g. new server added/removed)

Returns

count of cloud updates

Codec_Get()

int Codec_Get

(

)

Gets currently selected Codec.

Returns

codec of type ::Codec_t

Codec_Set()

void Codec_Set

(

int

codec

)

Sets a new Codec.

Parameters

codec

value of type ::Codec_t

DIS_GetExercise()

int DIS_GetExercise

(

)

Get DIS exercise for operator radios.

Returns

DIS exercise number for operator radios

See also

DIS_SetExercise

DIS_GetParams()

void DIS_GetParams

(

DISParams_t *

dis_params

)

Get DIS parameters configured on server for an operator.

Values are returned in the DISParams_t structure

See also

DIS_SetParams

DIS_SetExercise()

void DIS_SetExercise

(

int

exercise

)

Update DIS exercise for operator radios.

Parameters

exercise

value of new exercise in the range 1-255

See also

DIS_GetExercise

DIS_SetParams()

void DIS_SetParams

(

DISParams_t *

dis_params

)

Update user-settable DIS parameters for an operator.

Settable fields are site, app, entity and radio_offset in the DISParams_t

structure. Set values to 0 to use system defaults.

See also

DIS_GetParams

Earshot_Enable()

void Earshot_Enable

(

int

enable

)

Enable Earshot support.

This function must be called with a non-zero argument before any other Earshot calls are made. By default, Earshot is disabled.

Parameters

enable

non-zero for enable, 0 for disable

Earshot_Receiving()

int Earshot_Receiving

(

void

)

Gets the receive state for Earshot.

Returns

1 for receiving, 0 otherwise

See also

Earshot_Enable

Earshot_SetPTT()

void Earshot_SetPTT

(

int

ptt

)

Sets the Earshot push-to-talk (PTT) state.

When the ptt parameter is non-zero, audio will be transmitted into the ambient sound environment.

Parameters

ptt	1 for pressed, 0 otherwise

See also

Earshot_Enable

Earshot_Transmitting()

int Earshot_Transmitting

(

void

)

Gets the transmit state for Earshot.

Returns

1 for transmitting, 0 otherwise

See also

Earshot_Enable

EntityState_Id()

const char* EntityState_Id

(

int

list_index

)

Gets the unique ID of a specified Entity State (Vehicle)

Parameters

list_index

index of entity state in list

Returns

32-character unique identifier of Entity State, or empty string

See also

EntityState_ListCount

EntityState_IdActive()

const char* EntityState_IdActive

(

)

Gets the unique ID of the currently selected Entity State.

This value updates only after Entity State is set successfully

Returns

32-character unique identifier of Entity State, or empty string

EntityState_IdSet()

const char* EntityState_IdSet

(

)

Gets the unique ID of the last-set Entity State (Vehicle)

This value updates immediately

Returns

32-character unique identifier for Entity State, or empty string

EntityState_ListCount()

int EntityState_ListCount

(

)

Gets the total number of Entity States (Vehicles) available to the client.

Returns

number of entity states

EntityState_Name()

const char* EntityState_Name

(

int

list_index

)

Gets the name of a specified Entity State (Vehicle)

Parameters

list_index

index of entity state in list

Returns

name of Entity State, or empty string

See also

EntityState_ListCount

EntityState_NameActive()

const char* EntityState_NameActive

(

)

Gets the name of the current Entity State (Vehicle)

This value updates only after Entity State is set successfully

Returns

name of Entity State, or empty string

See also

EntityState_SetEntityState

EntityState_NameSet()

const char* EntityState_NameSet

(

)

Gets the name of the last-set Entity State.

This value updates immediately

Returns

name of Entity State, or empty string

EntityState_SetEntityState()

void EntityState_SetEntityState

(

const char *

id

)

Sets a new Entity State (Vehicle) to connect with.

Sends a request to connect to a new entity state with the specified unique ID. When the connection is complete, the value returned by EntityState_IdActive will match the id parameter.

Parameters

id	32-character unique identifier for Entity State

See also

EntityState_Id

EntityState_Version()

int EntityState_Version

(

)

Gets the version count of Entity State updates.

This counter increments when entity state information is updated.

Returns

count of entity state updates

Headset_DeviceConfigured()

int Headset_DeviceConfigured

(

)

Gets whether client successfully configure an audio device.

Returns

1 for configured, 0 otherwise

Headset_EarphoneVolume()

float Headset_EarphoneVolume

(

)

Gets the earphone volume.

Returns

volume in range [0.0, 100.0]

Headset_HasSidetone()

int Headset_HasSidetone

(

)

Gets whether headset has sidetone.

Returns

1 if headset has sidetone, 0 otherwise

Headset_MicrophoneMode()

int Headset_MicrophoneMode

(

)

Gets the microphone mode.

The mode can either be Off, Vox, PTT, or Hot. In vox mode, voice level determines transmission activity (based on vox threshold). In PTT mode, transmission is only made when PTT is pressed. In hot mode, voice transmission is always active.

Returns

mode of type ::MicMode_t

Headset_MicVolume()

float Headset_MicVolume

(

)

Gets the microphone volume.

Returns

volume in range [0.0, 100.0]

Headset_SetCallMicrophoneMute()

void Headset_SetCallMicrophoneMute

(

int

active

)

Sets the microphone mute during an active call.

Parameters

active

1 => mute is active, 0 => mute is inactive

Headset_SetEarphoneVolume()

void Headset_SetEarphoneVolume

(

float

volume

)

Sets the earphone volume.

Parameters

volume

value in range [0.0, 100.0]

Headset_SetHeadsetPreset()

void Headset_SetHeadsetPreset

(

int

preset

)

Selects from a preset headset configuration.

Sets the headset preset. Each preset contains default values. There are presets for Plantronics USB headset and the ASTi Radius.

Note

This function is blocking and waits for a response before returning.

Parameters

preset

value of type ::HeadsetPreset_t

Headset_SetMicrophoneMode()

void Headset_SetMicrophoneMode

(

int

mode

)

Sets the microphone mode.

Sets the microphone mode to either Off, Vox, PTT, or Hot. In vox mode, voice level determines transmission activity (based on vox threshold). In PTT mode, transmission is only made when PTT is pressed. In hot mode, voice transmission is always active.

Parameters

mode	value of type ::MicMode_t

Headset_SetMicVolume()

void Headset_SetMicVolume

(

float

volume

)

Sets the microphone volume.

Parameters

volume

value in range [0.0, 100.0]

Headset_SetSidetoneVolume()

void Headset_SetSidetoneVolume

(

float

volume

)

Sets the sidetone volume.

Sets the current sidetone volume to the specified value. Sidetone is the audio feedback of the client's voice to their own earphone. Sidetone is provided by the USB headset or sound card hardware, therefore may not be available.

Parameters

volume

value in range [0.0, 100.0]

See also

Headset_HasSidetone

Headset_SetVoxThreshold()

void Headset_SetVoxThreshold

(

float

threshold

)

Sets the vox threshold.

Sets the current Vox threshold to the specified value. Higher thresholds require greater voice volume to trigger transmission.

Parameters

threshold

value in range [0.0, 100.0]

Headset_SidetoneVolume()

float Headset_SidetoneVolume

(

)

Gets the sidetone volume.

Sidetone is the audio feedback of the client's voice to their own earphone. Sidetone is provided by the USB headset or sound card hardware, therefore may not be available.

Returns

volume in range [0.0, 100.0]

See also

Headset_HasSidetone

Headset_VoxThreshold()

float Headset_VoxThreshold

(

)

Gets the vox threshold.

Threshold for Vox system. Higher thresholds require greater voice volume to trigger transmission.

Returns

threshold in range [0.0, 100.0]

Jammer_IsTransmitting()

int Jammer_IsTransmitting

(

int

jammer_index

)

Gets the transmit state for a jammer.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

Returns

1 for transmitting, 0 otherwise

See also

Jammer_ListCount

Jammer_ListCount()

int Jammer_ListCount

(

)

Gets the current number of jammers.

Returns

number of jammers

Jammer_NetID()

const char* Jammer_NetID	(	int	jammer_index,
		int	net_index
	)

Gets the unique ID of a net for a jammer.

Parameters

jammer_index	index of jammer in range [0, jammer_count-1]
net_index	index of net in range [0, net_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Jammer_ListCount, Jammer_NetListCount

Jammer_NetIDActive()

const char* Jammer_NetIDActive

(

int

jammer_index

)

Gets the unique ID of currently selected net for a jammer.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Jammer_ListCount

Jammer_NetListCount()

int Jammer_NetListCount

(

int

jammer_index

)

Gets the number of nets for a jammer.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

Returns

number of nets available

See also

Jammer_ListCount

Jammer_NetName()

const char* Jammer_NetName	(	int	jammer_index,
		int	net_index
	)

Gets the name of a net for a jammer.

Parameters

jammer_index	index of jammer in range [0, jammer_count-1]
net_index	index of net in range [0, net_count-1]

Returns

name of net, or empty string

See also

Jammer_ListCount, Jammer_NetListCount

Jammer_RecordReplayDurationMs()

int Jammer_RecordReplayDurationMs

(

int

jammer_index

)

Get the duration of the last recording in milliseconds.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

Returns

duration of last recording in milliseconds

See also

Jammer_ListCount

Jammer_RecordReplayProgress()

int Jammer_RecordReplayProgress

(

int

jammer_index

)

Get the progress of an active recording or replaying.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

Returns

Progress as a percentage of the maximum recording duration

See also

Jammer_ListCount, Jammer_StartRecording

Jammer_RecordReplayState()

int Jammer_RecordReplayState

(

int

jammer_index

)

Get the current state of the jammer's record/replay functions.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

Returns

State of type JammerRecordReplayState_t

See also

Jammer_ListCount

Jammer_SetEnable()

void Jammer_SetEnable	(	int	jammer_index,
		int	enable
	)

Enable/disable a jammer to begin/end transmission.

Parameters

jammer_index	index of jammer in range [0, jammer_count-1]
enable	0 to disable, otherwise enable

See also

Jammer_ListCount

Jammer_SetNetID()

void Jammer_SetNetID	(	int	jammer_index,
		const char *	net_id
	)

Sets the net for a jammer by unique ID.

Parameters

jammer_index	index of jammer in range [0, jammer_count-1]
net_id	32-character unique identifier for net

See also

Jammer_ListCount, Jammer_NetID

Jammer_StartRecording()

void Jammer_StartRecording	(	int	jammer_index,
		int	duration_secs
	)

Start recording audio received by the jammer.

Recording will start when first audio is received and continue

until stopped or recording length reaches specified duration

Parameters

jammer_index	index of jammer in range [0, jammer_count-1]
duration_secs	Maximum duration of recording in range [1, 30]

See also

Jammer_ListCount

Jammer_StartReplaying()

void Jammer_StartReplaying	(	int	jammer_index,
		int	loop
	)

Start transmitting previously recorded audio out the jammer.

Replay will start immediately and conclude when all audio is played

(if loop == 0) or play continuously until stopped on a loop

(if loop > 0)

Parameters

jammer_index	index of jammer in range [0, jammer_count-1]
loop	1 to enable looping playback, 0 to play once

See also

Jammer_ListCount

Jammer_StopRecording()

void Jammer_StopRecording

(

int

jammer_index

)

Stop recording audio received by the jammer.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

See also

Jammer_ListCount, Jammer_StartRecording

Jammer_StopReplaying()

void Jammer_StopReplaying

(

int

jammer_index

)

Stop transmitting previously recorded audio out the jammer.

Parameters

jammer_index

index of jammer in range [0, jammer_count-1]

See also

Jammer_ListCount, Jammer_StartReplaying

Jammer_Version()

int Jammer_Version

(

)

Gets the version count for jammer updates.

This counter increments when any jammer information is updated.

Returns

count of jammer updates

Joystick_Active()

int Joystick_Active

(

)

Gets the active joystick index.

Returns

index of the active joystick for primary PTT, -1 if not set

Joystick_Active_Multi()

int Joystick_Active_Multi

(

int

ptt

)

Gets the active joystick index for a specified PTT.

Parameters

ptt	index of PTT to query (0 for primary, 1 for secondary)

Returns

index of the active joystick for the specificed PTT, -1 if not set

Joystick_ButtonActive()

int Joystick_ButtonActive

(

)

Gets the active joystick button index.

Returns

index of the active joystick button, -1 if not set

Joystick_ButtonActive_Multi()

int Joystick_ButtonActive_Multi

(

int

ptt

)

Gets the active joystick button index.

Parameters

ptt	index of PTT to query (0 for primary, 1 for secondary)

Returns

index of the active joystick button for the specified PTT, -1 if not set

Joystick_ButtonCount()

int Joystick_ButtonCount

(

int

list_index

)

Gets the number of buttons for a specified joystick.

Parameters

list_index

index of joystick in the range [0, number of joysticks - 1]

Returns

number of buttons for joystick, or -1 on error

See also

Joystick_ListCount

Joystick_ListCount()

int Joystick_ListCount

(

)

Gets the current number of detected joysticks.

Returns

number of joysticks

Joystick_Name()

const char* Joystick_Name

(

int

list_index

)

Gets the name of a specified joystick.

Parameters

list_index

index of joystick in the range [0, number of joysticks - 1]

Returns

name of Joystick, or empty string

See also

Joystick_ListCount

Joystick_Pressed()

int Joystick_Pressed

(

)

Gets the current joystick pressed state.

Returns

whether active joystick button is pressed

Joystick_Pressed_Multi()

int Joystick_Pressed_Multi

(

int

ptt

)

Gets the current joystick pressed state.

Parameters

ptt	index of PTT to query (0 for primary, 1 for secondary)

Returns

whether active joystick button is pressed

Joystick_SetButton()

void Joystick_SetButton	(	int	js,
		int	btn
	)

Selects the active joystick button.

Sets the active joystick button that will be monitored for button presses used for push-to-talk (PTT) functionality.

Parameters

js	index of joystick
btn	index of button

See also

Joystick_Pressed

Joystick_SetButton_Multi()

void Joystick_SetButton_Multi	(	int	ptt,
		int	js,
		int	btn
	)

Selects the active joystick button.

Sets the active joystick button that will be monitored for button presses used for push-to-talk (PTT) functionality.

Parameters

ptt	index of PTT to query (0 for primary, 1 for secondary)
js	index of joystick
btn	index of button

See also

Joystick_Pressed

License_Release()

void License_Release

(

int

license_id

)

Release a license.

Check status of license request (pending, granted, released or

lost) with License_Status.

Parameters

license_id

Identifier for license

See also

License_Status

License_Request()

int License_Request

(

const char *

type

)

Request a new license of specified type.

Check status of license request (pending, granted, released or

lost) with License_Status.

Note

This function is blocking and waits for a response before returning.

Parameters

type	Type of license

Returns

Identifier for license request, -1 on error

See also

License_Status

License_Status()

int License_Status

(

int

license_id

)

Get status of license request.

Parameters

license_id

Identifier for license

Returns

License status of type LicenseStatus_t

See also

License_Request

Log_Write()

void Log_Write	(	const char *	function,
		const char *	msg
	)

Writes a message to the Voisus client log.

The message will be logged as "<function> : <msg>". See the Voisus log for examples.

Parameters

function	the function or scope that wrote the message
msg	the log message

See also

Voisus_LogPath

Net_Name()

const char* Net_Name

(

const char *

net_id

)

Gets the name of a net using the unique ID.

Parameters

net_id

unique ID of a net, or empty string

Network_ClientIP()

const char* Network_ClientIP

(

)

Gets the Client address used to connect to the Server.

Returns

IPv4 address of Client connection

Network_ClientName()

const char* Network_ClientName

(

)

Gets the user-settable client name.

The client name is published on the Server and to other clients.

Returns

client name, or empty string

Network_CloudActive()

const char* Network_CloudActive

(

)

Gets the currently connected Cloud.

Returns

Unique name of the cloud

Network_CloudSet()

const char* Network_CloudSet

(

)

Gets the last set Cloud to connect to.

Returns

Unique name of the cloud

Network_ConnectionMode()

int Network_ConnectionMode

(

)

Get the current connection mode (e.g. Cloud)

Returns

mode of type ConnectionMode_t

Network_ConnectionStatus()

int Network_ConnectionStatus

(

)

Gets the connection status of client.

This function returns whether the client is connected or disconnected from the Server. For more detailed connection information, see Network_ConnectState.

Returns

status of type ConnectionStatus_t

See also

Network_ConnectState

Network_ConnectState()

int Network_ConnectState

(

)

Gets the detailed connection state of the client.

This function returns detailed information about the connection including getting/setting Role information.

Returns

detailed connection state of type ConnectState_t

Network_OperatorId()

const char* Network_OperatorId

(

)

Gets the unique ID of the Operator.

This is the 32-character unique identifier of the Operator instance on the server that the client is currently connected to.

Returns

operator ID if connected, empty string otherwise

Network_SetClientName()

void Network_SetClientName

(

const char *

name

)

Sets the client name.

The client name is published on the Server and to other clients.

Parameters

name	User-settable name for the client.

Network_TargetIP()

const char* Network_TargetIP

(

)

Gets the Voisus Server address.

Returns

string containing IPv4 address of Voisus Server for this client. Connection status can be determined through Network API functions.

See also

Network_ConnectState, Network_ConnectionStatus

Operator_GetField()

const char* Operator_GetField	(	const char *	uuid,
		const char *	field_name
	)

Get a field for an Operator.

Supported field names are

		"role"	Role name
		"clientname"	Client name
		"hostname"	Hostname of server that client is connected to
		"connected"	"true" if connected, "false" otherwise
		"callactive"	"true" if currently on a call (busy), "false" otherwise
		"clientversion"	Version of client
		"serverversion"	Version of server

For more information, see documentation on Endpoints/Operators.

Parameters

uuid	32-character unique ID of Operator
field_name	name of field

Returns

field value, or empty string if field not found

See also

Operator_IDFirst, Operator_IDNext

Operator_GetLock()

void Operator_GetLock

(

)

Gets the lock on all Operator data.

Warning

This method is deprecated in VRCC 5.13.0 and above

See also

Operator_ReleaseLock

Operator_IDFirst()

const char* Operator_IDFirst

(

)

Get the first Operator.

Returns

32-character unique ID of operator, or empty string if none

Operator_IDNext()

const char* Operator_IDNext

(

)

Get the next Operator.

Returns

32-character unique ID of Operator, or empty string if none

See also

Operator_IDFirst

Operator_ListCount()

int Operator_ListCount

(

)

Gets the current number of Operators.

Returns

number of Operators

Operator_ReleaseLock()

void Operator_ReleaseLock

(

)

Releases the lock on all Operator data.

Warning

This method is deprecated in VRCC 5.13.0 and above

See also

Operator_GetLock

Operator_Version()

int Operator_Version

(

)

Gets the version count for Operators.

This counter increments when any Operator information is updated, including operators added/removed or fields changed

Returns

count of Operator updates

Phone_CallActive()

const char* Phone_CallActive

(

)

Get the active call ID.

Returns

32-character unique ID for call

Phone_ListCount()

int Phone_ListCount

(

)

Get the count phones for this endpoint.

For more information, see documentation on Phones.

Returns

1 if phone present, 0 otherwise

Phone_SetCall()

void Phone_SetCall

(

const char *

call_id

)

Set the active call for phone.

For more information, see documentation on Phones.

Parameters

call_id

32-character unique ID of call, or empty string to clear

See also

Call_Create

Phone_SetVolume()

void Phone_SetVolume

(

float

volume

)

Sets the receive volume for a phone.

Parameters

volume

value in range [0.0, 100.0]

Phone_Volume()

float Phone_Volume

(

)

Get the receive volume for a phone.

Returns

volume in range [0.0, 100.0]

Playsound_Id()

const char* Playsound_Id

(

int

playsound_index

)

Gets the unique ID of a specified playsound.

Parameters

playsound_index

index of playsound in the range [0, count of playsounds - 1]

Returns

32-character unique identifier of playsound, or empty string

See also

Playsound_ListCount

Playsound_ListCount()

int Playsound_ListCount

(

void

)

Gets the current number of Client Playsounds.

Returns

number of playsounds

Playsound_Name()

const char* Playsound_Name

(

const char *

playsound_id

)

Gets the name of a specified playsound.

Parameters

playsound_id

32-character unique ID of playsound

Returns

name of Playsound, or empty string

See also

Playsound_ListCount

Playsound_Version()

int Playsound_Version

(

void

)

Gets the version count of Playsound updates.

This counter increments when playsound information is updated.

Returns

count of playsound updates

PTT_GetPressed()

int PTT_GetPressed

(

)

Gets the current pressed state of the primary software push-to-talk (PTT) state.

The value reflects the state of the software PTT (not hardware).

Returns

1 for pressed, 0 otherwise

See also

PTT_HWGetPressed, PTT_GetPressed_Multi

PTT_GetPressed_Multi()

int PTT_GetPressed_Multi

(

int

ptt

)

Gets the current pressed state of a specified software push-to-talk (PTT)

The value reflects the state of a software PTT (not hardware).

Parameters

ptt	index of PTT to query

Returns

1 for pressed, 0 otherwise

See also

PTT_HWGetPressed

PTT_HWGetPressed()

int PTT_HWGetPressed

(

)

Gets the current hardware push-to-talk (PTT) state.

This value only reflects the state of the primary hardware PTT (not software) including joysticks.

Returns

1 for pressed, 0 otherwise

See also

PTT_GetPressed, Joystick_Pressed, PTT_HWGetPressed_Multi

PTT_HWGetPressed_Multi()

int PTT_HWGetPressed_Multi

(

int

ptt

)

Gets the current hardware push-to-talk (PTT) state (multiple)

This value only reflects the state of the specified hardware PTT (not software) including joysticks. Pass -1 for ANY PTT (values are OR'd).

Parameters

ptt	index of hardware PTT to query

Returns

1 for pressed, 0 otherwise

See also

PTT_GetPressed, Joystick_Pressed

PTT_SetPressed()

void PTT_SetPressed

(

int

pressed

)

Sets the software push-to-talk (PTT) state for primary PTT.

When the ptt parameter is non-zero, audio will be transmitted on any radios that have their transmit state enabled.

Parameters

pressed

1 for pressed, 0 otherwise

See also

Radio_SetTransmitEnabled, Radio_IsTransmitEnabled, Radio_PTT, PTT_SetPressed_Multi

PTT_SetPressed_Multi()

void PTT_SetPressed_Multi	(	int	ptt,
		int	pressed
	)

Sets the software push-to-talk (PTT) state for a given PTT.

When the pressed parameter is non-zero, audio will be transmitted on any radios that have their transmit state enabled and are designated for this PTT.

Parameters

ptt	index of PTT to update
pressed	1 for pressed, 0 otherwise

See also

Radio_SetTransmitEnabled, Radio_IsTransmitEnabled, Radio_PTT

RadCtrl_Error()

const char* RadCtrl_Error

(

)

Get error string for last radio control "set" operation.

Returns

string containing error message, or empty string if successful

RadCtrl_ErrorVersion()

int RadCtrl_ErrorVersion

(

)

Gets the version count of Radio Control responses to new settings.

This counter increments once for each RadCtrl_Set* API call.

If the response is an error, the error message can be fetched using

RadCtrl_Error.

Returns

count of responses to radio control setting changes

See also

RadCtrl_Error, RadCtrl_SetValueInt, RadCtrl_SetValueStr

RadCtrl_GetOptionsStr()

const char* RadCtrl_GetOptionsStr	(	const char *	name,
		const char *	setting
	)

Get list of options for a live radio string setting.

Parameters

name	name of live radio to control
setting	name of setting for retrieve options list for

Returns

string containing comma-separated list of valid options for setting, or empty string if not found

See also

RadCtrl_ListCount, RadCtrl_Name, RadCtrl_GetValueStr

RadCtrl_GetValueFloat()

float RadCtrl_GetValueFloat	(	const char *	name,
		const char *	setting
	)

Get live radio setting float value by name.

Supported field names are

		"rx_power"	Receive Power
		"squelch"	Squelch Level

Parameters

name	name of live radio to control
setting	name of value to retrieve

Returns

int value of the specified setting, or -1 if not found

See also

RadCtrl_ListCount, RadCtrl_Name

RadCtrl_GetValueInt()

int RadCtrl_GetValueInt	(	const char *	name,
		const char *	setting
	)

Get live radio setting int value by name.

Supported field names are

		"freq"	Frequency (in Hz)
		"tx_freq"	Transmit Frequency (in Hz)
		"preset"	Current preset (0-9), only valid if 'load_preset' is set to "TRUE"

Parameters

name	name of live radio to control
setting	name of value to retrieve

Returns

int value of the specified setting, or -1 if not found

See also

RadCtrl_ListCount, RadCtrl_Name

RadCtrl_GetValueStr()

const char* RadCtrl_GetValueStr	(	const char *	name,
		const char *	setting
	)

Get live radio setting string value by name.

Supported field names are

		"mod_mode"	Modulation mode (e.g. AM, FM)
		"tx_mod_mode"	Transmit modulation mode (e.g. AM, FM)
		"power_lvl"	Power level (e.g. LOW, MED, HIGH)
		"load_preset"	Are presets loadable? (e.g. TRUE, FALSE), must be TRUE in order to set any presets, or FALSE to modify any individual settings

Parameters

name	name of live radio to control
setting	name of value to retrieve

Returns

string value of the specified setting, or empty string if not found

See also

RadCtrl_ListCount, RadCtrl_Name, RadCtrl_GetOptionsStr

RadCtrl_ListCount()

int RadCtrl_ListCount

(

)

Gets the number of radios that can be controlled.

Returns

number of controllable live radios

RadCtrl_Name()

const char* RadCtrl_Name

(

int

index

)

Gets the name of a live radio to control.

Returns

name of radio, or empty string if not found

RadCtrl_Poll()

void RadCtrl_Poll

(

const char *

name

)

Poll server for updated radio state information.

Parameters

name	name of live radio to control

See also

RadCtrl_ListCount, RadCtrl_Name

RadCtrl_SetValueFloat()

void RadCtrl_SetValueFloat	(	const char *	name,
		const char *	setting,
		float	value
	)

Change a float setting of a live radio.

Supported field names are

		"rx_power"	Receive Power
		"squelch"	Squelch Level

Parameters

name	name of live radio to control
setting	name of setting to modify
value	new value for setting

See also

RadCtrl_ListCount, RadCtrl_Name

RadCtrl_SetValueInt()

void RadCtrl_SetValueInt	(	const char *	name,
		const char *	setting,
		int	value
	)

Change an integer setting of a live radio.

Supported field names are

		"freq"	Frequency (in Hz)
		"tx_freq"	Transmit Frequency (in Hz)
		"preset"	Preset to load (0-9), can only load presets if 'load_preset' option is set to "TRUE"

Parameters

name	name of live radio to control
setting	name of setting to modify
value	new value for setting

See also

RadCtrl_ListCount, RadCtrl_Name

RadCtrl_SetValueStr()

void RadCtrl_SetValueStr	(	const char *	name,
		const char *	setting,
		const char *	value
	)

Change a string setting of a live radio.

Supported field names are

		"mod_mode"	Modulation mode (e.g. AM, FM)
		"tx_mod_mode"	Transmit modulation mode (e.g. AM, FM)
		"power_lvl"	Power level (e.g. LOW, MED, HIGH)
		"load_preset"	Enable preset mode? (e.g. TRUE, FALSE), set to TRUE before loading any presets or to FALSE before modifying any individual settings

Parameters

name	name of live radio to control
setting	name of setting to modify
value	new value for setting

See also

RadCtrl_ListCount, RadCtrl_Name

Radio_AppendScanPlanNet()

void Radio_AppendScanPlanNet	(	int	radio_index,
		int	plan_index,
		const char *	net_id
	)

Appends a net to a scan plan net list.

Duplicate nets are not permitted

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
net_id	unique ID of a net

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_NetID

Radio_AudioLevel()

float Radio_AudioLevel

(

int

radio_index

)

Gets the audio level of a radio.

Audio level calculation must be enabled first. Audio level is

calculated 5 times per second as an RMS value of received

radio audio and is not affected by volume adjustments.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

Audio level value between 0.0 and 1.0. Returns 0.0 if disabled.

See also

Radio_AudioLevelEnable, Radio_AudioLevelEnabled

Radio_AudioLevelEnabled()

int Radio_AudioLevelEnabled

(

int

radio_index

)

Gets whether audio level calculation is enabled for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 if calculation is enabled, 0 otherwise

See also

Radio_AudioLevel

Radio_Balance()

int Radio_Balance

(

int

radio_index

)

Gets the audio balance for a radio (left, right, center)

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

balance of type Balance_t

Radio_BalanceLocked()

int Radio_BalanceLocked

(

int

radio_index

)

Gets whether balance selection is locked for a radio.

When selection is locked, the balance cannot be changed by the client. This configuration is set in the definition of a Role on the Voisus Server.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for locked, 0 otherwise

See also

Radio_ListCount

Radio_CryptoEnabled()

int Radio_CryptoEnabled

(

int

radio_index

)

Gets whether radio has crypto mode enabled.

Enabled means cipher text mode. Disabled means plain text mode.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 if cipher text is enabled, 0 otherwise

Radio_IsNetLocked()

int Radio_IsNetLocked

(

int

radio_index

)

Gets whether net selection is locked for a radio.

When net selection is locked, the net cannot be changed by the client. This configuration is set in the definition of a Role on the Voisus Server.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for locked, 0 otherwise

See also

Radio_ListCount

Radio_IsReceiveEnabled()

int Radio_IsReceiveEnabled

(

int

radio_index

)

Gets the receive enable for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for enabled, 0 for disabled

See also

Radio_ListCount, Radio_SetReceiveEnabled

Radio_IsReceiving()

int Radio_IsReceiving

(

int

radio_index

)

Gets the receive state for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for receiving, 0 otherwise

See also

Radio_ListCount

Radio_IsRXModeLocked()

int Radio_IsRXModeLocked

(

int

radio_index

)

Gets whether the RX enable is locked for a radio.

When the RX enable is locked, the receive enable cannot be changed by the client. This configuration is set in the definition of a Role on the Voisus Server.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for locked, 0 otherwise

See also

Radio_ListCount, Radio_IsTXModeLocked

Radio_IsShared()

int Radio_IsShared

(

int

radio_index

)

Gets whether a radio is shared by two or more operators. Shared radios are accessed through Entity States (Vehicles).

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for shared, 0 otherwise

See also

Radio_ListCount

Radio_IsTransmitEnabled()

int Radio_IsTransmitEnabled

(

int

radio_index

)

Gets the transmit enable for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for enabled, 0 for disabled

See also

Radio_ListCount, Radio_SetTransmitEnabled

Radio_IsTransmitting()

int Radio_IsTransmitting

(

int

radio_index

)

Gets the transmit state for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for transmitting, 0 otherwise

See also

Radio_ListCount

Radio_IsTXModeLocked()

int Radio_IsTXModeLocked

(

int

radio_index

)

Gets whether the TX enable is locked for a radio.

When the TX enable is locked, the transmit enable cannot be changed by the client. This configuration is set in the definition of a Role on the Voisus Server.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for locked, 0 otherwise

See also

Radio_ListCount, Radio_IsRXModeLocked

Radio_ListCount()

int Radio_ListCount

(

)

Gets the current number of radios.

Returns

number of radios

Radio_Name()

const char* Radio_Name

(

int

radio_index

)

Gets the name of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

name of radio, or empty string

See also

Radio_ListCount

Radio_NetCryptoEnabled()

int Radio_NetCryptoEnabled	(	int	radio_index,
		int	net_index
	)

Gets the crypto enabled of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

0 if disabled, 1 if enabled

See also

Radio_ListCount, Radio_NetListCount

Radio_NetCryptoEnabledActive()

int Radio_NetCryptoEnabledActive

(

int

radio_index

)

Get the crypto enable state for the currently tuned net of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

whether crypto is enabled for currently tuned net

See also

Radio_ListCount

Radio_NetCryptoKey()

int Radio_NetCryptoKey	(	int	radio_index,
		int	net_index
	)

Gets the crypto key of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

crypto key, 0 if disabled

See also

Radio_ListCount, Radio_NetListCount

Radio_NetCryptoKeyActive()

int Radio_NetCryptoKeyActive

(

int

radio_index

)

Get the crypto key for the currently tuned net of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

whether crypto key currently tuned net, 0 if disabled

See also

Radio_ListCount

Radio_NetCryptoSystem()

int Radio_NetCryptoSystem	(	int	radio_index,
		int	net_index
	)

Gets the crypto system of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

crypto system, 0 if disabled

See also

Radio_ListCount, Radio_NetListCount

Radio_NetCryptoSystemActive()

int Radio_NetCryptoSystemActive

(

int

radio_index

)

Get the crypto system for the currently tuned net of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

whether crypto system currently tuned net, 0 if disabled

See also

Radio_ListCount

Radio_NetFreqHopNetId()

int Radio_NetFreqHopNetId	(	int	radio_index,
		int	net_index
	)

Gets the Net ID (for Frequency Hop nets only)

Freqhop nets will have a Radio_NetWaveform value of "HaveQuick" or "SINCGARS"

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

net_id for freqhop-enabled net, 0 otherwise

See also

Radio_ListCount, Radio_NetListCount, Radio_NetWaveform

Radio_NetFrequency()

unsigned long long Radio_NetFrequency	(	int	radio_index,
		int	net_index
	)

Gets the frequency of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

unsigned long long for frequency or 0 if none

See also

Radio_ListCount, Radio_NetListCount

Radio_NetID()

const char* Radio_NetID	(	int	radio_index,
		int	net_index
	)

Gets the unique ID of a net for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Radio_ListCount, Radio_NetListCount

Radio_NetIDActive()

const char* Radio_NetIDActive

(

int

radio_index

)

Gets the unique ID of currently selected net for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Radio_ListCount

Radio_NetListCount()

int Radio_NetListCount

(

int

radio_index

)

Gets the number of nets for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

number of nets available

See also

Radio_ListCount

Radio_NetName()

const char* Radio_NetName	(	int	radio_index,
		int	net_index
	)

Gets the name of a net by index for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

name of net, or empty string

See also

Radio_ListCount, Radio_NetListCount

Radio_NetNameActive()

const char* Radio_NetNameActive

(

int

radio_index

)

Gets the name of currently selected net for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

name of net, or empty string

See also

Radio_ListCount

Radio_NetRxFrequencyActive()

unsigned long long Radio_NetRxFrequencyActive

(

int

radio_index

)

Get the receive frequency for the currently tuned net of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

receive frequency of net, or 0 if radio_index is invalid

See also

Radio_ListCount

Radio_NetSatcomChannel()

int Radio_NetSatcomChannel	(	int	radio_index,
		int	net_index
	)

Gets the SATCOM channel of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

SATCOM channel number

See also

Radio_ListCount, Radio_NetListCount

Radio_NetTuningMethod()

int Radio_NetTuningMethod	(	int	radio_index,
		int	net_index
	)

Gets the tuning method of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

net tuning method (AM/FM = 1, Intercom = 2, HAVEQUICK = 4, SINCGARS = 5)

See also

Radio_ListCount, Radio_NetListCount

Radio_NetTxFrequencyActive()

unsigned long long Radio_NetTxFrequencyActive

(

int

radio_index

)

Get the transmit frequency for the currently tuned net of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

transmit frequency of net, or 0 if radio_index is invalid

See also

Radio_ListCount

Radio_NetWaveform()

const char* Radio_NetWaveform	(	int	radio_index,
		int	net_index
	)

Gets the waveform of the radio's net.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1]

Returns

waveform name

See also

Radio_ListCount, Radio_NetListCount

Radio_NetWaveformActive()

const char* Radio_NetWaveformActive

(

int

radio_index

)

Get the waveform (mode) for the currently tuned net of a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

waveform name

See also

Radio_ListCount

Radio_Playsound()

const char* Radio_Playsound

(

int

radio_index

)

Gets the unique ID of sound mixed into mic audio for this radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

32-character unique ID of the background playsound, or empty string

See also

Radio_ListCount, Radio_SetPlaysound, Playsound_Id

Radio_PlaysoundLocked()

int Radio_PlaysoundLocked

(

int

radio_index

)

Gets whether background playsound selection is locked for a radio.

When selection is locked, the playsound cannot be changed by the client. This configuration is set in the definition of a Role on the Voisus Server.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for locked, 0 otherwise

See also

Radio_ListCount

Radio_PTT()

int Radio_PTT

(

int

radio_index

)

Gets the PTT identifier for the radio.

Return value of 0 indicates primary PTT, 1 is secondary, etc.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

ptt identifier

Radio_RadCtrlId()

const char* Radio_RadCtrlId

(

int

radio_index

)

Gets the Radio Control Id of a radio configured to control live radios.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

32-character unique ID of radio control, or empty string

See also

Radio_ListCount

Radio_RadioEffects()

const char* Radio_RadioEffects

(

int

radio_index

)

Gets the radio effects set for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

32-character unique ID of radio effects, or empty string

Radio_RadioEffectsLocked()

int Radio_RadioEffectsLocked

(

int

radio_index

)

Gets whether radio effects selection is locked for a radio.

When selection is locked, the radio effects cannot be changed by the client. This configuration is set in the definition of a Role on the Voisus Server.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 for locked, 0 otherwise

See also

Radio_ListCount

Radio_RemoveScanPlanNet()

void Radio_RemoveScanPlanNet	(	int	radio_index,
		int	plan_index,
		int	net_index
	)

Removes a net from a scan plan net list.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
net_index	position of net to remove from scan plan net list

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanNetListCount

Radio_ScanActive()

int Radio_ScanActive

(

int

radio_index

)

Gets whether scanner is actively scanning for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 when scanning, 0 when idle

See also

Radio_ListCount, Radio_ScanEnabled

Radio_ScanEnabled()

int Radio_ScanEnabled

(

int

radio_index

)

Gets whether scanner is enabled for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

1 when enabled, 0 when disabled

See also

Radio_ListCount

Radio_ScanHangTime()

float Radio_ScanHangTime

(

int

radio_index

)

Gets the hang time for a scanner.

The hang time is the number of seconds that a scanner will listen

on a channel after receiving ends before returning to scanning.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

hold time in seconds

See also

Radio_ListCount, Radio_SetScanHangTime

Radio_ScanHoldTime()

float Radio_ScanHoldTime

(

int

radio_index

)

Gets the hold time for a scanner.

The hold time is the maximum number of seconds that a scanner will listen

on a channel before returning to scanning, even if actively receiving.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

hold time in seconds (0 means disabled)

See also

Radio_ListCount, Radio_SetScanHoldTime

Radio_ScanNetListMax()

int Radio_ScanNetListMax

(

int

radio_index

)

Gets the maximum number of nets for a scan list in a plan.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

maximum number of nets for scan lists (0 means unlimited)

See also

Radio_ListCount, Radio_ScanPlanListCount

Radio_ScanNext()

void Radio_ScanNext

(

int

radio_index

)

Changes to next net in scan list (manual scanning)

The radio scanner must be enabled and nets defined in active scan plan.

Parameters

radio_index

index of radio in range [0, radio_count-1]

See also

Radio_ListCount, Radio_ScanEnabled, Radio_SetScanEnable

Radio_ScanPlanActive()

int Radio_ScanPlanActive

(

int

radio_index

)

Gets the index of the scan plan in use for a scanner.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

scan plan index, -1 if no active scan plan

See also

Radio_ListCount, Radio_ScanPlanListCount

Radio_ScanPlanInvalidNets()

int Radio_ScanPlanInvalidNets	(	int	radio_index,
		int	plan_index
	)

Gets whether there are invalid nets in the scan plan.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]

Returns

1 if invalid nets present in scan plan, 0 otherwise

Radio_ScanPlanListCount()

int Radio_ScanPlanListCount

(

int

radio_index

)

Gets the count of scan plans for a scanner.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

number of scan plans

See also

Radio_ListCount

Radio_ScanPlanNetID()

const char* Radio_ScanPlanNetID	(	int	radio_index,
		int	plan_index,
		int	net_index
	)

Gets the unique ID of a net in a scan plan net list.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
net_index	index of net in range [0, net_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanNetListCount

Radio_ScanPlanNetListCount()

int Radio_ScanPlanNetListCount	(	int	radio_index,
		int	plan_index
	)

Gets the count of nets in a scan plan for a scanner.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]

Returns

number of nets in scan list

See also

Radio_ListCount, Radio_ScanPlanListCount

Radio_ScanPlanNetName()

const char* Radio_ScanPlanNetName	(	int	radio_index,
		int	plan_index,
		int	net_index
	)

Gets the name of a net in a scan plan net list.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
net_index	index of net in range [0, net_count-1]

Returns

name of net, or empty string

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanNetListCount

Radio_ScanPlanPriorityRxNetID()

const char* Radio_ScanPlanPriorityRxNetID	(	int	radio_index,
		int	plan_index,
		int	rx_index
	)

Gets the unique ID of a priority receive net for a scanner.

The priority receive net is the channel that the radio will intersperse in

the scan list during active scanning between scan list nets.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
rx_index	index of priority receive net in range [0, priority_rx_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanPriorityRxNetListCount

Radio_ScanPlanPriorityRxNetListCount()

int Radio_ScanPlanPriorityRxNetListCount	(	int	radio_index,
		int	plan_index
	)

Gets the count of priority receive nets in a scan plan for a scanner.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]

Returns

number of priority receive nets in scan plan

See also

Radio_ListCount, Radio_ScanPlanListCount

Radio_ScanPlanPriorityRxNetName()

const char* Radio_ScanPlanPriorityRxNetName	(	int	radio_index,
		int	plan_index,
		int	rx_index
	)

Gets the name of a priority receive net for a scanner.

The priority receive net is the channel that the radio will intersperse in

the scan list during active scanning between scan list nets.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
rx_index	index of priority receive net in range [0, priority_rx_count-1]

Returns

name of net, or empty string

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanPriorityRxNetListCount

Radio_ScanPlanPriorityTxNetID()

const char* Radio_ScanPlanPriorityTxNetID	(	int	radio_index,
		int	plan_index
	)

Gets the unique ID of the priority transmit net for a scanner.

The priority transmit net is the channel that the radio will transmit on if

PTT is pressed during active scanning.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]

Returns

32-character unique identifier of net, or empty string

See also

Radio_ListCount, Radio_ScanPlanListCount

Radio_ScanPlanPriorityTxNetName()

const char* Radio_ScanPlanPriorityTxNetName	(	int	radio_index,
		int	plan_index
	)

Gets the name of the priority transmit net for a scanner.

The priority transmit net is the channel that the radio will transmit on if

PTT is pressed during active scanning.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]

Returns

name of net, or empty string

See also

Radio_ListCount, Radio_ScanPlanListCount

Radio_ScanPrev()

void Radio_ScanPrev

(

int

radio_index

)

Changes to previous net in scan list (manual scanning)

The radio scanner must be enabled and nets defined in active scan plan.

Parameters

radio_index

index of radio in range [0, radio_count-1]

See also

Radio_ListCount, Radio_ScanEnabled, Radio_SetScanEnable

Radio_SetAudioLevelEnable()

void Radio_SetAudioLevelEnable	(	int	radio_index,
		int	enable
	)

Enables or disables audio level calculation for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
enable	1 for enable, 0 for disable

See also

Radio_ListCount, Radio_AudioLevelEnabled

Radio_SetBalance()

void Radio_SetBalance	(	int	radio_index,
		int	balance
	)

Sets the audio balance for a radio.

Audio balance can be left, right or center.

Parameters

radio_index	index of radio in range [0, radio_count-1]
balance	value of type Balance_t

See also

Radio_ListCount, Radio_Balance

Radio_SetCryptoEnable()

void Radio_SetCryptoEnable	(	int	radio_index,
		int	enable
	)

Sets the crypto enable state for a radio.

Enables or disables cipher text transmission for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
enable	1 for enable, 0 for disable

See also

Radio_ListCount, Radio_CryptoEnabled

Radio_SetNet()

void Radio_SetNet	(	int	radio_index,
		int	net_index
	)

Sets the net for a radio by index.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_index	index of net in range [0, net_count-1], or negative value to power off radio

See also

Radio_ListCount, Radio_NetListCount

Radio_SetNetCrypto()

void Radio_SetNetCrypto	(	int	radio_index,
		const char *	net_id,
		int	system,
		int	key
	)

Override the crypto settings for a net assigned to a particular radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_id	32-character unique identifier for net
system	Crypto system
key	Crypto key

See also

Radio_ListCount, Radio_NetID

Radio_SetNetID()

void Radio_SetNetID	(	int	radio_index,
		const char *	net_id
	)

Sets the net for a radio by unique ID.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_id	32-character unique identifier for net, or empty string to power off radio

See also

Radio_ListCount, Radio_NetID

Radio_SetNetRxFrequency()

void Radio_SetNetRxFrequency	(	int	radio_index,
		const char *	net_id,
		unsigned long long	freq
	)

Override the receive frequency for a net assigned to a particular radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_id	32-character unique identifier for net
freq	receive frequency (in Hz)

See also

Radio_ListCount, Radio_NetID

Radio_SetNetTxFrequency()

void Radio_SetNetTxFrequency	(	int	radio_index,
		const char *	net_id,
		unsigned long long	freq
	)

Override the transmit frequency for a net assigned to a particular radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
net_id	32-character unique identifier for net
freq	transmit frequency (in Hz)

See also

Radio_ListCount, Radio_NetID

Radio_SetPlaysound()

void Radio_SetPlaysound	(	int	radio_index,
		const char *	playsound_id
	)

Enables or disables background playsound mixed into mic audio for this radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
playsound_id	32-character unique ID of playsound to enable, or empty string to disable

See also

Radio_ListCount, Playsound_Id

Radio_SetPTT()

void Radio_SetPTT	(	int	radio_index,
		int	ptt_index
	)

Sets the PTT to use for a radio.

Each radio is assigned a PTT that should activate it when pressed.

Use this function to override the default PTT as specified in the Role.

Parameters

radio_index	index of radio in range [0, radio_count-1]
ptt_index	which PTT to use

See also

Radio_PTT, PTT_SetPressed_Multi

Radio_SetRadioEffects()

void Radio_SetRadioEffects	(	int	radio_index,
		const char *	effects_id
	)

Sets the radio effects for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
effects_id	radio effects id to set, empty string to unset

See also

Radio_ListCount, Radio_RadioEffects, RadioEffects_IDFirst, RadioEffects_IDNext

Radio_SetReceiveEnabled()

void Radio_SetReceiveEnabled	(	int	radio_index,
		int	enable
	)

Sets the receive enable for a radio.

Enables or disables receiving of audio for the given radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
enable	1 for enable, 0 for disable

See also

Radio_ListCount

Radio_SetScanEnable()

void Radio_SetScanEnable	(	int	radio_index,
		int	enable
	)

Enables or disables a radio scanner.

The radio scanner must be enabled to perform scanning functions.

Parameters

radio_index	index of radio in range [0, radio_count-1]
enable	1 to enable, 0 to disable

See also

Radio_ListCount, Radio_ScanEnabled

Radio_SetScanHangTime()

void Radio_SetScanHangTime	(	int	radio_index,
		float	seconds
	)

Sets the hang time for a scanner.

The hang time is the number of seconds that a scanner will listen

on a channel after receiving ends before returning to scanning.

Parameters

radio_index	index of radio in range [0, radio_count-1]
seconds	number of seconds (minimum value is 1 second)

See also

Radio_ListCount

Radio_SetScanHoldTime()

void Radio_SetScanHoldTime	(	int	radio_index,
		float	seconds
	)

Sets the hold time for a scanner.

The hold time is the maximum number of seconds that a scanner will listen

on a channel before returning to scanning, even if actively receiving.

Parameters

radio_index	index of radio in range [0, radio_count-1]
seconds	number of seconds (0 to disable)

See also

Radio_ListCount

Radio_SetScanPlanActive()

void Radio_SetScanPlanActive	(	int	radio_index,
		int	plan_index
	)

Sets the active scan plan for a scanner.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanActive

Radio_SetScanPlanPriorityRx()

void Radio_SetScanPlanPriorityRx	(	int	radio_index,
		int	plan_index,
		int	rx_index,
		const char *	net_id
	)

Sets a priority receive net for a scanner.

The priority receive net is the channel that the radio will intersperse in

the scan list during active scanning between scan list nets.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
rx_index	index of priority receive net in range [0, priority_rx_count-1]
net_id	unique ID of a net

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanPriorityRxNetListCount, Radio_ScanPlanNetID

Radio_SetScanPlanPriorityTx()

void Radio_SetScanPlanPriorityTx	(	int	radio_index,
		int	plan_index,
		const char *	net_id
	)

Sets the priority transmit net for a scanner.

The priority transmit net is the channel that the radio will transmit on if

PTT is pressed during active scanning.

Parameters

radio_index	index of radio in range [0, radio_count-1]
plan_index	index of scan plan in range [0, plan_count-1]
net_id	unique ID of a net

See also

Radio_ListCount, Radio_ScanPlanListCount, Radio_ScanPlanNetID

Radio_SetTransmitEnabled()

void Radio_SetTransmitEnabled	(	int	radio_index,
		int	enable
	)

Sets the transmit enable for a radio.

Enables or disables transmission of audio on the selected radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
enable	1 for enable, 0 for disable

See also

Radio_ListCount

Radio_SetVolume()

void Radio_SetVolume	(	int	radio_index,
		float	volume
	)

Sets the receive volume for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
volume	value in range [0.0, 100.0]

See also

Radio_ListCount

Radio_SetVolumeStereo()

void Radio_SetVolumeStereo	(	int	radio_index,
		float	volume_left,
		float	volume_right
	)

Sets the stereo receive volumes for a radio.

Parameters

radio_index	index of radio in range [0, radio_count-1]
volume_left	value in range [0.0, 100.0]
volume_right	value in range [0.0, 100.0]

See also

Radio_ListCount

Radio_StartScan()

void Radio_StartScan

(

int

radio_index

)

Starts scanning.

The radio scanner must be enabled.

Parameters

radio_index

index of radio in range [0, radio_count-1]

See also

Radio_ListCount, Radio_ScanEnabled, Radio_SetScanEnable

Radio_StopScan()

void Radio_StopScan

(

int

radio_index

)

Stops scanning and return to manual scanning mode.

The radio scanner must be enabled.

Parameters

radio_index

index of radio in range [0, radio_count-1]

See also

Radio_ListCount, Radio_ScanEnabled, Radio_SetScanEnable

Radio_Type()

const char* Radio_Type

(

int

radio_index

)

Gets the type of radio (e.g. URC-200)

Used when displaying a radio that is meant to simulate a specific hardware radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

name of radio type (empty string indicates generic radio)

Radio_Version()

int Radio_Version

(

)

Gets the version count for radio updates.

This counter increments when any radio information is updated.

Returns

count of radio updates

Radio_Volume()

float Radio_Volume

(

int

radio_index

)

Gets the receive volume for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

volume in range [0.0, 100.0]

See also

Radio_ListCount

Radio_VolumeStereoLeft()

float Radio_VolumeStereoLeft

(

int

radio_index

)

Gets the stereo (left ear) receive volume for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

volume in range [0.0, 100.0]

See also

Radio_ListCount

Radio_VolumeStereoRight()

float Radio_VolumeStereoRight

(

int

radio_index

)

Gets the stereo (right ear) receive volume for a radio.

Parameters

radio_index

index of radio in range [0, radio_count-1]

Returns

volume in range [0.0, 100.0]

See also

Radio_ListCount

RadioEffects_IDFirst()

const char* RadioEffects_IDFirst

(

)

Get the first radio effect in set of radio effects.

Returns

32-character unique ID of effect, or empty string if none

RadioEffects_IDNext()

const char* RadioEffects_IDNext

(

)

Get the next radio effect in set of radio effects.

Returns

32-character unique ID of effect, or empty string if none

See also

Call_IDFirst

RadioEffects_ListCount()

int RadioEffects_ListCount

(

)

Get the number of radio effects.

Returns

count of radio effects

RadioEffects_Name()

const char* RadioEffects_Name

(

const char *

radio_effects_id

)

Get the name of a radio effect.

Parameters

radio_effects_id

32-character unique ID of radio effect

Returns

Name of radio effect, or empty string if id not found

See also

RadioEffects_IDFirst, RadioEffects_IDNext

RadioEffects_Version()

int RadioEffects_Version

(

)

Gets the version count for radio effects updates.

This counter increments when any radio effects information is updated.

Returns

count of radio effects updates

Role_AutotuneEnabled()

int Role_AutotuneEnabled

(

const char *

role_id

)

Gets whether autotune ability is enabled for a role.

Returns

1 if role_id is valid and autotune enabled, 0 otherwise

Role_CallingEnabled()

int Role_CallingEnabled

(

const char *

role_id

)

Gets whether calling is enabled for a role.

Parameters

role_id

32-character unique identifier for Role

Returns

1 if role_id is valid and calling is enabled, 0 otherwise

Role_CallPTTEnabled()

int Role_CallPTTEnabled

(

const char *

role_id

)

Gets whether PTT is required to transmit audio on a call.

If enabled, audio will only be sent to ongoing call when PTT is

pressed.

If disabled, call audio will be automatically transmitted when on a

call. Pressing PTT in this mode will direct mic audio from ongoing

call to radio transmission.

Parameters

role_id

32-character unique identifier for Role

Returns

1 if role_id is valid and calling is enabled, 0 otherwise

Role_ChannelDisplayMap()

int Role_ChannelDisplayMap	(	const char *	role_id,
		int	index
	)

Get the channel index to display at a given offset.

Parameters

role_id	32-character unique identifier for Role
index	offset in display array

Returns

channel index if channel is assigned at that location, -1 otherwise

Role_ChatEnabled()

int Role_ChatEnabled

(

const char *

role_id

)

Gets whether chat is enabled for a role.

Parameters

role_id

32-character unique identifier for Role

Returns

1 if role_id is valid and chat is enabled, 0 otherwise

Role_Id()

const char* Role_Id

(

int

list_index

)

Gets the unique ID of a specified Role.

Parameters

list_index

index of role in list

Returns

32-character unique identifier of Role, or empty string

See also

Role_ListCount

Role_IdActive()

const char* Role_IdActive

(

)

Gets the unique ID of the current Role.

This value updates only after a successful connection is made.

Returns

32-character unique identifier of Role, or empty string

See also

Role_SetRole

Role_IdSet()

const char* Role_IdSet

(

)

Gets the unique ID of the last-set Role.

This value updates immediately.

Returns

32-character unique identifier for Role, or empty string

See also

Role_SetRole

Role_ListCount()

int Role_ListCount

(

)

Gets the total number of Roles available to the client.

Returns

number of roles

Role_Name()

const char* Role_Name

(

int

list_index

)

Gets the name of a specified Role.

Parameters

list_index

index of role in list

Returns

name of Role, or empty string

See also

Role_ListCount

Role_NameActive()

const char* Role_NameActive

(

)

Gets the name of the current Role.

This value updates only after a successful connection is made.

Returns

name of Role, or empty string

See also

Role_SetRole

Role_NameSet()

const char* Role_NameSet

(

)

Gets the name of the last-set Role.

This value updates immediately.

Returns

name of Role, or empty string

See also

Role_SetRole

Role_RadCtrlEnabled()

int Role_RadCtrlEnabled

(

const char *

role_id

)

Gets whether live radio control ability is enabled for a role.

Returns

1 if role_id is valid and live radio control enabled, 0 otherwise

Role_SetRole()

void Role_SetRole

(

const char *

role_id

)

Sets a new Role to connect with.

Sends a request to connect to a new role with the specified unique ID. When the connection is complete, the value returned by Role_IdActive will match the role_id parameter.

Parameters

role_id

32-character unique identifier for Role

See also

Role_Id

Role_Version()

int Role_Version

(

)

Gets the version count of Role updates.

This counter increments when role information is updated.

Returns

count of role updates

Voisus_ClientBuildVersion()

const char* Voisus_ClientBuildVersion

(

)

Gets the build version of the Voisus client.

Returns

build version string

Voisus_ClientMsgDate()

const char* Voisus_ClientMsgDate

(

)

Gets the timestamp of the Voisus client message protocol.

Returns

version string

Voisus_ClientMsgVersion()

const char* Voisus_ClientMsgVersion

(

)

Gets the version of the Voisus client message protocol.

Returns

version string

Voisus_ConnectCloud()

void Voisus_ConnectCloud

(

const char *

cloud_id

)

Connects to a Voisus Cloud.

Initiates Voisus Client connection to specified server cloud.

Parameters

cloud_id

Unique name of the cloud

Note

This function is blocking and waits for a response before returning.

See also

Network_ConnectState, Network_ConnectionStatus

Voisus_ConnectServer()

void Voisus_ConnectServer

(

const char *

target_ip

)

Connects to a Voisus Server.

Initiates Voisus Client connection to specified server.

Note

This function is blocking and waits for a response before returning.

Parameters

target_ip

IPv4 address of the server

See also

Network_ConnectState, Network_ConnectionStatus

Voisus_Disconnect()

void Voisus_Disconnect

(

)

Disconnects from a Voisus Server.

Disconnects Voisus client from the current connection

See also

Network_ConnectState, Network_ConnectionStatus

Voisus_Error()

int Voisus_Error

(

)

Gets current Voisus error state.

Returns

error code of type Error_t

Voisus_LogPath()

const char* Voisus_LogPath

(

)

Gets the path to the Voisus client log file.

This function is useful for displaying the log in a user application.

Returns

full path to log file

Voisus_MonitorPowerEvents()

void Voisus_MonitorPowerEvents

(

int

hwnd

)

Monitors for system power events (on Windows XP/Vista/7/8)

On system suspend/sleep, the client will exit cleanly.

Parameters

hwnd	A valid window handle (HWND) used by the GUI

Voisus_Save()

void Voisus_Save

(

)

Saves current client configuration to file.

Writes the current settings to a file.
Values will be automatically written after some operations, therefore this function is optional. The last saved settings are automatically loaded when the Voisus Client process starts.

Voisus_ServerBuildVersion()

const char* Voisus_ServerBuildVersion

(

)

Gets the build version of the Voisus server.

Returns

build version string

Voisus_ServerMsgDate()

const char* Voisus_ServerMsgDate

(

)

Gets the timestamp of the Voisus server message protocol.

Returns

version string

Voisus_ServerMsgVersion()

const char* Voisus_ServerMsgVersion

(

)

Gets the version of the Voisus server message protocol.

Returns

version string

Voisus_SetServerMasterVolume()

void Voisus_SetServerMasterVolume

(

float

volume

)

Sets the master volume on the server.

This volume affects software clients as well as hardware devices

like ACU2 or AI-S.

Parameters

volume

value in range [0.0, 100.0]

Voisus_SetServerSidetoneVolume()

void Voisus_SetServerSidetoneVolume

(

float

volume

)

Sets the sidetone volume on the server.

This volume only applies to hardware devices like ACU2 or AI-S.

Parameters

volume

value in range [0.0, 100.0]

VRCC_Shutdown()

void VRCC_Shutdown

(

)

Shuts down the VRC messaging client.

This function should be called before exiting the program.

Note

This function is blocking and will return after the VRC client shuts down.

VRCC_Start()

int VRCC_Start	(	int	argc,
		char *	argv[]
	)

Starts the VRC messaging client.

This function must be called before any other VRCC API calls can be made.

Parameters

argc	Count of arguments passed to main Voisus client process
argv	NULL-terminated list of arguments

Note

This function is blocking and will return after the VRC client starts.

Returns

1 on success, 0 on error

VRCC_Update()

int VRCC_Update

(

void

)

Update the internal state of the VRC Client.

This function must be called in order to receive any updates to the

state of the VRC Client. Typically this will be called in the main

execution loop before accessing any other API calls.

Returns

1 on state changed, 0 otherwise

WorldPosition_Set()

void WorldPosition_Set	(	float	xcoord,
		float	ycoord,
		float	zcoord
	)

Sets the world position for a Voisus operator.

The world position is specified in geocentric x, y, z coordinates. Coordinates are used to position a player in the three-dimensional audio space for interaction with the Earshot audio environment.

Parameters

xcoord	X coordinate
ycoord	Y coordinate
zcoord	Z coordinate