Graph API Version

Live Encoder Telemetry

Reading

You can't perform this operation on this endpoint.

Creating

You can make a POST request to telemetry edge from the following paths:
When posting to this edge, a LiveEncoder will be created.

Parameters

ParameterDescription
bitrate
int64

Stream bitrate in kbps

broadcast_id
numeric string or integer

The live video id.

cpu_load_15m
float

CPU load over 15m

cpu_load_1m
float

CPU load over 1m

cpu_load_5m
float

CPU load over 5m

cpu_temperature
int64

the CPU temperature in degree Celcius

cpu_usage
float

The percentage of CPU usage

framerate
float

Frames per second

frames_dropped
float

The number of dropped frame per second

gpu_temperature
int64

the GPU temperature in degree Celcius

gpu_usage
float

the percentage of GPU usage

last_audio_timecode
int64

timestamp of the last audio frame received

last_video_keyframe_timecode
int64

last video keyframe timecode

last_video_timecode
int64

timestamp of the last video frame received

memory_usage
float

The percentage of encoder memory usage

network_latency
float

milliseconds between encoder and facebook ingestion server

network_rx_bandwidth
int64

The rx bandwidth in kilobits per seconds

network_rx_packets_dropped
float

The number of packets dropped per second

network_rx_packets_errors
float

The number of errors per second

network_tx_bandwidth
int64

The tx bandwidth in kilobits per seconds

network_tx_packets_dropped
float

The number of packets dropped per second

network_tx_packets_errors
float

The number of errors per second

process_uptime
int64

uptime of the main process

status
enum {NONE, READY, REGISTER, CAPTURE, PREVIEW, LIVE}

The status of live encoder

Required
timestamp
int64

The timestamp of this measure

total_audio_frames_sent
int64

total number of audio frames sent

total_video_frames_sent
int64

total number of video frames sent

total_video_keyframes_sent
int64

total number of video keyframes sent

uptime
int64

The uptime of the live encoder

Return Type

Struct {
success: bool,
}

Validation Rules

ErrorDescription
100Invalid parameter

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.