The Service Analytics Parameters description (1.0.0)

Download OpenAPI specification:

Configuration schema for the service analytics processing (analytics name is fs3). Applicable to use as analytics.parameters.parameters of create stream request in Luna-Video-Manager

service

The service analytic parameters

Analytic parameters schema and example. Applicable to use as analytics.parameters.parameters of create stream

Request Body schema: application/json
mode
integer
Default: 3
Enum: 1 2 3

Analytics mode:

  • 1 - faces
  • 2 - bodies
  • 3 - humans (default)
enabled
boolean
Default: true

Enables or disables analytics processing.

frame_processing_mode
string
Default: "auto"
Enum: "auto" "full" "scale"

Whether full or scaled frame will be processed. "auto" depends on convert_full_frame parameter from fs3Config.conf settings.

real_time_mode_fps
integer >= 0
Default: 0

Number of FPS with which the video file will be processed. Intended for use with "videofile" stream type.

ffmpeg_threads_number
integer >= 0
Default: 0

Number of threads for video decoding. 0 means value is chosen automatically by decoder library.

preferred_program_stream_frame_width
integer >= 0
Default: 800

Frame width of the preferred program stream.

Intended for protocols with multiple channels (e.g., HLS). Selects the channel whose frame width is closest to this value.

Used with "stream" stream types.

RoiAbs (object) or RoiPercent (object) (RoiLike)

ROI-like object supporting absolute or percent-based coordinates.

RoiAbs (object) or RoiPercent (object) (RoiLike)

ROI-like object supporting absolute or percent-based coordinates.

object (Sending)

Stream sending parameters.

object (Filtering)
object (Liveness)
object (Healthcheck)

Stream health check parameters.

object (PrimaryTrackPolicy)

Access control related tracking policy.

object (EventHandler)

Responses

Request samples

Content type
application/json
{
  • "mode": 1,
  • "enabled": true,
  • "frame_processing_mode": "auto",
  • "real_time_mode_fps": 0,
  • "ffmpeg_threads_number": 0,
  • "preferred_program_stream_frame_width": 800,
  • "roi": {
    },
  • "droi": {
    },
  • "sending": {
    },
  • "filtering": {
    },
  • "liveness": {
    },
  • "healthcheck": {
    },
  • "primary_track_policy": {
    },
  • "event_handler": {
    }
}