CitraClient.Schemas.IQUploadCreate (citra_client v0.3.0)

View Source

Request body for initiating an IQ upload.

Fields

  • :bandwidth_hz — number() (API key: bandwidthHz)
  • :capture_epoch_ns — integer() (API key: captureEpochNs)
  • :center_frequency_hz — number() (API key: centerFrequencyHz)
  • :duration_seconds — number() (API key: durationSeconds)
  • :file_size — integer() (API key: fileSize)
  • :filename — String.t()
  • :sample_rate_hz — number() (API key: sampleRateHz)

Summary

Types

t()

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.

Types

t()

@type t() :: %CitraClient.Schemas.IQUploadCreate{
  bandwidth_hz: number() | nil,
  capture_epoch_ns: integer() | nil,
  center_frequency_hz: number() | nil,
  duration_seconds: number() | nil,
  file_size: integer() | nil,
  filename: String.t() | nil,
  sample_rate_hz: number() | nil
}

Functions

from_api(data)

Build this struct from a decoded JSON map received from the API. Unknown fields are ignored.

to_api(struct)

Convert this struct into a map with the API's camelCase keys, ready to be JSON-encoded. Fields whose value is nil are omitted.