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... | |
| 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... | |
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.
| const char* AudioDevice_IDActive | ( | AudioDeviceType_t | type | ) |
Gets the unique ID of the active Playback audio device.
Playback devices are speakers and headsets
| type | Type of audio device (playback/capture) of type AudioDeviceType_t |
| const char* AudioDevice_IDFirst | ( | AudioDeviceType_t | type | ) |
Get the first audio device of specified type.
| type | Type of audio device (playback/capture) of type AudioDeviceType_t |
| const char* AudioDevice_IDNext | ( | AudioDeviceType_t | type | ) |
Get the next audio device of specified type.
| type | Type of audio device (playback/capture) of type AudioDeviceType_t |
| const char* AudioDevice_Name | ( | AudioDeviceType_t | type, |
| const char * | id | ||
| ) |
Get the name of an audio device of specified type by ID.
| type | Type of audio device (playback/capture) of type AudioDeviceType_t |
| id | Unique ID of device |
| void AudioDevice_SetDevice | ( | AudioDeviceType_t | type, |
| const char * | id | ||
| ) |
Set the audio device (playback or capture) to use.
| type | Type of audio device (playback/capture) of type AudioDeviceType_t |
| id | Unique ID of device |
| int AudioDevice_Version | ( | ) |
Gets the version count of Audio Device updates.
This counter increments when audio device information is updated.
| void AuxAudio_Enable | ( | int | enable, |
| unsigned int | sample_rate, | ||
| unsigned int | encoding | ||
| ) |
Enable/disable auxiliary audio input to client.
| enable | 1 for enable, 0 for disable |
| sample_rate | Audio sample rate (in Hz) |
| encoding | Audio sample encoding (in AudioEncoding_t) |
| void AuxAudio_Register | ( | AudioCallback | func | ) |
Register callback to receive auxiliary audio from server.
| func | Audio callback function of type AudioCallback |
| void AuxAudio_Send | ( | unsigned char * | samples, |
| unsigned int | len | ||
| ) |
Send auxiliary audio to server (substitute for mic audio)
| samples | Audio samples |
| len | Length of audio samples (in bytes) |
| const char* Call_Create | ( | ) |
Create a new call and join it.
For more information, see documentation on Calls.
| const char* Call_Endpoint_IDFirst | ( | const char * | call_id | ) |
Get the first Endpoint for a call.
| const char* Call_Endpoint_IDNext | ( | const char * | call_id | ) |
Get the next Endpoint for a call.
| 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.
| call_id | 32-character unique ID of call |
| ep_id | 32-character unique ID of endpoint |
| int Call_Endpoint_Version | ( | ) |
Gets the version count for call and endpoint updates.
This counter increments when any Call or Endpoint information is updated
| void Call_GetLock | ( | ) |
Gets the lock on all Call and Endpoint data.
| const char* Call_IDFirst | ( | ) |
Get the first call in set of calls for this endpoint.
| const char* Call_IDNext | ( | ) |
Get the next call in set of calls for this endpoint.
| 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.
| int Call_Invitation_First | ( | CallInvitation_t * | invite | ) |
Get the first Invitation from list.
Invitations will remain until cleared with Call_Invitation_ClearAll
| invite | pointer to structure of type CallInvitation_t (for return value) |
| int Call_Invitation_Next | ( | CallInvitation_t * | invite | ) |
Get the next Invitation from list.
Invitations will remain until cleared with Call_Invitation_ClearAll
| invite | pointer to structure of type CallInvitation_t (for return value) |
| int Call_Invitation_Version | ( | ) |
Gets the version count for call invitation updates.
This counter increments when any invitation is added
| void Call_Invite | ( | const char * | call_id, |
| const char * | endpoint_id | ||
| ) |
Send an invitation to another endpoint.
For more information, see documentation on Invitations.
| call_id | 32-character unique ID of call |
| endpoint_id | 32-character unique ID of endpoint to invite |
| 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.
For more information, see documentation on Invitations.
| 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 |
| void Call_InviteCrew | ( | ) |
Invite all members of crew to a call.
| void Call_Leave | ( | const char * | call_id, |
| int | leave_reason | ||
| ) |
Leave a call with a specified reason.
For more information, see documentation on Calls.
| call_id | 32-character unique ID of call |
| leave_reason | reason of type ::CallLeave_t |
| 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.
| call_id | 32-character unique ID of call |
| call_id | 32-character unique ID of endpoint |
| int Call_ListCount | ( | ) |
Get the size of the set of calls for this endpoint.
| 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
| call_id | 32-character unique ID of call |
| keys | string containing the keys to be pressed in sequence (e.g. "123#") |
| 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.
| call_id | 32-character unique ID of call |
| call_state | state of type ::CallProgress_t |
| void Call_ReleaseLock | ( | ) |
Releases the lock on all Call and Endpoint data.
| void Cloud_GetLock | ( | ) |
Gets the lock on all Cloud data.
| int Cloud_GetServerCount | ( | const char * | uuid | ) |
Gets the current number of detected clouds.
| const char* Cloud_IDFirst | ( | ) |
Get the first Cloud.
| const char* Cloud_IDNext | ( | ) |
Get the next Cloud.
| int Cloud_ListCount | ( | ) |
Gets the current number of detected clouds.
| void Cloud_ReleaseLock | ( | ) |
Releases the lock on all Cloud data.
| int Cloud_Version | ( | ) |
Gets the version count for Clouds.
This counter increments when any cloud information is updated. (e.g. new server added/removed)
| int Codec_Get | ( | ) |
Gets currently selected Codec.
| void Codec_Set | ( | int | codec | ) |
Sets a new Codec.
| codec | value of type ::Codec_t |
| int DIS_GetExercise | ( | ) |
Get DIS exercise for operator radios.
| void DIS_GetParams | ( | DISParams_t * | dis_params | ) |
Get DIS parameters configured on server for an operator.
Values are returned in the DISParams_t structure
| void DIS_SetExercise | ( | int | exercise | ) |
Update DIS exercise for operator radios.
| exercise | value of new exercise in the range 1-255 |
| 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.
| 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.
| enable | non-zero for enable, 0 for disable |
| int Earshot_Receiving | ( | void | ) |
| 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.
| ptt | 1 for pressed, 0 otherwise |
| int Earshot_Transmitting | ( | void | ) |
| const char* EntityState_Id | ( | int | list_index | ) |
Gets the unique ID of a specified Entity State (Vehicle)
| list_index | index of entity state in list |
| const char* EntityState_IdActive | ( | ) |
Gets the unique ID of the currently selected Entity State.
This value updates only after Entity State is set successfully
| const char* EntityState_IdSet | ( | ) |
Gets the unique ID of the last-set Entity State (Vehicle)
This value updates immediately
| int EntityState_ListCount | ( | ) |
Gets the total number of Entity States (Vehicles) available to the client.
| const char* EntityState_Name | ( | int | list_index | ) |
Gets the name of a specified Entity State (Vehicle)
| list_index | index of entity state in list |
| const char* EntityState_NameActive | ( | ) |
Gets the name of the current Entity State (Vehicle)
This value updates only after Entity State is set successfully
| const char* EntityState_NameSet | ( | ) |
Gets the name of the last-set Entity State.
This value updates immediately
| 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.
| id | 32-character unique identifier for Entity State |
| int EntityState_Version | ( | ) |
Gets the version count of Entity State updates.
This counter increments when entity state information is updated.
| int Headset_DeviceConfigured | ( | ) |
Gets whether client successfully configure an audio device.
| float Headset_EarphoneVolume | ( | ) |
Gets the earphone volume.
| int Headset_HasSidetone | ( | ) |
Gets whether headset has sidetone.
| 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.
| float Headset_MicVolume | ( | ) |
Gets the microphone volume.
| void Headset_SetCallMicrophoneMute | ( | int | active | ) |
Sets the microphone mute during an active call.
| active | 1 => mute is active, 0 => mute is inactive |
| void Headset_SetEarphoneVolume | ( | float | volume | ) |
Sets the earphone volume.
| volume | value in range [0.0, 100.0] |
| 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.
| preset | value of type ::HeadsetPreset_t |
| 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.
| mode | value of type ::MicMode_t |
| void Headset_SetMicVolume | ( | float | volume | ) |
Sets the microphone volume.
| volume | value in range [0.0, 100.0] |
| 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.
| volume | value in range [0.0, 100.0] |
| 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.
| threshold | value in range [0.0, 100.0] |
| 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.
| float Headset_VoxThreshold | ( | ) |
Gets the vox threshold.
Threshold for Vox system. Higher thresholds require greater voice volume to trigger transmission.
| int Jammer_IsTransmitting | ( | int | jammer_index | ) |
Gets the transmit state for a jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| int Jammer_ListCount | ( | ) |
Gets the current number of jammers.
| const char* Jammer_NetID | ( | int | jammer_index, |
| int | net_index | ||
| ) |
Gets the unique ID of a net for a jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| net_index | index of net in range [0, net_count-1] |
| const char* Jammer_NetIDActive | ( | int | jammer_index | ) |
Gets the unique ID of currently selected net for a jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| int Jammer_NetListCount | ( | int | jammer_index | ) |
Gets the number of nets for a jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| const char* Jammer_NetName | ( | int | jammer_index, |
| int | net_index | ||
| ) |
Gets the name of a net for a jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| net_index | index of net in range [0, net_count-1] |
| int Jammer_RecordReplayDurationMs | ( | int | jammer_index | ) |
Get the duration of the last recording in milliseconds.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| int Jammer_RecordReplayProgress | ( | int | jammer_index | ) |
Get the progress of an active recording or replaying.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| int Jammer_RecordReplayState | ( | int | jammer_index | ) |
Get the current state of the jammer's record/replay functions.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| void Jammer_SetEnable | ( | int | jammer_index, |
| int | enable | ||
| ) |
Enable/disable a jammer to begin/end transmission.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| enable | 0 to disable, otherwise enable |
| void Jammer_SetNetID | ( | int | jammer_index, |
| const char * | net_id | ||
| ) |
Sets the net for a jammer by unique ID.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| net_id | 32-character unique identifier for net |
| 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
| jammer_index | index of jammer in range [0, jammer_count-1] |
| duration_secs | Maximum duration of recording in range [1, 30] |
| 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)
| jammer_index | index of jammer in range [0, jammer_count-1] |
| loop | 1 to enable looping playback, 0 to play once |
| void Jammer_StopRecording | ( | int | jammer_index | ) |
Stop recording audio received by the jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| void Jammer_StopReplaying | ( | int | jammer_index | ) |
Stop transmitting previously recorded audio out the jammer.
| jammer_index | index of jammer in range [0, jammer_count-1] |
| int Jammer_Version | ( | ) |
Gets the version count for jammer updates.
This counter increments when any jammer information is updated.
| int Joystick_Active | ( | ) |
Gets the active joystick index.
| int Joystick_Active_Multi | ( | int | ptt | ) |
Gets the active joystick index for a specified PTT.
| ptt | index of PTT to query (0 for primary, 1 for secondary) |
| int Joystick_ButtonActive | ( | ) |
Gets the active joystick button index.
| int Joystick_ButtonActive_Multi | ( | int | ptt | ) |
Gets the active joystick button index.
| ptt | index of PTT to query (0 for primary, 1 for secondary) |
| int Joystick_ButtonCount | ( | int | list_index | ) |
Gets the number of buttons for a specified joystick.
| list_index | index of joystick in the range [0, number of joysticks - 1] |
| int Joystick_ListCount | ( | ) |
Gets the current number of detected joysticks.
| const char* Joystick_Name | ( | int | list_index | ) |
Gets the name of a specified joystick.
| list_index | index of joystick in the range [0, number of joysticks - 1] |
| int Joystick_Pressed | ( | ) |
Gets the current joystick pressed state.
| int Joystick_Pressed_Multi | ( | int | ptt | ) |
Gets the current joystick pressed state.
| ptt | index of PTT to query (0 for primary, 1 for secondary) |
| 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.
| js | index of joystick |
| btn | index of button |
| 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.
| ptt | index of PTT to query (0 for primary, 1 for secondary) |
| js | index of joystick |
| btn | index of button |
| void License_Release | ( | int | license_id | ) |
Release a license.
Check status of license request (pending, granted, released or
lost) with License_Status.
| license_id | Identifier for license |
| 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.
| type | Type of license |
| int License_Status | ( | int | license_id | ) |
Get status of license request.
| license_id | Identifier for license |
| 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.
| function | the function or scope that wrote the message |
| msg | the log message |
| const char* Network_ClientIP | ( | ) |
Gets the Client address used to connect to the Server.
| const char* Network_ClientName | ( | ) |
Gets the user-settable client name.
The client name is published on the Server and to other clients.
| const char* Network_CloudActive | ( | ) |
Gets the currently connected Cloud.
| const char* Network_CloudSet | ( | ) |
Gets the last set Cloud to connect to.
| int Network_ConnectionMode | ( | ) |
Get the current connection mode (e.g. Cloud)
| 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.
| int Network_ConnectState | ( | ) |
Gets the detailed connection state of the client.
This function returns detailed information about the connection including getting/setting Role information.
| 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.
| void Network_SetClientName | ( | const char * | name | ) |
Sets the client name.
The client name is published on the Server and to other clients.
| name | User-settable name for the client. |
| const char* Network_TargetIP | ( | ) |
Gets the Voisus Server address.
| 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.
| uuid | 32-character unique ID of Operator |
| field_name | name of field |
| void Operator_GetLock | ( | ) |
Gets the lock on all Operator data.
| const char* Operator_IDFirst | ( | ) |
Get the first Operator.
| const char* Operator_IDNext | ( | ) |
Get the next Operator.
| int Operator_ListCount | ( | ) |
Gets the current number of Operators.
| void Operator_ReleaseLock | ( | ) |
Releases the lock on all Operator data.
| 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
| const char* Phone_CallActive | ( | ) |
Get the active call ID.
| int Phone_ListCount | ( | ) |
Get the count phones for this endpoint.
For more information, see documentation on Phones.
| void Phone_SetCall | ( | const char * | call_id | ) |
Set the active call for phone.
For more information, see documentation on Phones.
| call_id | 32-character unique ID of call, or empty string to clear |
| void Phone_SetVolume | ( | float | volume | ) |
Sets the receive volume for a phone.
| volume | value in range [0.0, 100.0] |
| float Phone_Volume | ( | ) |
Get the receive volume for a phone.
| const char* Playsound_Id | ( | int | playsound_index | ) |
Gets the unique ID of a specified playsound.
| playsound_index | index of playsound in the range [0, count of playsounds - 1] |
| int Playsound_ListCount | ( | void | ) |
Gets the current number of Client Playsounds.
| const char* Playsound_Name | ( | const char * | playsound_id | ) |
Gets the name of a specified playsound.
| playsound_id | 32-character unique ID of playsound |
| int Playsound_Version | ( | void | ) |
Gets the version count of Playsound updates.
This counter increments when playsound information is updated.
| 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).
| 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).
| ptt | index of PTT to query |
| 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.
| 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).
| ptt | index of hardware PTT to query |
| 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.
| pressed | 1 for pressed, 0 otherwise |
| 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.
| ptt | index of PTT to update |
| pressed | 1 for pressed, 0 otherwise |
| const char* RadCtrl_Error | ( | ) |
Get error string for last radio control "set" operation.
| 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
| const char* RadCtrl_GetOptionsStr | ( | const char * | name, |
| const char * | setting | ||
| ) |
Get list of options for a live radio string setting.
| name | name of live radio to control |
| setting | name of setting for retrieve options list for |
| 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 |
| name | name of live radio to control |
| setting | name of value to retrieve |
| 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" |
| name | name of live radio to control |
| setting | name of value to retrieve |
| 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 |
| name | name of live radio to control |
| setting | name of value to retrieve |
| int RadCtrl_ListCount | ( | ) |
Gets the number of radios that can be controlled.
| const char* RadCtrl_Name | ( | int | index | ) |
Gets the name of a live radio to control.
| void RadCtrl_Poll | ( | const char * | name | ) |
Poll server for updated radio state information.
| name | name of live radio to control |
| 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 |
| name | name of live radio to control |
| setting | name of setting to modify |
| value | new value for setting |
| 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" |
| name | name of live radio to control |
| setting | name of setting to modify |
| value | new value for setting |
| 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 |
| name | name of live radio to control |
| setting | name of setting to modify |
| value | new value for setting |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_AudioLevelEnabled | ( | int | radio_index | ) |
Gets whether audio level calculation is enabled for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_Balance | ( | int | radio_index | ) |
Gets the audio balance for a radio (left, right, center)
| radio_index | index of radio in range [0, radio_count-1] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_CryptoEnabled | ( | int | radio_index | ) |
Gets whether radio has crypto mode enabled.
Enabled means cipher text mode. Disabled means plain text mode.
| radio_index | index of radio in range [0, radio_count-1] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_IsReceiveEnabled | ( | int | radio_index | ) |
Gets the receive enable for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_IsReceiving | ( | int | radio_index | ) |
Gets the receive state for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| 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).
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_IsTransmitEnabled | ( | int | radio_index | ) |
Gets the transmit enable for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_IsTransmitting | ( | int | radio_index | ) |
Gets the transmit state for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_ListCount | ( | ) |
Gets the current number of radios.
| const char* Radio_Name | ( | int | radio_index | ) |
Gets the name of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_NetCryptoEnabled | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the crypto enabled of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| int Radio_NetCryptoEnabledActive | ( | int | radio_index | ) |
Get the crypto enable state for the currently tuned net of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_NetCryptoKey | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the crypto key of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| int Radio_NetCryptoKeyActive | ( | int | radio_index | ) |
Get the crypto key for the currently tuned net of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_NetCryptoSystem | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the crypto system of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| int Radio_NetCryptoSystemActive | ( | int | radio_index | ) |
Get the crypto system for the currently tuned net of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| 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"
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| unsigned long long Radio_NetFrequency | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the frequency of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| const char* Radio_NetID | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the unique ID of a net for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| const char* Radio_NetIDActive | ( | int | radio_index | ) |
Gets the unique ID of currently selected net for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_NetListCount | ( | int | radio_index | ) |
Gets the number of nets for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| const char* Radio_NetName | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the name of a net by index for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| const char* Radio_NetNameActive | ( | int | radio_index | ) |
Gets the name of currently selected net for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| unsigned long long Radio_NetRxFrequencyActive | ( | int | radio_index | ) |
Get the receive frequency for the currently tuned net of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_NetSatcomChannel | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the SATCOM channel of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| int Radio_NetTuningMethod | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the tuning method of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| unsigned long long Radio_NetTxFrequencyActive | ( | int | radio_index | ) |
Get the transmit frequency for the currently tuned net of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| const char* Radio_NetWaveform | ( | int | radio_index, |
| int | net_index | ||
| ) |
Gets the waveform of the radio's net.
| radio_index | index of radio in range [0, radio_count-1] |
| net_index | index of net in range [0, net_count-1] |
| const char* Radio_NetWaveformActive | ( | int | radio_index | ) |
Get the waveform (mode) for the currently tuned net of a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| const char* Radio_Playsound | ( | int | radio_index | ) |
Gets the unique ID of sound mixed into mic audio for this radio.
| radio_index | index of radio in range [0, radio_count-1] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_PTT | ( | int | radio_index | ) |
Gets the PTT identifier for the radio.
Return value of 0 indicates primary PTT, 1 is secondary, etc.
| radio_index | index of radio in range [0, radio_count-1] |
| const char* Radio_RadCtrlId | ( | int | radio_index | ) |
Gets the Radio Control Id of a radio configured to control live radios.
| radio_index | index of radio in range [0, radio_count-1] |
| const char* Radio_RadioEffects | ( | int | radio_index | ) |
Gets the radio effects set for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| void Radio_SetAudioLevelEnable | ( | int | radio_index, |
| int | enable | ||
| ) |
Enables or disables audio level calculation for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| enable | 1 for enable, 0 for disable |
| void Radio_SetBalance | ( | int | radio_index, |
| int | balance | ||
| ) |
Sets the audio balance for a radio.
Audio balance can be left, right or center.
| radio_index | index of radio in range [0, radio_count-1] |
| balance | value of type Balance_t |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| enable | 1 for enable, 0 for disable |
| void Radio_SetNet | ( | int | radio_index, |
| int | net_index | ||
| ) |
Sets the net for a radio by index.
| 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 |
| 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.
| 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 |
| void Radio_SetNetID | ( | int | radio_index, |
| const char * | net_id | ||
| ) |
Sets the net for a radio by unique ID.
| 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 |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| net_id | 32-character unique identifier for net |
| freq | receive frequency (in Hz) |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| net_id | 32-character unique identifier for net |
| freq | transmit frequency (in Hz) |
| void Radio_SetPlaysound | ( | int | radio_index, |
| const char * | playsound_id | ||
| ) |
Enables or disables background playsound mixed into mic audio for this radio.
| 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 |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| ptt_index | which PTT to use |
| void Radio_SetRadioEffects | ( | int | radio_index, |
| const char * | effects_id | ||
| ) |
Sets the radio effects for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| effects_id | radio effects id to set, empty string to unset |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| enable | 1 for enable, 0 for disable |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| enable | 1 for enable, 0 for disable |
| void Radio_SetVolume | ( | int | radio_index, |
| float | volume | ||
| ) |
Sets the receive volume for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| volume | value in range [0.0, 100.0] |
| void Radio_SetVolumeStereo | ( | int | radio_index, |
| float | volume_left, | ||
| float | volume_right | ||
| ) |
Sets the stereo receive volumes for a radio.
| 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] |
| 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.
| radio_index | index of radio in range [0, radio_count-1] |
| int Radio_Version | ( | ) |
Gets the version count for radio updates.
This counter increments when any radio information is updated.
| float Radio_Volume | ( | int | radio_index | ) |
Gets the receive volume for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| float Radio_VolumeStereoLeft | ( | int | radio_index | ) |
Gets the stereo (left ear) receive volume for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| float Radio_VolumeStereoRight | ( | int | radio_index | ) |
Gets the stereo (right ear) receive volume for a radio.
| radio_index | index of radio in range [0, radio_count-1] |
| const char* RadioEffects_IDFirst | ( | ) |
Get the first radio effect in set of radio effects.
| const char* RadioEffects_IDNext | ( | ) |
Get the next radio effect in set of radio effects.
| int RadioEffects_ListCount | ( | ) |
Get the number of radio effects.
| const char* RadioEffects_Name | ( | const char * | radio_effects_id | ) |
Get the name of a radio effect.
| radio_effects_id | 32-character unique ID of radio effect |
| int RadioEffects_Version | ( | ) |
Gets the version count for radio effects updates.
This counter increments when any radio effects information is updated.
| int Role_AutotuneEnabled | ( | const char * | role_id | ) |
Gets whether autotune ability is enabled for a role.
| int Role_CallingEnabled | ( | const char * | role_id | ) |
Gets whether calling is enabled for a role.
| role_id | 32-character unique identifier for Role |
| 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.
| role_id | 32-character unique identifier for Role |
| int Role_ChannelDisplayMap | ( | const char * | role_id, |
| int | index | ||
| ) |
Get the channel index to display at a given offset.
| role_id | 32-character unique identifier for Role |
| index | offset in display array |
| int Role_ChatEnabled | ( | const char * | role_id | ) |
Gets whether chat is enabled for a role.
| role_id | 32-character unique identifier for Role |
| const char* Role_Id | ( | int | list_index | ) |
Gets the unique ID of a specified Role.
| list_index | index of role in list |
| const char* Role_IdActive | ( | ) |
Gets the unique ID of the current Role.
This value updates only after a successful connection is made.
| const char* Role_IdSet | ( | ) |
Gets the unique ID of the last-set Role.
This value updates immediately.
| int Role_ListCount | ( | ) |
Gets the total number of Roles available to the client.
| const char* Role_Name | ( | int | list_index | ) |
Gets the name of a specified Role.
| list_index | index of role in list |
| const char* Role_NameActive | ( | ) |
Gets the name of the current Role.
This value updates only after a successful connection is made.
| const char* Role_NameSet | ( | ) |
Gets the name of the last-set Role.
This value updates immediately.
| int Role_RadCtrlEnabled | ( | const char * | role_id | ) |
Gets whether live radio control ability is enabled for a role.
| 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.
| role_id | 32-character unique identifier for Role |
| int Role_Version | ( | ) |
Gets the version count of Role updates.
This counter increments when role information is updated.
| const char* Voisus_ClientBuildVersion | ( | ) |
Gets the build version of the Voisus client.
| const char* Voisus_ClientMsgDate | ( | ) |
Gets the timestamp of the Voisus client message protocol.
| const char* Voisus_ClientMsgVersion | ( | ) |
Gets the version of the Voisus client message protocol.
| void Voisus_ConnectCloud | ( | const char * | cloud_id | ) |
Connects to a Voisus Cloud.
Initiates Voisus Client connection to specified server cloud.
| cloud_id | Unique name of the cloud |
| void Voisus_ConnectServer | ( | const char * | target_ip | ) |
Connects to a Voisus Server.
Initiates Voisus Client connection to specified server.
| target_ip | IPv4 address of the server |
| void Voisus_Disconnect | ( | ) |
Disconnects from a Voisus Server.
Disconnects Voisus client from the current connection
| int Voisus_Error | ( | ) |
Gets current Voisus error state.
| 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.
| 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.
| hwnd | A valid window handle (HWND) used by the GUI |
| 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.
| const char* Voisus_ServerBuildVersion | ( | ) |
Gets the build version of the Voisus server.
| const char* Voisus_ServerMsgDate | ( | ) |
Gets the timestamp of the Voisus server message protocol.
| const char* Voisus_ServerMsgVersion | ( | ) |
Gets the version of the Voisus server message protocol.
| 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.
| volume | value in range [0.0, 100.0] |
| void Voisus_SetServerSidetoneVolume | ( | float | volume | ) |
Sets the sidetone volume on the server.
This volume only applies to hardware devices like ACU2 or AI-S.
| volume | value in range [0.0, 100.0] |
| void VRCC_Shutdown | ( | ) |
Shuts down the VRC messaging client.
This function should be called before exiting the program.
| 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.
| argc | Count of arguments passed to main Voisus client process |
| argv | NULL-terminated list of arguments |
| 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.
| 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.
| xcoord | X coordinate |
| ycoord | Y coordinate |
| zcoord | Z coordinate |