File Stream Commands

File and Stream Commands

Generated from FlexLib v4.2.18

File operations and audio/data streams

---

Wire Protocol

Commands follow the FlexRadio TCP wire protocol:

C[D]<seq_number>|<command> [sub-command] [parameters]

Where:

• C = Command prefix
• D = Optional debug flag
• <seq_number> = Sequence number for command tracking
• <command> = Primary command word
• [sub-command] = Optional sub-command
• [parameters] = Command-specific parameters

Responses follow the format:

R<seq_number>|<result_code>|<data>|[debug_info]

Where:

• R = Response prefix
• <seq_number> = Matching sequence number from command
• <result_code> = Result code (0 = success, non-zero = error)
• <data> = Command-specific response data
• [debug_info] = Optional debug information

Common Response Codes

Code	Meaning
0	Success
50000001	Unable to get foundation receiver assignment
50000003	License check failed
50000004	Parameter error
50000005	Incorrect number or type of parameters
50000016	Malformed command
5000002C	Incorrect number of parameters
50000032	Bad mode

---

Commands

stream set 0x... daxiq_rate=...

Syntax:

C<seq>|stream set 0x<streamid> daxiq_rate=<samplerate>

Parameters:

Parameter	Description
<streamid>
<samplerate>

Response Example:

R<seq>|0||

stream remove 0x...

Indicates that data is expected to stream for this IQ Client. This may not be the case when there is another DAX client connected to the same radio and bound to the same GUI Client with this channel enabled.

Syntax:

C<seq>|stream remove 0x<streamid>

Parameters:

Parameter	Description
<streamid>

Response Example:

R<seq>|0||

audio stream 0x... slice ... gain ...

Syntax:

C<seq>|audio stream 0x<streamid> slice <slice> gain <new_gain>

Parameters:

Parameter	Description
<streamid>
<slice>
<new_gain>

Response Example:

R<seq>|0||

stream set 0x... tx=...

Request or yield DAX TX ownership from the radio. Used in multiFLEX when another client currently has TX and this client wants to take it back, or when this client wants to yield TX to another client.

Syntax:

C<seq>|stream set 0x<txstreamid> tx=<tx>

Parameters:

Parameter	Description
<txstreamid>
<tx>

Response Example:

R<seq>|0||

stream remove 0x...

Close

Syntax:

C<seq>|stream remove 0x<txstreamid>

Parameters:

Parameter	Description
<txstreamid>

Response Example:

R<seq>|0||

stream create netcw

Request Net C W Stream From Radio

Syntax:

C<seq>|stream create netcw

Response Example:

R<seq>|0||

stream create type=dax_rx dax_channel=...

Request D A X R X Audio Stream

Syntax:

C<seq>|stream create type=dax_rx dax_channel=<channel>

Parameters:

Parameter	Description
<channel>

Response Example:

R<seq>|0||

stream create

Syntax:

C<seq>|stream create <parameter>=<value>

Parameter	Description
type	Request D A X M I C Audio Stream
type	Request D A X T X Audio Stream
type	Request R X Remote Audio Stream
type	Request Remote Audio T X Stream

Response Example:

R<seq>|0||

stream create type=dax_iq daxiq_channel=...

Request D A X I Q Stream

Syntax:

C<seq>|stream create type=dax_iq daxiq_channel=<channel>

Parameters:

Parameter	Description
<channel>

Response Example:

R<seq>|0||

stream create type=remote_audio_rx

Syntax:

C<seq>|stream create type=remote_audio_rx <parameter>=<value>

Parameter	Description
compression	Request R X Remote Audio Stream
compression	Request R X Remote Audio Stream

Response Example:

R<seq>|0||

file download db_package

Syntax:

C<seq>|file download db_package

Response Example:

R<seq>|0||

file download unity_test

Receive Testing Results File

Syntax:

C<seq>|file download unity_test

Response Example:

R<seq>|0||

file download db_meta_data

Syntax:

C<seq>|file download db_meta_data

Response Example:

R<seq>|0||

file upload ... db_meta_subset

Syntax:

C<seq>|file upload <file_buffer> db_meta_subset

Parameters:

Parameter	Description
<file_buffer>

Response Example:

R<seq>|0||

file upload ... db_import

Syntax:

C<seq>|file upload <update_file_buffer> db_import

Parameters:

Parameter	Description
<update_file_buffer>

Response Example:

R<seq>|0||

file upload ... memories_csv_file

Syntax:

C<seq>|file upload <update_file_buffer> memories_csv_file

Parameters:

Parameter	Description
<update_file_buffer>

Response Example:

R<seq>|0||

file filename ...

Syntax:

C<seq>|file filename <filename>

Parameters:

Parameter	Description
<filename>

Response Example:

R<seq>|0||

file upload ... new_waveform

Syntax:

C<seq>|file upload <update_file_buffer> new_waveform

Parameters:

Parameter	Description
<update_file_buffer>

Response Example:

R<seq>|0||

file filename ...

Send Update File

Syntax:

C<seq>|file filename <path>

Parameters:

Parameter	Description
<path>

Response Example:

R<seq>|0||

file upload ... update

Send Update File

Syntax:

C<seq>|file upload <filelength> update

Parameters:

Parameter	Description
<filelength>

Response Example:

R<seq>|0||

file upload ... turf

Syntax:

C<seq>|file upload <turf_file_buffer> turf

Parameters:

Parameter	Description
<turf_file_buffer>

Response Example:

R<seq>|0||

stream create opus

Request T X Remote Audio Stream From Radio

Syntax:

C<seq>|stream create opus

Response Example:

R<seq>|0||