FaceStream version 5.1.23

HTTP status code 200

Ok.

Body

Media type: application/json

Type: object

• account_id: required(string)

  new stream account ID for authentication in Luna Platform

• stream_id: required(string)

  stream UUID

• name: required(string)

  display name

• description: (string)

  new stream description

• preview_url: required(string)

  stream preview URL

• status: required(string)

  stream status

• version: required(integer)

  stream version

• error: required(string)

  stream error

• data: required(object)

  stream input parameters

  • reference: required(string)

    camera address, e.g.

  • type: required(one of tcp, udp, videofile, images)

    transport protocol for rtsp camera, by default "tcp"

  • roi: (array of integer)

    region of interest of camera frame (left, top, width, height), by default [0 0 0 0] - full frame

  • droi: (array of integer)

    region of interest of camera frame (left, top, width, height), by default [0 0 0 0] - full frame

  • rotation: (integer)

    angle of camera frame rotation, possible values are 0, 90, 180, 270, by default 0

  • preferred_program_stream_frame_width: (integer)

    frame width of the preferred program stream, by default 800

• event_handler: required(object)

  stream event handler data

  • origin: required(string)

    event handler service origin

  • api_version: required(integer)

    event handler service api version

  • bestshot_handler: required(object)

    event bestshot handler

    • handler_id: required(string)

      handler id in Luna Platform

  • detection_handler: (object)

    event detection handler

    • handler_id: required(string)

      handler id in Luna Platform

  • frame_store: (string)

    frame store URL

• policies: required(object)

  stream processing policies

  • ffmpeg_threads_number: required(integer)

    number of threads for video decoding, by default 0 - chosen by decoder library

  • frame_processing_mode: required(one of auto, full, scale)

    Determines whether full or scaled frame will be processed, by default "auto" - depends on fs3Config param 'convertFullFrame'

  • real_time_mode_fps: required(integer)
  • health_check: required(object)

    stream health check parameters

    • max_error_count: required(integer)

      error count limit in period to consider stream to be alive, by default 10

    • period: required(integer)

      see description of max_error_count, measured in seconds, by default 3600

    • retry_delay: required(integer)

      time gap (in seconds) between attempts to reopen not alive stream, by default 5

  • filtering: required(object)

    stream filtering parameters

    • min_score: required(number)

      score that defines detection quality, threshold for filtering detections sent to the server, by default 0.5187.

    • detection_yaw_threshold: required(integer)

      sets the maximum value of head yaw angle in relation to camera, by default 40.

    • detection_pitch_threshold: required(integer)

      sets the maximum value of head pitch angle in relation to camera, by default 40.

    • detection_roll_threshold: required(integer)

      sets the maximum value of head roll angle in relation to camera, by default 30.

    • yaw_number: required(integer)

      defines the number of frames for image filtration based on head tilt angle, by default 1.

    • yaw_collection_mode: required(boolean)

      sets the number of frames the system must collect to analyze head yaw angle, by default false.

    • mouth_occlusion_threshold: required(number)

      determines how much the mouth can be obscured in the frame, by default 0.0.

  • sending: required(object)

    stream sending parameters

    • time_period_of_searching: required(integer)

      interval in track after the end of which a best shot is sent to the server, by default -1.

    • silent_period: required(integer)

      interval between period. Once the analysis period is over, the system holds this silent_period before starting next period of frame analysis, by default -1.

    • type: required(string)

      sets the measurement metric for analysis periods and intervals between those (per frames or per seconds), by default "sec".

    • number_of_bestshots_to_send: required(integer)

      number of frames that the user sets to receive from the track or certain periods of this track, by default 1.

    • send_only_full_set: required(boolean)

      This parameter enables to send data only if the required amount of data is available.

    • delete_track_after_sending: required(boolean)

      This parameter enables to delete track after sending.

  • primary_track_policy: required(object)

    stream primary track policy parameters

    • use_primary_track_policy: required(boolean)

      is used in cases of Access Control Systems (turnstiles/gates at the office/bank entrances) for easier control and face recognition implementation in a secured area, by default false.

    • best_shot_min_size: required(integer)

      sets a minimal size for detections within Primary Track policy, by default 70.

    • best_shot_proper_size: required(integer)

      sets the size of detection for Primary Track policy. When a detection reaches the defined value, track immediately sends all its best shots to the server, by default 140.

  • liveness: required(object)

    stream liveness parameters

    • use_shoulders_liveness_filtration: required(boolean)

      enables checking the presence of a real person in the frame based on the head and shoulder areas, by default false.

    • use_mask_liveness_filtration: required(boolean)

      enables checking the presence of a real person in the frame based on backgrounds, by default false.

    • use_flying_faces_liveness_filtration: required(boolean)

      enables checking the presence of a real person in the frame based on the facial surrounding, by default false.

    • liveness_mode: required(integer)

      enables to specify which frames from a track will undergo Liveness check. There are three options for selecting a frame

    • number_of_liveness_checks: required(integer)

      enables to specify the number of frames to check for Liveness. The specified value is used in the liveness-mode parameter. By default 10.

    • liveness_threshold: required(number)

      is used to define the presence of a real person in a frame. The system confirms that it is a real person in the frame, and not a photo, only if Liveness returned a value higher than the one specified in the parameter. By default 0.8.

    • livenesses_weights: required(array of any)

      determines the involvement of each liveness check type (shoulders, mask, and flying_faces) in the resulting estimation of the presence of a human face in the frame. By default [0.0, 0.25, 0.75].

    • mask_backgrounds_count: required(integer)

      the number of background frames that are used for the corresponding checks, by default 300.

• location: (object)

  stream source location parameters

  • city: (string - maxLength: 36)

    city where event is incidented

  • area: (string - maxLength: 36)

    area where event is incidented

  • district: (string - maxLength: 36)

    district where event is incidented

  • street: (string - maxLength: 36)

    street where event is incidented

  • house_number: (string - maxLength: 36)

    house number where event is incidented

  • geo_position: (object)

    geo position specified by geographic coordinates - longitude and latitude

    • longitude: required(number - minimum: -180 - maximum: 180)

      longitude in degrees

    • latitude: required(number - minimum: -90 - maximum: 90)

      latitude in degrees

• video_info: required(object)

  stream source video info

  • width: required(integer)

    stream source video width

  • height: required(integer)

    stream source video height

  • frame_rate: required(integer)

    stream source video frame rate

  • bit_rate: required(integer)

    stream source video bit rate

  • gop_size: required(integer)

    stream source video gop size

  • start_time: required(string)

    stream start time (ISO 8601)

HTTP status code 200

Ok.

Body

Media type: image/jpeg

Type: any

Example:

<jpeg image data>

HTTP status code 400

Invalid query or id.

Body

Media type: application/json

Type: any

Example:

{
  "error_code": 1,
  "detail": "Invalid uuid"
}

HTTP status code 404

Stream not found.

Body

Media type: application/json

Type: any

Example:

{
  "error_code": 1,
  "detail": "Stream with such uuid doesn't exist"
}

HTTP status code 500

Internal error.

Body

Media type: application/json

Type: any

Example:

{
  "error_code": 2,
  "detail": "Unhandled exception"
}

HTTP status code 200

Ok.

Body

Media type: image/jpeg

Type: any

Example:

<jpeg image data>

HTTP status code 400

Invalid query or id.

Body

Media type: application/json

Type: any

Example:

{
  "error_code": 1,
  "detail": "Invalid uuid"
}

HTTP status code 404

Stream not found.

Body

Media type: application/json

Type: any

Example:

{
  "error_code": 1,
  "detail": "Stream with such uuid doesn't exist"
}

HTTP status code 500

Internal error.

Body

Media type: application/json

Type: any

Example:

{
  "error_code": 2,
  "detail": "Failed to encode frame to jpeg"
}