Health Checks

The SDK contains health checks that can be performed on various services. This page will cover all the different health checks that can performed via Consul with the appropriate structure content for each of them.

SDK Health Check

The Genvid Native SDK is registering a Time to Live Health Check with Consul, in the form of a JSON object. You can retrieve this object from the Health Service API and deserialize.

The following schema describe the JSON object.

Name	Type	Description	Validations
Config	object	Health Check Output configuration
Config.Encode	object	Health Configuration Encode
Config.Encode.Input	object	Health Configuration Encode Input
Config.Encode.Input.Height	number	Height of the video (must be an integer)
Config.Encode.Input.Quality	number	Quality percentage of the video
Config.Encode.Input.Silent	boolean	Enable/disable the audio being silent
Config.Encode.Input.StampScale	number	Scale used to stamp the frames
Config.Encode.Input.StampTimecode	boolean	Enable/disable to stamp the frames with a timecode
Config.Encode.Input.Width	number	Width of the video (must be an integer)
State	object	Health Check Output state
State.ComposeConnected	boolean	Compose connection status
State.NatsConnected	boolean	NATS connection status
State.NumStreams	number	Number of streams connected