Difference between revisions of "Libsdrsource"

From OpenDigitalRadio
Jump to navigationJump to search
(Created page with "=API Description= <code>SDRError LibSDRSource::Open(void)</code> {| class="wikitable" |- | '''Description''' | Opens the SDR device |- | '''Parameter''' | none |- | '''retur...")
 
(Add description)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 +
=Introduction=
 +
libsdrsource is a library that provides the same interface for different SDR devices. At the moment this library is in the concept phase.
 +
 
=API Description=
 
=API Description=
  
Line 64: Line 67:
 
|-
 
|-
 
| '''Parameter'''
 
| '''Parameter'''
| FrequencyKHz: Pointer to frequency in KHz
+
| ''FrequencyKHz'': Pointer to frequency in KHz
 
|-
 
|-
 
| '''return'''
 
| '''return'''
Line 78: Line 81:
 
|-
 
|-
 
| '''Parameter'''
 
| '''Parameter'''
| SampleBuffer: Sample buffer
+
| ''SampleBuffer'': Sample buffer
 
|-
 
|-
 
| '''return'''
 
| '''return'''
 
| SDR error enum object
 
| SDR error enum object
 
|}
 
|}

Latest revision as of 22:18, 10 February 2016

Introduction

libsdrsource is a library that provides the same interface for different SDR devices. At the moment this library is in the concept phase.

API Description

SDRError LibSDRSource::Open(void)
Description Opens the SDR device
Parameter none
return SDR error enum object


SDRError LibSDRSource::Close(void)
Description Closes the SDR device
Parameter none
return SDR error enum object


SDRError LibSDRSource::Reset(void)
Description Resets the SDR device
Parameter none
return SDR error enum object


SDRError LibSDRSource::SetFrequency(int32_t FrequencyKHz)
Description Sets the frequency in kHz
Parameter FrequencyKHz: Channel frequency in kHz
return SDR error enum object


SDRError LibSDRSource::GetFrequency(int32_t* FrequencyKHz)
Description Gets the current frequency
Parameter FrequencyKHz: Pointer to frequency in KHz
return SDR error enum object


SDRError LibSDRSource::GetSamples(CSDRSamples &SampleBuffer)
Description Gets the IQ samples. This method is blocking. It blocks until new data is available.
Parameter SampleBuffer: Sample buffer
return SDR error enum object