sdrangel/sdrbase/resources/webapi/doc/swagger/include/UDPSink.yaml

95 lines
2.3 KiB
YAML

UDPSinkSettings:
description: UDPSink
properties:
outputSampleRate:
type: number
format: float
sampleFormat:
type: integer
inputFrequencyOffset:
type: integer
format: int64
rfBandwidth:
type: number
format: float
fmDeviation:
type: integer
channelMute:
description: channel mute (1 if muted else 0)
type: integer
gain:
type: number
format: float
squelchDB:
description: power dB
type: integer
squelchGate:
description: 100ths seconds
type: integer
squelchEnabled:
description: squelch enable (1 if enabled else 0)
type: integer
agc:
description: AGC enable (1 if enabled else 0)
type: integer
audioActive:
description: Audio return enable (1 if enabled else 0)
type: integer
audioStereo:
description: Audio return stereo (1 if stereo else 0)
type: integer
volume:
type: integer
udpAddress:
description: destination UDP address (remote)
type: string
udpPort:
description: destination UDP port (remote)
type: integer
format: uint16
audioPort:
description: audio return UDP port (local)
type: integer
format: uint16
rgbColor:
type: integer
title:
type: string
streamIndex:
description: MIMO channel. Not relevant when connected to SI (single Rx).
type: integer
useReverseAPI:
description: Synchronize with reverse API (1 for yes, 0 for no)
type: integer
reverseAPIAddress:
type: string
reverseAPIPort:
type: integer
reverseAPIDeviceIndex:
type: integer
reverseAPIChannelIndex:
type: integer
spectrumConfig:
$ref: "/doc/swagger/include/GLSpectrum.yaml#/GLSpectrum"
channelMarker:
$ref: "/doc/swagger/include/ChannelMarker.yaml#/ChannelMarker"
rollupState:
$ref: "/doc/swagger/include/RollupState.yaml#/RollupState"
UDPSinkReport:
description: UDPSink
properties:
outputPowerDB:
description: power transmitted in channel (dB)
type: number
format: float
channelPowerDB:
description: power received in channel (dB)
type: number
format: float
squelch:
description: squelch status (1 if open else 0)
type: integer
inputSampleRate:
type: integer