libbladeRF 2.5.0
Nuand bladeRF library
Loading...
Searching...
No Matches
Sample rate

Description

This section presents functionality pertaining to configuring the sample rate and mode of the device's RX and TX channels.

These functions are thread-safe.

Data Structures

struct  bladerf_rational_rate

Typedefs

typedef unsigned int bladerf_sample_rate

Functions

API_EXPORT int CALL_CONV bladerf_set_sample_rate (struct bladerf *dev, bladerf_channel ch, bladerf_sample_rate rate, bladerf_sample_rate *actual)
API_EXPORT int CALL_CONV bladerf_set_rational_sample_rate (struct bladerf *dev, bladerf_channel ch, struct bladerf_rational_rate *rate, struct bladerf_rational_rate *actual)
API_EXPORT int CALL_CONV bladerf_get_sample_rate (struct bladerf *dev, bladerf_channel ch, bladerf_sample_rate *rate)
API_EXPORT int CALL_CONV bladerf_get_sample_rate_range (struct bladerf *dev, bladerf_channel ch, const struct bladerf_range **range)
API_EXPORT int CALL_CONV bladerf_get_rational_sample_rate (struct bladerf *dev, bladerf_channel ch, struct bladerf_rational_rate *rate)

Typedef Documentation

◆ bladerf_sample_rate

typedef unsigned int bladerf_sample_rate

Sample rate, in samples per second (sps)

Definition at line 1031 of file libbladeRF.h.

Function Documentation

◆ bladerf_get_rational_sample_rate()

API_EXPORT int CALL_CONV bladerf_get_rational_sample_rate ( struct bladerf * dev,
bladerf_channel ch,
struct bladerf_rational_rate * rate )

Get the channel's sample rate in rational Hz

Parameters
devDevice handle
[in]chChannel
[out]rateCurrent rational sample rate
Returns
0 on success, value from Error codes list upon failure

◆ bladerf_get_sample_rate()

API_EXPORT int CALL_CONV bladerf_get_sample_rate ( struct bladerf * dev,
bladerf_channel ch,
bladerf_sample_rate * rate )

Get the channel's current sample rate in Hz

Parameters
devDevice handle
[in]chChannel
[out]rateCurrent sample rate
Returns
0 on success, value from Error codes list upon failure

◆ bladerf_get_sample_rate_range()

API_EXPORT int CALL_CONV bladerf_get_sample_rate_range ( struct bladerf * dev,
bladerf_channel ch,
const struct bladerf_range ** range )

Get the channel's supported range of sample rates

Parameters
devDevice handle
[in]chChannel
[out]rangeSample rate range
Returns
0 on success, value from Error codes list upon failure

◆ bladerf_set_rational_sample_rate()

API_EXPORT int CALL_CONV bladerf_set_rational_sample_rate ( struct bladerf * dev,
bladerf_channel ch,
struct bladerf_rational_rate * rate,
struct bladerf_rational_rate * actual )

Configure the channel's sample rate as a rational fraction of Hz.

See also
Use bladerf_get_sample_rate_range() to determine the range of supported sample rates.
Parameters
devDevice handle
[in]chChannel to change
[in]rateRational sample rate
[out]actualIf non-NULL, this is written with the actual rational sample rate achieved.
Returns
0 on success, value from Error codes list upon failure

◆ bladerf_set_sample_rate()

API_EXPORT int CALL_CONV bladerf_set_sample_rate ( struct bladerf * dev,
bladerf_channel ch,
bladerf_sample_rate rate,
bladerf_sample_rate * actual )

Configure the channel's sample rate to the specified rate in Hz.

Note
This requires the sample rate is an integer value of Hz. Use bladerf_set_rational_sample_rate() for more arbitrary values.
See also
Use bladerf_get_sample_rate_range() to determine the range of supported sample rates.
Parameters
devDevice handle
[in]chChannel
[in]rateSample rate
[out]actualIf non-NULL, this is written with the actual sample rate achieved.
Returns
0 on success, value from Error codes list upon failure