{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/eagle-eye-networks/json-schema/eagle-eye-networks-api-paginated-feed-response-schema.json",
  "title": "ApiPaginatedFeedResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/eagle-eye-networks-feeds-api-openapi.yml#/components/schemas/ApiPaginatedFeedResponse",
  "allOf": [
    {
      "$ref": "#/$defs/PaginatedResponseWithSize"
    },
    {
      "type": "object",
      "properties": {
        "results": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ApiFeedWithIncludes"
          }
        }
      }
    }
  ],
  "$defs": {
    "ApiFeedIncludes": {
      "type": "object",
      "properties": {
        "flvUrl": {
          "type": [
            "string",
            "null"
          ],
          "x-jsoninclude-nonnull-annotation": true,
          "description": "Flash video delivered over HTTPS can be used to provide live streams, but also play back recordings."
        },
        "rtspUrl": {
          "type": "string",
          "x-jsoninclude-nonnull-annotation": true,
          "description": "RTSP is a protocol to request media to be sent, and to multiplex that media over one or more connections back to the client."
        },
        "rtspsUrl": {
          "type": "string",
          "x-jsoninclude-nonnull-annotation": true,
          "description": "Same as RTSP, but communication happens over a TLS socket instead of an unencrypted TCP socket."
        },
        "localRtspUrl": {
          "type": [
            "string",
            "null"
          ],
          "x-jsoninclude-nonnull-annotation": true,
          "description": "Same as RTSP, but this time requested directly to the bridge instead of the cloud."
        },
        "hlsUrl": {
          "type": [
            "string",
            "null"
          ],
          "x-jsoninclude-nonnull-annotation": true,
          "description": "Http Live Streaming can be used to deliver a live stream over HTTPS."
        },
        "multipartUrl": {
          "type": "string",
          "x-jsoninclude-nonnull-annotation": true,
          "description": "Proprietary protocol that uses multipart over HTTPS to deliver raw encoded image, video and audio frames as they become available"
        },
        "webRtcUrl": {
          "type": [
            "string",
            "null"
          ],
          "x-jsoninclude-nonnull-annotation": true,
          "description": "WebRTC can be used to set-up push to talk connections with speakers."
        },
        "audioPushHttpsUrl": {
          "type": [
            "string",
            "null"
          ],
          "x-jsoninclude-nonnull-annotation": true,
          "description": "Audio push url can be used to push the audio to the speaker associated with a camera."
        }
      }
    },
    "ApiFeedMain": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identifier of the feed"
        },
        "type": {
          "description": "Multiple feeds can be published per source, but they should all have the same viewpoint. They can differ in:\n  * quality: `main` is higher resolution while `preview` is low resolution and low framerate\n  * trigger: some generate frames continuously, while others only generate frames when something specific is visible such as a license plate.\n",
          "type": "string",
          "enum": [
            "main",
            "preview",
            "talkdown"
          ]
        },
        "deviceId": {
          "type": "string",
          "description": "The device generating the feed"
        },
        "mediaType": {
          "description": "What type of media is being generated",
          "type": "string",
          "enum": [
            "audio",
            "video",
            "image",
            "halfDuplex",
            "fullDuplex"
          ]
        }
      },
      "required": [
        "id",
        "type",
        "deviceId",
        "mediaType"
      ]
    },
    "ApiFeedWithIncludes": {
      "allOf": [
        {
          "$ref": "#/$defs/ApiFeedMain"
        },
        {
          "$ref": "#/$defs/ApiFeedIncludes"
        },
        {
          "type": "object"
        }
      ]
    },
    "PaginatedResponseNoTotalSize": {
      "type": "object",
      "description": "Used to wrap results for a paginated response, containing information on how to retrieve further pages.\n",
      "properties": {
        "nextPageToken": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true,
          "description": "Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.\n"
        },
        "prevPageToken": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true,
          "description": "Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.\n"
        },
        "results": {
          "type": "array",
          "readOnly": true,
          "description": "The result set from a collection API call.",
          "items": {
            "type": "object"
          }
        }
      },
      "required": [
        "nextPageToken",
        "prevPageToken",
        "results"
      ]
    },
    "PaginatedResponseWithSize": {
      "description": "Used to wrap results for a paginated response, containing information on how to retrieve further pages and  the total number of results.  \n",
      "allOf": [
        {
          "$ref": "#/$defs/PaginatedResponseNoTotalSize"
        },
        {
          "properties": {
            "totalSize": {
              "type": "integer",
              "readOnly": true,
              "description": "Size of the total result set.\n"
            }
          },
          "required": [
            "totalSize"
          ]
        }
      ]
    }
  }
}