Skip to main content

Interface: PluginManifest

Public manifest bundled with every StreamShare addon.

Remarks

The manifest is reviewed before installation. Keep identifiers stable and request only the capabilities required by the current addon version.

Properties

id

id: string

Globally unique, stable addon identifier such as com.example.my-addon.


name

name: string

Human-readable addon name.


version

version: string

Semantic version of the addon package.


compatibleVersion

compatibleVersion: string

Semantic-version range of compatible StreamShare application versions.


type

type: PluginType

Functional contract implemented by the addon entry script.


main

main: string

Package-relative path to the compiled JavaScript entry file.


icon?

optional icon?: string

Package-relative SVG, PNG or WebP used as the plugin's visual identity.


iconAppearance?

optional iconAppearance?: PluginIconAppearance

Controls whether the host may recolor the declared icon.

auto lets the host choose, monochrome requests a host-colored silhouette, and original preserves every color and filled area. Defaults to auto when omitted.


author

author: string

Publisher or maintainer name shown to the user.


description

description: string

Concise user-facing description of the addon.


adult?

optional adult?: boolean

Declares that every catalog entry and playback source exposed by this addon is intended for adults. The host may hide the addon and its data behind parental controls. Defaults to false when omitted.


permissions

permissions: NetworkPermissions

Capabilities that require review during installation or update.


backgroundTasks?

optional backgroundTasks?: PluginBackgroundTask[]

Android-only persistent work. Unsupported platforms keep using interactive events.


subscriptions?

optional subscriptions?: SubscriptionConfig[]

Host events delivered to the addon's optional event handler.


config?

optional config?: ConfigField[]

Persistent values editable from the host configuration screen.


actions?

optional actions?: PluginAction[]

Operations the user can invoke from the addon's host interface.