Skip to main content

Interface: StreamShareService

Public manifest that describes a StreamShare-compatible HTTP service.

Properties

protocolVersion

protocolVersion: 1

Protocol version implemented by the service.


name

name: string

Human-readable service name.


description?

optional description?: string

Short explanation of the service and its content.


logoPath?

optional logoPath?: string

Absolute, service-root-relative, or data URL for the service logo.


api

api: APIEndpoint[]

Endpoints available to StreamShare clients.


auth?

optional auth?: ServiceAuthentication

Authentication method required by protected API endpoints.