LogoLogo
ForumCodeDonate
  • Introduction
    • About
    • Release / Change Log
  • Installation
    • Requirements
    • Tuners
    • Linux
    • Virtualisation - Proxmox
    • Docker
    • NAS
    • Android
  • SETUP
    • Stages
    • Concepts
    • Muxes/Scan Files
      • Scan Files
      • Using w_scan Scan Files
  • CONFIGURATION
    • Concepts
    • Electronic Program Guide
    • Digital Video Recorder
    • Web User Interface Customisation
      • Theme
      • Date/Time Format
  • HTTPS access via Reverse Proxy
  • APPENDICES
    • FAQ
    • CLI Commands
    • Debugging
  • Development
    • Compiling
      • Compiling TVH with VAAPI Support
        • for Lubuntu 24.04
        • for Lubuntu 22.04
        • Level 2
    • HTSP
      • General
      • HTSMSG Binary Format
      • Communication
      • Client to Server (RPC) methods
      • Server to Client methods
      • Protocol Changes
      • HTTP Proxy Examples
    • JSON API
      • API Description
        • Common Parameters
        • Access
        • Bouquet
        • Caclient
        • Channel
        • Codec
        • Config
        • DVR
        • EPG
        • EPGgrab
        • ESfilter
        • idnode
        • Input
        • intlconv/charsets
        • Language
        • MPEGts
        • Profile
        • RatingLabel
        • Raw
        • Satip
        • Service
        • Status
        • Timeshift
        • Tvhlog
      • Examples
      • Other Functions
      • WebSocket
    • Object Class Relationships
    • Testing Tuners Using Files
    • Translations
    • Programmers Translation Workflow
    • XMLTV
      • Input
        • Recognised Tags/Attributes
        • Episode Numbering
      • Output
    • Object ID Representation
    • WebUI Help Content Workflow
    • Random Notes
  • Creating a Mux Dump
  • WIP
    • Release / Change Log Mockup
Powered by GitBook

© Tvheadend 2006-2024

On this page
  • status/connections
  • status/subscriptions
  • status/inputs
  • status/inputclrstats
  • connections/cancel

Was this helpful?

Export as PDF
  1. Development
  2. JSON API
  3. API Description

Status

Lists statistics of input sources and connections. ADMIN privilege is required for all these functions.

status/connections

Lists currently-connected client devices.

{
   "totalCount" : 1,
   "entries" : [
      {
         "id" : 1,
         "started" : 1508668447,
         "server_port" : 9982,
         "server" : "x.x.x.x",
         "type" : "HTSP",
         "peer" : "x.x.x.y",
         "user" : "xxxxxx",
         "peer_port" : 57496
      }
   ]
}

status/subscriptions

Lists currently-active subscriptions.

{
   "entries" : [
      {
         "errors" : 0,
         "title" : "epggrab",
         "in" : 85222,
         "total_in" : 25162474,
         "total_out" : 25162474,
         "id" : 75,
         "out" : 85222,
         "service" : "Silicon Labs Si2168 : DVB-T #0/Sandy/690MHz/Raw PID Subscription",
         "state" : "Running",
         "start" : 1508763840
      }
   ],
   "totalCount" : 1
}

status/inputs

Lists statistics of input devices.

For DVB-T and DVB-S tuners at least, the signal and SNR values are only non-zero while TVH is actively using the device. Some items may be missing if the device is idle.

{
   "entries" : [
      {
         "ec_block" : 0,
         "uuid" : "20f11bcaaf93afb5fc13cce31278494e",
         "signal_scale" : 2,
         "weight" : 100,
         "cc" : 1,
         "ber" : 0,
         "tc_block" : 0,
         "input" : "Montage Technology M88DS3103 #0 : DVB-S #0",
         "tc_bit" : 0,
         "unc" : 0,
         "te" : 0,
         "bps" : 2257504,
         "subs" : 1,
         "ec_bit" : 0,
         "pids" : [
            0,
            1,
            16,
            17,
            18,
            269,
            5700,
            5701,
            5703,
            5704
         ],
         "stream" : "10773H in DVB-S Network",
         "snr" : 14149,
         "signal" : -75649,
         "snr_scale" : 2
      }
   ],
   "totalCount" : 1
}

The meaning of the statistics is below. Not all input sources provide all of the values.

ber

Bit Error Rate

bps

Bandwidth (bits/second)

cc

Continuity Errors

ec_bit

Bit Error Count

ec_block

Block Error Count

pids

List of pids present in the stream

signal

Signal Strength (see below)

signal_scale

See below

snr

Signal/Noise Ratio (see below)

snr_scale

See below

stream

Stream (multiplex) name

subs

Subscribers

tc_bit

Total Bit Error Count

tc_block

Total Block Error Count

te

Transport Errors

unc

Uncorrected Blocks

weight

Weight

For signal_scale and snr_scale, a value of 1 indicates that the corresponding signal or SNR reading is relative; 65535 = 100%. A value of 2 indicates the reading is absolute; 1000 = 1dB. A value of 0 indicates that the reading is not available or not valid.

The "pids" data is only present in TVH versions 4.3.1420 and later.

status/inputclrstats

Resets the input counters to zero.

connections/cancel

Disconnects one or more clients.

PreviousServiceNextTimeshift

Last updated 1 year ago

Was this helpful?

uuid The uuid of the input device from . More than one uuid can be specified - syntax?

id ids of the connections, obtained from . If set to 'all' then all connections are cancelled (new in 4.3.1680).

status/inputs
status/connections