@norskvideo/norsk-studio-built-ins 1.27.0-2025-07-05-19728d76 → 1.27.0-2025-07-08-02bba8fe

package/lib/input.srt-listener/types.source.yaml

@@ -0,0 +1,329 @@
+openapi: 3.0.0
+info:
+  title: SRT Listener Input Component
+  version: 1.0.0
+
+paths:
+  /disconnect:
+    post:
+      summary: Resets a connected SRT stream
+      description: Disconnects an active SRT stream by stream id
+      x-route-type: instance
+      requestBody:
+        description: The stream to disconnect
+        content:
+          application/json:
+            schema:
+              type: object
+              required: ['streamId']
+              properties:
+                streamId:
+                  type: string
+                  description: The ID of the stream to disconnect
+                  example: camera1
+      responses:
+        204:
+          description: The stream was successfully disconnected
+        404:
+          description: The specified stream was not found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: A description of the error
+                  details:
+                    type: string
+                    description: Additional error details
+        500:
+          description: Failed to disconnect the stream
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: A description of the error
+                  details:
+                    type: string
+                    description: Additional error details
+
+  /enable:
+    post:
+      summary: Re-enables a disabled SRT stream
+      description: Re-enables a previously disconnected SRT stream
+      x-route-type: instance
+      requestBody:
+        description: The stream to re-enable
+        content:
+          application/json:
+            schema:
+              type: object
+              required: ['streamId']
+              properties:
+                streamId:
+                  type: string
+                  description: The Id of the stream to re-enable
+                  example: camera1
+      responses:
+        204:
+          description: The stream was successfully re-enabled
+        400:
+          description: Stream is already connected or invalid request
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: A description of the error
+                  details:
+                    type: string
+                    description: Additional error details
+        500:
+          description: Failed to re-enable stream
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: A description of the error
+                  details:
+                    type: string
+                    description: Additional error details
+  /disable:
+    post:
+      summary: Disables an SRT stream by id
+      description: 
+      x-route-type: instance
+      requestBody:
+        description: The stream to disable
+        content:
+          application/json:
+            schema:
+              type: object
+              required: ['streamId']
+              properties:
+                streamId:
+                  type: string
+                  description: The Id of the stream to disable
+                  example: camera1
+      responses:
+        204:
+          description: The stream was successfully disabled
+        400:
+          description: The stream isn't known about, or invalid request
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: A description of the error
+                  details:
+                    type: string
+                    description: Additional error details
+        500:
+          description: Failed to disable stream
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  error:
+                    type: string
+                    description: A description of the error
+                  details:
+                    type: string
+                    description: Additional error details
+
+components:
+  schemas:
+    Config:
+      type: object
+      properties:
+        id:
+          type: string
+          description: Component ID
+        displayName:
+          type: string
+          description: Component display name
+        notes:
+          type: string
+          description: Optional notes about the component
+        port:
+          type: number
+          description: The port to listen on for SRT connections
+          minimum: 1
+          maximum: 65535
+        host:
+          type: string
+          description: The IP or hostname to bind to
+        passphrase:
+          type: string
+          description: Passphrase for encryption
+        sourceNames:
+          type: string
+          enum: ["permissive", "strict"]
+          description: Stream ID assignment mode
+        streamIds:
+          type: array
+          items:
+            type: string
+          description: List of expected stream IDs
+        socketOptions:
+          $ref: '../shared/srt.yaml#/components/schemas/SocketOptions'
+        streamMappings:
+          $ref: '../../../core/src/types/base.yml#/components/schemas/StreamMappingConfiguration'
+      required:
+        - id
+        - displayName
+        - sourceNames
+        - streamIds
+        - socketOptions
+        - port
+        - host
+
+    State:
+      type: object
+      properties:
+        connectedStreams:
+          type: array
+          items:
+            type: string
+        disabledStreams:
+          type: array
+          items:
+            type: string
+        metrics:
+          $ref: '../shared/srt.yaml#/components/schemas/SrtListenerMetrics'
+        names:
+          type: array
+          items:
+            type: string
+      required:
+        - connectedStreams
+        - disabledStreams
+        - metrics
+        - names
+
+    Commands:
+      oneOf:
+        - $ref: '#/components/schemas/DisableSourceCommand'
+        - $ref: '#/components/schemas/EnableSourceCommand'
+        - $ref: '#/components/schemas/ResetSourceCommand'
+
+    DisableSourceCommand:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["disable-source"]
+        streamId:
+          type: string
+      required:
+        - type
+        - streamId
+
+    EnableSourceCommand:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["enable-source"]
+        streamId:
+          type: string
+      required:
+        - type
+        - streamId
+
+    ResetSourceCommand:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["reset-source"]
+        streamId:
+          type: string
+      required:
+        - type
+        - streamId
+
+    Events:
+      oneOf:
+        - $ref: '#/components/schemas/SourceConnectedEvent'
+        - $ref: '#/components/schemas/SourceDisconnectedEvent'
+        - $ref: '#/components/schemas/SourceEnabledEvent'
+        - $ref: '#/components/schemas/SourceDisabledEvent'
+        - $ref: '#/components/schemas/MetricsUpdatedEvent'
+
+    SourceConnectedEvent:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["source-connected"]
+        streamId:
+          type: string
+        index:
+          type: number
+      required:
+        - type
+        - streamId
+        - index
+
+    SourceDisconnectedEvent:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["source-disconnected"]
+        streamId:
+          type: string
+      required:
+        - type
+        - streamId
+
+    SourceEnabledEvent:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["source-enabled"]
+        streamId:
+          type: string
+      required:
+        - type
+        - streamId
+
+    SourceDisabledEvent:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["source-disabled"]
+        streamId:
+          type: string
+      required:
+        - type
+        - streamId
+
+    MetricsUpdatedEvent:
+      type: object
+      properties:
+        type:
+          type: string
+          enum: ["metrics-updated"]
+        metrics:
+          $ref: '../shared/srt.yaml#/components/schemas/SrtListenerMetrics'
+      required:
+        - type
+        - metrics
+