SoapySDR: Constants.h File Reference

| SoapySDR 0.8.1-ARCH Vendor and platform neutral SDR interface library

Loading...
Searching...
No Matches
Macros
Constants.h File Reference
`#include <SoapySDR/Config.h>`

Go to the source code of this file.

## Macros
#define | SOAPY_SDR_TX 0
#define | SOAPY_SDR_RX 1
#define | SOAPY_SDR_END_BURST (1 << 1)
#define | SOAPY_SDR_HAS_TIME (1 << 2)
#define | SOAPY_SDR_END_ABRUPT (1 << 3)
#define | SOAPY_SDR_ONE_PACKET (1 << 4)
#define | SOAPY_SDR_MORE_FRAGMENTS (1 << 5)
#define | SOAPY_SDR_WAIT_TRIGGER (1 << 6)
#define | SOAPY_SDR_USER_FLAG0 (1 << 16)
#define | SOAPY_SDR_USER_FLAG1 (1 << 17)
#define | SOAPY_SDR_USER_FLAG2 (1 << 18)
#define | SOAPY_SDR_USER_FLAG3 (1 << 19)
#define | SOAPY_SDR_USER_FLAG4 (1 << 20)

## Detailed Description

Constants used in the device API.

Copyright
  Copyright (c) 2014-2016 Josh Blum SPDX-License-Identifier: BSL-1.0

## Macro Definition Documentation

## ◆ SOAPY_SDR_END_ABRUPT

#define SOAPY_SDR_END_ABRUPT (1 << 3)

Indicates that stream terminated prematurely. This is the flag version of an overflow error that indicates an overflow with the end samples.

## ◆ SOAPY_SDR_END_BURST

#define SOAPY_SDR_END_BURST (1 << 1)

Indicate end of burst for transmit or receive. For write, end of burst if set by the caller. For read, end of burst is set by the driver.

## ◆ SOAPY_SDR_HAS_TIME

#define SOAPY_SDR_HAS_TIME (1 << 2)

Indicates that the time stamp is valid. For write, the caller must set has time when timeNs is provided. For read, the driver sets has time when timeNs is provided.

## ◆ SOAPY_SDR_MORE_FRAGMENTS

#define SOAPY_SDR_MORE_FRAGMENTS (1 << 5)

Indicate that this read call and the next results in a fragment. Used when the implementation has an underlying packet interface. The caller can use this indicator and the SOAPY_SDR_ONE_PACKET flag on subsequent read stream calls to re-align with packet boundaries.

## ◆ SOAPY_SDR_ONE_PACKET

#define SOAPY_SDR_ONE_PACKET (1 << 4)

Indicates transmit or receive only a single packet. Applicable when the driver fragments samples into packets. For write, the user sets this flag to only send a single packet. For read, the user sets this flag to only receive a single packet.

## ◆ SOAPY_SDR_RX

#define SOAPY_SDR_RX 1

Constant to represent the receive direction

## ◆ SOAPY_SDR_TX

#define SOAPY_SDR_TX 0

Constant to represent the transmit direction

## ◆ SOAPY_SDR_USER_FLAG0

#define SOAPY_SDR_USER_FLAG0 (1 << 16)

A flag that can be used for SDR specific data.

## ◆ SOAPY_SDR_USER_FLAG1

#define SOAPY_SDR_USER_FLAG1 (1 << 17)

A flag that can be used for SDR specific data.

## ◆ SOAPY_SDR_USER_FLAG2

#define SOAPY_SDR_USER_FLAG2 (1 << 18)

A flag that can be used for SDR specific data.

## ◆ SOAPY_SDR_USER_FLAG3

#define SOAPY_SDR_USER_FLAG3 (1 << 19)

A flag that can be used for SDR specific data.

## ◆ SOAPY_SDR_USER_FLAG4

#define SOAPY_SDR_USER_FLAG4 (1 << 20)

A flag that can be used for SDR specific data.

## ◆ SOAPY_SDR_WAIT_TRIGGER

#define SOAPY_SDR_WAIT_TRIGGER (1 << 6)

Indicate that the stream should wait for an external trigger event. This flag might be used with the flags argument in any of the stream API calls. The trigger implementation is hardware-specific.