1 of 1

SRT

The datarhei Core includes a simple SRT server for publishing and playing streams. Check out the SRT configuration and the SRT guide. This API endpoint will list the details of all currently publishing and playing streams.

This endpoint is still experimental and may change in a later minor version increase.

curl http://127.0.0.1:8080/api/v3/srt \
   -H 'accept: application/json' \
   -X GET

from core_client import Client

client = Client(
    base_url="http://127.0.0.1:8080"
)
client.login()

core_srt = client.v3_srt_get()
print(core_srt)

import (
    "fmt"
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

channels, err := client.SRTChannels()
fmt.Printf("%+v\n", channels)

SRT

This endpoint is still experimental and may change in a later minor version increase.

curl http://127.0.0.1:8080/api/v3/srt \
   -H 'accept: application/json' \
   -X GET

from core_client import Client

client = Client(
    base_url="http://127.0.0.1:8080"
)
client.login()

core_srt = client.v3_srt_get()
print(core_srt)

import (
    "fmt"
    "github.com/datarhei/core-client-go/v16"
)

client, _ := coreclient.New(coreclient.Config{
    Address: "https://127.0.0.1:8080",
})

channels, err := client.SRTChannels()
fmt.Printf("%+v\n", channels)

List all publishing SRT treams

List all currently publishing SRT streams. This endpoint is EXPERIMENTAL and may change in future.

GET//api/v3/srt

Authorization

Response

Body

connectionsobject

Other propertiesapi.SRTConnection (object)

logobject

Other propertiesarray of api.SRTLog (object)

msgarray of string

itemsstring

tsinteger

statsapi.SRTStatistics (object)

avail_recv_buf_bytesinteger

The available space in the receiver's buffer, in bytes

avail_send_buf_bytesinteger

The available space in the sender's buffer, in bytes

bandwidth_mbitnumber

Estimated bandwidth of the network link, in Mbps

flight_size_pktinteger

The number of packets in flight

flow_window_pktinteger

The maximum number of packets that can be "in flight"

max_bandwidth_mbitnumber

Transmission bandwidth limit, in Mbps

mss_bytesinteger

Maximum Segment Size (MSS), in bytes

pkt_recv_avg_belated_time_msinteger

Accumulated difference between the current time and the time-to-play of a packet that is received late

pkt_send_period_usnumber

Current minimum time interval between which consecutive packets are sent, in microseconds

recv_ack_pktinteger

The total number of received ACK (Acknowledgement) control packets

recv_buf_bytesinteger

Instantaneous (current) value of pktRcvBuf, expressed in bytes, including payload and all headers (IP, TCP, SRT)

recv_buf_msinteger

The timespan (msec) of acknowledged packets in the receiver's buffer

recv_buf_pktinteger

The number of acknowledged packets in receiver's buffer

recv_bytesinteger

Same as pktRecv, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_drop_bytesinteger

Same as pktRcvDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_drop_pktinteger

The total number of dropped by the SRT receiver and, as a result, not delivered to the upstream application DATA packets

recv_km_pktinteger

The total number of received KM (Key Material) control packets

recv_loss_bytesinteger

Same as pktRcvLoss, but expressed in bytes, including payload and all the headers (IP, TCP, SRT), bytes for the presently missing (either reordered or lost) packets' payloads are estimated based on the average packet size

recv_loss_pktinteger

The total number of SRT DATA packets detected as presently missing (either reordered or lost) at the receiver side

recv_nak_pktinteger

The total number of received NAK (Negative Acknowledgement) control packets

recv_pktinteger

The total number of received DATA packets, including retransmitted packets

recv_retran_pktsinteger

The total number of retransmitted packets registered at the receiver side

recv_tsbpd_delay_msinteger

Timestamp-based Packet Delivery Delay value set on the socket via SRTO_RCVLATENCY or SRTO_LATENCY

recv_undecrypt_bytesinteger

Same as pktRcvUndecrypt, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_undecrypt_pktinteger

The total number of packets that failed to be decrypted at the receiver side

recv_unique_bytesinteger

Same as pktRecvUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_unique_pktinteger

The total number of unique original, retransmitted or recovered by the packet filter DATA packets received in time, decrypted without errors and, as a result, scheduled for delivery to the upstream application by the SRT receiver.

reorder_tolerance_pktinteger

Instant value of the packet reorder tolerance

rtt_msnumber

Smoothed round-trip time (SRTT), an exponentially-weighted moving average (EWMA) of an endpoint's RTT samples, in milliseconds

send_buf_bytesinteger

Instantaneous (current) value of pktSndBuf, but expressed in bytes, including payload and all headers (IP, TCP, SRT)

send_buf_msinteger

The timespan (msec) of packets in the sender's buffer (unacknowledged packets)

send_buf_pktinteger

The number of packets in the sender's buffer that are already scheduled for sending or even possibly sent, but not yet acknowledged

send_drop_bytesinteger

Same as pktSndDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

send_drop_pktinteger

The total number of dropped by the SRT sender DATA packets that have no chance to be delivered in time

send_duration_usinteger

The total accumulated time in microseconds, during which the SRT sender has some data to transmit, including packets that have been sent, but not yet acknowledged

send_km_pktinteger

The total number of sent KM (Key Material) control packets

send_loss_pktinteger

The total number of data packets considered or reported as lost at the sender side. Does not correspond to the packets detected as lost at the receiver side.

send_tsbpd_delay_msinteger

Timestamp-based Packet Delivery Delay value of the peer

sent_ack_pktinteger

The total number of sent ACK (Acknowledgement) control packets

sent_bytesinteger

Same as pktSent, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

sent_nak_pktinteger

The total number of sent NAK (Negative Acknowledgement) control packets

sent_pktinteger

The total number of sent DATA packets, including retransmitted packets

sent_retrans_bytesinteger

Same as pktRetrans, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

sent_retrans_pktinteger

The total number of retransmitted packets sent by the SRT sender

sent_unique_bytesinteger

Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

sent_unique_pktinteger

The total number of unique DATA packets sent by the SRT sender

timestamp_msinteger

The time elapsed, in milliseconds, since the SRT socket has been created

logobject

Other propertiesarray of api.SRTLog (object)

msgarray of string

itemsstring

tsinteger

publisherobject

Other propertiesinteger

subscriberobject

Other propertiesarray of integer

itemsinteger

Request

Response

List all publishing SRT treams

List all currently publishing SRT streams. This endpoint is EXPERIMENTAL and may change in future.

GET//api/v3/srt

Authorization

Response

Body

connectionsobject

Other propertiesapi.SRTConnection (object)

logobject

Other propertiesarray of api.SRTLog (object)

msgarray of string

itemsstring

tsinteger

statsapi.SRTStatistics (object)

avail_recv_buf_bytesinteger

The available space in the receiver's buffer, in bytes

avail_send_buf_bytesinteger

The available space in the sender's buffer, in bytes

bandwidth_mbitnumber

Estimated bandwidth of the network link, in Mbps

flight_size_pktinteger

The number of packets in flight

flow_window_pktinteger

The maximum number of packets that can be "in flight"

max_bandwidth_mbitnumber

Transmission bandwidth limit, in Mbps

mss_bytesinteger

Maximum Segment Size (MSS), in bytes

pkt_recv_avg_belated_time_msinteger

Accumulated difference between the current time and the time-to-play of a packet that is received late

pkt_send_period_usnumber

Current minimum time interval between which consecutive packets are sent, in microseconds

recv_ack_pktinteger

The total number of received ACK (Acknowledgement) control packets

recv_buf_bytesinteger

Instantaneous (current) value of pktRcvBuf, expressed in bytes, including payload and all headers (IP, TCP, SRT)

recv_buf_msinteger

The timespan (msec) of acknowledged packets in the receiver's buffer

recv_buf_pktinteger

The number of acknowledged packets in receiver's buffer

recv_bytesinteger

Same as pktRecv, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_drop_bytesinteger

Same as pktRcvDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_drop_pktinteger

The total number of dropped by the SRT receiver and, as a result, not delivered to the upstream application DATA packets

recv_km_pktinteger

The total number of received KM (Key Material) control packets

recv_loss_bytesinteger

recv_loss_pktinteger

The total number of SRT DATA packets detected as presently missing (either reordered or lost) at the receiver side

recv_nak_pktinteger

The total number of received NAK (Negative Acknowledgement) control packets

recv_pktinteger

The total number of received DATA packets, including retransmitted packets

recv_retran_pktsinteger

The total number of retransmitted packets registered at the receiver side

recv_tsbpd_delay_msinteger

Timestamp-based Packet Delivery Delay value set on the socket via SRTO_RCVLATENCY or SRTO_LATENCY

recv_undecrypt_bytesinteger

Same as pktRcvUndecrypt, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_undecrypt_pktinteger

The total number of packets that failed to be decrypted at the receiver side

recv_unique_bytesinteger

Same as pktRecvUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

recv_unique_pktinteger

reorder_tolerance_pktinteger

Instant value of the packet reorder tolerance

rtt_msnumber

Smoothed round-trip time (SRTT), an exponentially-weighted moving average (EWMA) of an endpoint's RTT samples, in milliseconds

send_buf_bytesinteger

Instantaneous (current) value of pktSndBuf, but expressed in bytes, including payload and all headers (IP, TCP, SRT)

send_buf_msinteger

The timespan (msec) of packets in the sender's buffer (unacknowledged packets)

send_buf_pktinteger

The number of packets in the sender's buffer that are already scheduled for sending or even possibly sent, but not yet acknowledged

send_drop_bytesinteger

Same as pktSndDrop, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

send_drop_pktinteger

The total number of dropped by the SRT sender DATA packets that have no chance to be delivered in time

send_duration_usinteger

The total accumulated time in microseconds, during which the SRT sender has some data to transmit, including packets that have been sent, but not yet acknowledged

send_km_pktinteger

The total number of sent KM (Key Material) control packets

send_loss_pktinteger

The total number of data packets considered or reported as lost at the sender side. Does not correspond to the packets detected as lost at the receiver side.

send_tsbpd_delay_msinteger

Timestamp-based Packet Delivery Delay value of the peer

sent_ack_pktinteger

The total number of sent ACK (Acknowledgement) control packets

sent_bytesinteger

Same as pktSent, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

sent_nak_pktinteger

The total number of sent NAK (Negative Acknowledgement) control packets

sent_pktinteger

The total number of sent DATA packets, including retransmitted packets

sent_retrans_bytesinteger

Same as pktRetrans, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

sent_retrans_pktinteger

The total number of retransmitted packets sent by the SRT sender

sent_unique_bytesinteger

Same as pktSentUnique, but expressed in bytes, including payload and all the headers (IP, TCP, SRT)

sent_unique_pktinteger

The total number of unique DATA packets sent by the SRT sender

timestamp_msinteger

The time elapsed, in milliseconds, since the SRT socket has been created

logobject

Other propertiesarray of api.SRTLog (object)

msgarray of string

itemsstring

tsinteger

publisherobject

Other propertiesinteger

subscriberobject

Other propertiesarray of integer

itemsinteger

Request

Response

const response = await fetch('//api/v3/srt', {
    method: 'GET',
    headers: {},
});
const data = await response.json();