Introduction

• Edge Video Analytics Microservice
  • Overview
  • How it Works
• Get Started Guide
  • Prerequisites
  • Quick try out
    • Pull the image and start container
    • Run default sample
  • Summary
  • Learn More
  • Legal Information
• Get Started Guide Helm
  • Prerequisites
  • Quick try out
    • Pull the helm chart and start
    • Run default sample
  • Summary
  • Learn More
  • Legal Information

Deployment Guide

• Defining and launching preconfigured pipelines
  • Providing payload for autostart
• Defining and launching configurable pipelines

REST API Guide

• REST API
  • REST Endpoints Reference Guide
    • RESTful Endpoints
      • GET /pipelines
        • Responses
          • 200 - Success
            • application/json
          • Example (generated)
      • GET /pipelines/status
        • Responses
          • 200 - Success
            • application/json
          • Example (generated)
      • POST /pipelines/{name}/{version}
        • Path parameters
          • name
          • version
        • Request body
          • Example
        • Responses
          • 200 - Success
      • DELETE /pipelines/{instance_id}
        • Path parameters
          • instance_id
        • Responses
          • 200 - Success
      • POST /pipelines/{name}/{version}/{instance_id}
        • Synchronous behavior
        • Path parameters
          • name
          • version
          • instance_id
        • Request body
          • Example
        • Responses
          • 200 - Success
            • application/json
          • Example
      • POST /pipelines/{name}/{version}/{instance_id}/models
        • Path parameters
          • name
          • version
          • instance_id
        • Request body
          • Example 1
          • Example 2
        • Responses
          • 200 - Success
      • GET /pipelines/{instance_id}
        • Path parameters
          • instance_id
        • Responses
          • 200 - Success
            • application/json
          • Example
  • Defining Media Analytics Pipelines
  • Pipeline Definition Files
    • How Pipeline Definition Files are Discovered and Loaded
    • Pipeline Definition
      • GStreamer Pipeline Definition
        • Object Detection
        • Source Abstraction
        • Element Names
        • Element Properties
        • Model Persistance in OpenVINO^™ GStreamer Elements
        • More Information
    • Pipeline Parameters
      • Defining Parameters as JSON Schema
      • Special Handling for Media Frameworks
        • Parameters and GStreamer Elements
        • Parameters and default value
        • Parameters and FFmpeg Filters
      • Parameter Resolution in Pipeline Templates
        • Direct Substitution
        • Media Framework Handling
      • Reserved Parameters
        • bus-messages
  • Deep Learning Models
    • OpenVINO^™ Toolkit’s Intermediate Representation
      • Converting Models
      • Ready To Use Models
    • Model-Proc Files
      • Intel(R) DL Streamer
      • FFmpeg Video Analytics
    • How Deep Learning Models are Discovered and Referenced
    • Referencing Models in Pipeline Definitions
  • Customizing Pipeline Requests
    • Request Format
      • Example Request
    • Source
      • File Source
      • RTSP Source
        • RTSP Basic Authentication
    • Setting source properties
      • Setting a property on source bin element
      • Setting a property on underlying element
    • Metadata Destination
      • File
      • MQTT
    • Frame Destination
      • RTSP
      • WebRTC
        • Request WebRTC Frame Output
        • WebRTC Destination Parameters
    • Parameters
    • Tags

Deploying pipelines with External cameras

• Cameras
  • Camera configurations
    • RTSP Cameras
      • RTSP Cameras

Advanced User Guide

• Detailed usage
  • Configuration
  • Rest API
  • Publisher
  • Model Update
  • Camera
  • File ingestion
  • Object tracking
  • Udf
  • HTTPS
  • Performance
• Cameras
  • Camera configurations
    • RTSP Cameras
      • RTSP Cameras
• File Ingestion
  • File based Ingestion
    • Video Ingestion
    • Image Ingestion
      • Image Ingestion
      • Video Ingestion
      • Multifilesrc Usage
        • Video File with gstreamer ingestor (multifilesrc)
• User Defined Functions (UDF)
  • UDF Writing Guide
  • How-To Guide for Writing UDF
  • Configuring udfloader element
    • Pallet Defect Detection
    • Add Label
      • UDF Writing Guide
        • Overview
        • How-To Guide for Writing UDF
          • Steps for Writing Python UDFs
            • Python APIs for writing UDF
      • Configuring udfloader element
        • Pallet Defect Detection
        • Add Label
      • Anomalib
        • Supported version in EVAM
        • Training
        • Supported models in EVAM
        • Inference using Anomalib UDF
• Publishers
  • RTSP Streaming
  • WebRTC Streaming
  • MQTT Publishing
    • Publish metadata via gvametapublish
    • Publish frame/metadata via gvapython
    • Publish Frame and Metadata post pipeline execution
    • gRPC Publishing
  • OPCUA Publishing
  • S3 frame publishing
    • MQTT Publishing via gvapython
      • Overview
      • Prerequisites
        • Verify MQTT broker has started
        • Start MQTT Subscriber
      • Configure EVAM for MQTT Publishing
        • Configuration options
        • Sample REST request
      • Secure publishing
      • Error Handling
    • MQTT Publishing post pipeline execution
      • Overview
      • Prerequisites for MQTT publishing
        • Configure and start MQTT broker
        • Start MQTT Subscriber
      • Configure EVAM for MQTT Publishing
        • Configuration options
        • Metadata filtering
      • Secure Publishing
      • Error Handling
    • gRPC Publishing post pipeline execution
      • Overview
      • Prerequisites
        • Configuration
      • Secure & Unsecure Publishing
      • Multi-pipeline Topic Association
      • Error handling
      • Known issues
    • OPCUA Publishing post pipeline execution
      • Overview
      • Prerequisites for OPC UA Publishing
        • Configuring and Starting the OPC UA Server
      • Configure EVAM for OPCUA Publishing
      • Error Handling
    • S3 Frame Storage
      • Enable S3 storage for frames
        • S3_write configuration
• Object Tracking
  • Object Tracking
    • Usage
    • Recommendations
    • Known Issues
• Model Update
  • Model Registry service integration
• Enable HTTPS for EVAM (Optional)
  • (Optional) Enable mTLS Verification
• Performance Analysis (Latency)
  • Steps to enable GST TRACER logging
    • Sample Log Output
  • Learn More
  • Known Issues

Version Updates

• Release Notes
  • March 2025
    • v2.3.0
      • Added
      • Fixed
      • Updates
  • February 2025
    • v2.2.0
      • Added
      • Fixed
      • Updates
  • November 2024
    • v2.1.0
      • Added
      • Fixed
      • Updates
    • v2.0.0 (November 2024)
      • Added
      • Fixed
      • Updates
  • October 2024
    • v1.3.2
      • Updates
  • September 2024
    • v1.3.1
      • Updates
  • July 2024
    • v1.3.0
      • Added
      • Fixed
      • Updates