# Get saved stream configuration

Returns the persisted (on-disk) configuration for the stream or stream pattern.

Endpoint: GET /v1/{server}/plugin/vif/applications/{appName}/streams/{streamName}/config
Security: basicAuth

## Path parameters:

  - `server` (string, required)
    WSE server name. Any value is accepted; commonly _defaultServer_.

  - `appName` (string, required)
    Name of the Wowza application the stream is running on (e.g. live).

  - `streamName` (string, required)
    Stream name or a stream pattern (regex) used to match streams, e.g. objects.*.

## Response 200 fields (application/json):

  - `active` (boolean)
    Set to true to register WSE with the VI service.

  - `vi_service` (string,null)
    WebSocket endpoint for the VI service, e.g. ws://HOST:PORT/ws/stream/.

  - `vi_service_api_key` (string,null)
    API key for authentication with the VI service.

  - `app_name` (string,null)
    Per-stream application name. If blank, applies to all applications.

  - `stream_name` (string,null)
    Stream name or regex pattern to match incoming streams, e.g. objects.*.

  - `vif_event_listeners` (any)
    Array (or map) of VIF event listeners to trigger.

  - `rollup_batch_interval` (integer)
    Seconds to hold detections for rollup and batch events.

  - `grayscaled` (boolean)
    Send/process frames as grayscale to reduce latency and traffic.

  - `landscape_video` (boolean)
    Whether the video is in landscape orientation.

  - `object_analysis` (object)
    Object-detection configuration.

  - `object_analysis.model_name` (string)

  - `object_analysis.class_names` (array)

  - `object_analysis.confidence_threshold` (number)

  - `object_analysis.tracking_method` (string,null)

  - `object_analysis.byte_track_properties` (object)
    ByteTrack object-tracking tuning parameters.

  - `object_analysis.byte_track_properties.track_creation_minimum_confidence` (number)

  - `object_analysis.byte_track_properties.max_lost_track_frames_before_track_removal` (integer)

  - `object_analysis.byte_track_properties.minimum_consecutive_track_overlap` (number)

  - `object_analysis.byte_track_properties.track_creation_minimum_consecutive_frames` (integer)

  - `scene_analysis` (object)
    Scene/VLM analysis configuration.

  - `scene_analysis.type` (string)

  - `scene_analysis.sensitivity` (number)

  - `ignore_untracked_objects` (boolean)
    Ignore untracked objects when a tracking_method is set.

  - `frame_buffer` (integer)
    Size of the frame buffer holding frames to send to the VIF service.

  - `catch_up_to_live` (boolean)
    Scene/VLM only. When inference stays slower than real-time, skip the stale buffered backlog and resume at the live edge instead of letting latency grow.

  - `catch_up_max_behind_seconds` (number,null)
    Scene/VLM only. How far behind live (seconds) detections may fall before catch-up skips to live. Unset derives to the buffer headroom (~2s).

  - `auto_frame_throttle` (boolean)
    Opt-in frame-rate throttle (all modes): reduce inference_fps when inference falls behind. Renamed from auto_scene_frame_throttle (still accepted on read).

  - `use_transcoder` (boolean)
    Use the transcoder to grab frames.

  - `inference_fps` (integer)
    Frames per second sent to inferencing when use_transcoder is true.

  - `inference_video_height` (integer)
    Height of the video to be inferenced. -1 = source, 0 = model, >0 actual value.

  - `frame_grab_interval` (integer)
    Seconds between grabbing a frame when use_transcoder is false.

  - `skip_frames` (integer)
    Process every Nth frame.

  - `save_images` (boolean)
    Debug: save frames from the transcoder to /tmp/vif/.

  - `log_timing` (integer)
    Debug: seconds between writing timing metrics. 0 disables.

  - `log_max_messages` (integer)
    Debug: max log messages to write for vif/ws/wss. -1 all, 0 disabled.

  - `streams` (array)
    Per-stream configuration overrides.

## Response 401 fields (application/json):

  - `status` (string)

  - `code` (integer)

  - `message` (string, required)

## Response 404 fields (application/json):

  - `status` (string)

  - `code` (integer)

  - `message` (string, required)