vrc_types.h File Reference

Data Structures
struct	DISParams_t
	DIS parameters. More...
struct	CallInvitation_t
	Call invitation. More...

Typedefs
typedef enum ConnectionStatus_t	ConnectionStatus_t
	Client connection status. More...
typedef enum ConnectionMode_t	ConnectionMode_t
	Connection Modes. More...
typedef enum ConnectState_t	ConnectState_t
	Role connection states. More...
typedef enum TestMode_t	TestMode_t
	Test modes. More...
typedef enum AudioEncoding_t	AudioEncoding_t
	Audio Encoding. More...
typedef enum Balance_t	Balance_t
	Audio Balance. More...
typedef enum RadioTuningMethod_t	RadioTuningMethod_t
	Radio tuning methods. More...
typedef void(*	AudioCallback) (char *left_bytes, unsigned int left_len, unsigned int left_samples, char *right_bytes, unsigned int right_len, unsigned int right_samples)
	Auxiliary Audio Callback. More...
typedef enum LicenseStatus_t	LicenseStatus_t
	License request status. More...
typedef enum AudioDeviceType_t	AudioDeviceType_t
	Audio Device Types. More...
typedef enum JammerRecordReplayState_t	JammerRecordReplayState_t
	Jammer Record/Replay State. More...
typedef enum Error_t	Error_t
	Error conditions. More...

Enumerations
enum	ConnectionStatus_t { STATUS_NONE, STATUS_DISCONNECTED, STATUS_CONNECTED }
	Client connection status. More...
enum	ConnectionMode_t { CONNECT_MODE_NONE, CONNECT_MODE_SOLO, CONNECT_MODE_SERVER, CONNECT_MODE_CLOUD }
	Connection Modes. More...
enum	ConnectState_t {   TARGET_CONNECT, ROLE_GET, ROLES_RECEIVED, ROLE_SET,   ROLE_CONNECT, ROLE_CONNECTED, TARGET_AUTHORIZE, TARGET_HEARTBEAT }
	Role connection states. More...
enum	TestMode_t {   TEST_OFF, TEST_WAVE, TEST_SIDETONE, TEST_LOOPBACK,   TEST_SEND_WAVE, TEST_MIC }
	Test modes. More...
enum	AudioEncoding_t { AUDIO_ENCODING_MULAW = 1, AUDIO_ENCODING_SPCM16 = 4 }
	Audio Encoding. More...
enum	Balance_t {   BALANCE_OFF = 0, BALANCE_LEFT = 1, BALANCE_RIGHT = 2, BALANCE_STEREO = 3,   BALANCE_CENTER = 128 }
	Audio Balance. More...
enum	RadioTuningMethod_t {   RADIO_TUNE_FREQ_BW = 1, RADIO_TUNE_FREQ = 2, RADIO_TUNE_VOIP = 3, RADIO_TUNE_HQ = 4,   RADIO_TUNE_SG = 5, RADIO_TUNE_HFECCM = 6, RADIO_TUNE_AMBSOUND = 7 }
	Radio tuning methods. More...
enum	LicenseStatus_t { LICENSE_STATUS_PENDING = 1, LICENSE_STATUS_GRANTED = 2, LICENSE_STATUS_RELEASED = 3, LICENSE_STATUS_LOST = 4 }
	License request status. More...
enum	AudioDeviceType_t { AUDIO_DEVICE_PLAYBACK = 1, AUDIO_DEVICE_CAPTURE = 2 }
	Audio Device Types. More...
enum	JammerRecordReplayState_t {   JAMMER_STATE_INIT = 1, JAMMER_STATE_WAITING = 2, JAMMER_STATE_RECORDING = 3, JAMMER_STATE_REPLAYING = 4,   JAMMER_STATE_IDLE = 5 }
	Jammer Record/Replay State. More...
enum	Error_t { ERROR_OFF, ERROR_CREDITS, ERROR_VOISUS, ERROR_AUTHORIZE }
	Error conditions. More...

Typedef Documentation

AudioCallback

typedef void(* AudioCallback) (char *left_bytes, unsigned int left_len, unsigned int left_samples, char *right_bytes, unsigned int right_len, unsigned int right_samples)

Auxiliary Audio Callback.

Parameters

left_bytes	Bytes of audio received
left_len	Length of bytes received
left_samples	Count of samples received
right_bytes	Bytes of audio received
right_len	Length of bytes received
right_samples	Count of samples received

See also

AuxAudio_Register

AudioDeviceType_t

typedef enum AudioDeviceType_t AudioDeviceType_t

Audio Device Types.

AudioEncoding_t

typedef enum AudioEncoding_t AudioEncoding_t

Audio Encoding.

Balance_t

typedef enum Balance_t Balance_t

Audio Balance.

ConnectionMode_t

typedef enum ConnectionMode_t ConnectionMode_t

Connection Modes.

ConnectionStatus_t

typedef enum ConnectionStatus_t ConnectionStatus_t

Client connection status.

ConnectState_t

typedef enum ConnectState_t ConnectState_t

Role connection states.

Error_t

typedef enum Error_t Error_t

Error conditions.

JammerRecordReplayState_t

typedef enum JammerRecordReplayState_t JammerRecordReplayState_t

Jammer Record/Replay State.

LicenseStatus_t

typedef enum LicenseStatus_t LicenseStatus_t

License request status.

RadioTuningMethod_t

typedef enum RadioTuningMethod_t RadioTuningMethod_t

Radio tuning methods.

TestMode_t

typedef enum TestMode_t TestMode_t

Test modes.

Enumeration Type Documentation

AudioDeviceType_t

enum AudioDeviceType_t

Audio Device Types.

Enumerator
AUDIO_DEVICE_PLAYBACK	Playback device (Speakers, Headsets)
AUDIO_DEVICE_CAPTURE	Capture device (Microphone)

AudioEncoding_t

enum AudioEncoding_t

Audio Encoding.

Enumerator
AUDIO_ENCODING_MULAW	8-bit Mulaw (G.711) encoding
AUDIO_ENCODING_SPCM16	16-bit Signed PCM encoding

Balance_t

enum Balance_t

Audio Balance.

Enumerator
BALANCE_OFF	No audio.
BALANCE_LEFT	Audio played on left.
BALANCE_RIGHT	Audio played on right.
BALANCE_STEREO	Audio played on left and right (stereo)
BALANCE_CENTER	Audio played on center (mono)

ConnectionMode_t

enum ConnectionMode_t

Connection Modes.

Enumerator
CONNECT_MODE_NONE	No connection mode.
CONNECT_MODE_SOLO	Connecting to local radio environment.
CONNECT_MODE_SERVER	Connecting to remote Voisus server.
CONNECT_MODE_CLOUD	Connecting to an ASTi cloud.

ConnectionStatus_t

enum ConnectionStatus_t

Client connection status.

Enumerator
STATUS_NONE	Client has not connected to a target.
STATUS_DISCONNECTED	Client has disconnected from a target.
STATUS_CONNECTED	Client is currently connected to a target.

ConnectState_t

enum ConnectState_t

Role connection states.

Enumerator
TARGET_CONNECT	Connecting to Target.
ROLE_GET	Connected to Target, requesting roles.
ROLES_RECEIVED	Received roles.
ROLE_SET	Sending role request.
ROLE_CONNECT	Role request confirmed, Acquiring license for Operator.
ROLE_CONNECTED	Connected to Operator.
TARGET_AUTHORIZE	Authorizing with Target.
TARGET_HEARTBEAT	Waiting for Target response.

Error_t

enum Error_t

Error conditions.

Enumerator
ERROR_OFF	No error.
ERROR_CREDITS	Credit system error.
ERROR_VOISUS	Voisus Server error, check log.
ERROR_AUTHORIZE	Error authorizing with server. Authorization requires a client name that matches the Software Clients settings in the running scenario

JammerRecordReplayState_t

enum JammerRecordReplayState_t

Jammer Record/Replay State.

Enumerator
JAMMER_STATE_INIT	Initial state, no recording completed.
JAMMER_STATE_WAITING	Waiting to record next received audio.
JAMMER_STATE_RECORDING	Recording audio.
JAMMER_STATE_REPLAYING	Replaying audio.
JAMMER_STATE_IDLE	Idle state with audio recorded.

LicenseStatus_t

enum LicenseStatus_t

License request status.

Enumerator
LICENSE_STATUS_PENDING	Request pending.
LICENSE_STATUS_GRANTED	Request granted.
LICENSE_STATUS_RELEASED	Request released.
LICENSE_STATUS_LOST	Request lost.

RadioTuningMethod_t

enum RadioTuningMethod_t

Radio tuning methods.

Enumerator
RADIO_TUNE_FREQ_BW	Frequency and Bandwidth tuning.
RADIO_TUNE_FREQ	Frequency only tuning.
RADIO_TUNE_VOIP	VOIP tuning.
RADIO_TUNE_HQ	HaveQuick tuning.
RADIO_TUNE_SG	SINCGARS tuning.
RADIO_TUNE_HFECCM	HF ECCM tuning.
RADIO_TUNE_AMBSOUND	Ambient Sound tuning.

TestMode_t

enum TestMode_t

Test modes.

Enumerator
TEST_OFF	Normal operating mode.
TEST_WAVE	Play test tone through headset.
TEST_SIDETONE	Test headset sidetone.
TEST_LOOPBACK	Loopback received audio to target.
TEST_SEND_WAVE	Send tone (instead of mic audio) to target.
TEST_MIC	Play mic audio back for volume testing.