# StreamShare Documentation > Public product and developer documentation for StreamShare applications, addons, services, and desktop clients. Use the version and compatibility page for the relevant integration. The linked Markdown files are generated from the same sources as the human-readable site. ## Addons - [@streamshare/plugin-sdk v1.0.0](https://docs.tootiapps.com/markdown/addons/api/index.md) - [Adapt a remote catalog](https://docs.tootiapps.com/markdown/addons/guides/remote-source-addons.md): Design a source addon that queries and parses an authorized remote catalog without maintaining a local index. - [Addon compatibility](https://docs.tootiapps.com/markdown/addons/compatibility.md): Compatibility policy for StreamShare addon SDK versions and host applications. - [Addon manifest reference](https://docs.tootiapps.com/markdown/addons/concepts/manifest.md): Complete reference for every supported StreamShare addon manifest property. - [Background tasks](https://docs.tootiapps.com/markdown/addons/guides/background-tasks.md): Design durable, cooperative addon work on supported Android devices. - [Build a source addon](https://docs.tootiapps.com/markdown/addons/guides/source-addons.md): Model searchable media, containers, pagination and playback through the public source contract. - [Class: PluginCompatibilityError](https://docs.tootiapps.com/markdown/addons/api/classes/PluginCompatibilityError.md) - [Class: PluginManifestValidationError](https://docs.tootiapps.com/markdown/addons/api/classes/PluginManifestValidationError.md) - [Create your first addon](https://docs.tootiapps.com/markdown/addons/getting-started.md): Set up, implement, run, and package a minimal StreamShare addon. - [Develop addons with AI assistants](https://docs.tootiapps.com/markdown/addons/guides/ai-assisted-development.md): Give an AI assistant authoritative SDK context, use llms.txt effectively and keep addon changes reviewable. - [Development mode](https://docs.tootiapps.com/markdown/addons/guides/development-mode.md): Run an addon from the local CLI, connect StreamShare and reload changes without building installation ZIPs. - [Example Catalog Source](https://docs.tootiapps.com/markdown/addons/examples/catalog-source-addon.md): Explore a deterministic reference implementation of every public source-addon method. - [Function: assertPluginCompatibleWithApplication()](https://docs.tootiapps.com/markdown/addons/api/functions/assertPluginCompatibleWithApplication.md) - [Function: assertPluginManifest()](https://docs.tootiapps.com/markdown/addons/api/functions/assertPluginManifest.md) - [Function: isPluginCompatibleWithApplication()](https://docs.tootiapps.com/markdown/addons/api/functions/isPluginCompatibleWithApplication.md) - [Function: isPluginManifest()](https://docs.tootiapps.com/markdown/addons/api/functions/isPluginManifest.md) - [Function: isValidNetworkPermission()](https://docs.tootiapps.com/markdown/addons/api/functions/isValidNetworkPermission.md) - [Function: parsePluginManifest()](https://docs.tootiapps.com/markdown/addons/api/functions/parsePluginManifest.md) - [Function: registerPlugin()](https://docs.tootiapps.com/markdown/addons/api/functions/registerPlugin.md) - [Hello addon example](https://docs.tootiapps.com/markdown/addons/examples/hello-addon.md): Explore a minimal automation addon with no network access or external dependencies. - [Interface: ActionInput](https://docs.tootiapps.com/markdown/addons/api/interfaces/ActionInput.md) - [Interface: BackgroundTaskConstraints](https://docs.tootiapps.com/markdown/addons/api/interfaces/BackgroundTaskConstraints.md) - [Interface: ConfigField](https://docs.tootiapps.com/markdown/addons/api/interfaces/ConfigField.md) - [Interface: IAutomationPlugin\](https://docs.tootiapps.com/markdown/addons/api/interfaces/IAutomationPlugin.md) - [Interface: IPluginAPI](https://docs.tootiapps.com/markdown/addons/api/interfaces/IPluginAPI.md) - [Interface: ISourcePlugin](https://docs.tootiapps.com/markdown/addons/api/interfaces/ISourcePlugin.md) - [Interface: NetworkPermissions](https://docs.tootiapps.com/markdown/addons/api/interfaces/NetworkPermissions.md) - [Interface: PluginAction](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginAction.md) - [Interface: PluginBackgroundTask](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginBackgroundTask.md) - [Interface: PluginFileScanOptions](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginFileScanOptions.md) - [Interface: PluginFileScanResult](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginFileScanResult.md) - [Interface: PluginFileStat](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginFileStat.md) - [Interface: PluginList](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginList.md) - [Interface: PluginListItem](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginListItem.md) - [Interface: PluginListItemInput](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginListItemInput.md) - [Interface: PluginListWithItems](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginListWithItems.md) - [Interface: PluginManifest](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginManifest.md) - [Interface: PluginRuntime](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginRuntime.md) - [Interface: PluginRuntimeCapabilities](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginRuntimeCapabilities.md) - [Interface: PluginSourceCatalogAppendResult](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginSourceCatalogAppendResult.md) - [Interface: PluginSourceCatalogBatch](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginSourceCatalogBatch.md) - [Interface: PluginSourceCatalogItem](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginSourceCatalogItem.md) - [Interface: PluginSourceCatalogQuery](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginSourceCatalogQuery.md) - [Interface: PluginSourceCatalogResult](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginSourceCatalogResult.md) - [Interface: PluginSourceCatalogVariant](https://docs.tootiapps.com/markdown/addons/api/interfaces/PluginSourceCatalogVariant.md) - [Interface: SourceCapabilities](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourceCapabilities.md) - [Interface: SourceFacets](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourceFacets.md) - [Interface: SourceInfo](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourceInfo.md) - [Interface: SourceMediaItem](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourceMediaItem.md) - [Interface: SourcePagedResult](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourcePagedResult.md) - [Interface: SourcePlaybackInfo](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourcePlaybackInfo.md) - [Interface: SourceSearchCriteria](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourceSearchCriteria.md) - [Interface: SourceTag](https://docs.tootiapps.com/markdown/addons/api/interfaces/SourceTag.md) - [Interface: SubscriptionConfig](https://docs.tootiapps.com/markdown/addons/api/interfaces/SubscriptionConfig.md) - [Interface: SystemEventContext\](https://docs.tootiapps.com/markdown/addons/api/interfaces/SystemEventContext.md) - [Interface: ToastOptions](https://docs.tootiapps.com/markdown/addons/api/interfaces/ToastOptions.md) - [Network access](https://docs.tootiapps.com/markdown/addons/guides/network-access.md): Declare and use the addon network allowlist safely. - [Public addon contract](https://docs.tootiapps.com/markdown/addons/concepts/public-contract.md): Understand what StreamShare guarantees to addons and what remains an implementation detail. - [Runtime capabilities](https://docs.tootiapps.com/markdown/addons/concepts/runtime-capabilities.md): Detect which host APIs are available in interactive and headless addon executions. - [StreamShare addons](https://docs.tootiapps.com/markdown/addons/index.md): Build sandboxed addons with the public StreamShare plugin SDK and CLI. - [TMDB metadata and source addons](https://docs.tootiapps.com/markdown/addons/guides/tmdb-metadata.md): Let StreamShare enrich source results while keeping playback and availability under addon control. - [Type Alias: BackgroundNetworkType](https://docs.tootiapps.com/markdown/addons/api/type-aliases/BackgroundNetworkType.md) - [Type Alias: PluginActionParameters](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginActionParameters.md) - [Type Alias: PluginConfiguration](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginConfiguration.md) - [Type Alias: PluginIconAppearance](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginIconAppearance.md) - [Type Alias: PluginRuntimeMode](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginRuntimeMode.md) - [Type Alias: PluginRuntimePlatform](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginRuntimePlatform.md) - [Type Alias: PluginRuntimeReason](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginRuntimeReason.md) - [Type Alias: PluginType](https://docs.tootiapps.com/markdown/addons/api/type-aliases/PluginType.md) - [Type Alias: SourceMediaType](https://docs.tootiapps.com/markdown/addons/api/type-aliases/SourceMediaType.md) - [Type Alias: SourceSortOption](https://docs.tootiapps.com/markdown/addons/api/type-aliases/SourceSortOption.md) - [Type Alias: StreamShareAddon](https://docs.tootiapps.com/markdown/addons/api/type-aliases/StreamShareAddon.md) - [Validate a manifest](https://docs.tootiapps.com/markdown/addons/guides/manifest-validation.md): Validate untrusted addon manifests with the same rules as the StreamShare host and CLI. - [Work with Collection lists](https://docs.tootiapps.com/markdown/addons/guides/lists.md): Read and populate user-authorized Collection lists from an interactive addon. ## Applications - [Desktop clients](https://docs.tootiapps.com/markdown/product/clients/index.md): StreamShare receiver clients for Windows, macOS, and Linux. - [Desktop platform support](https://docs.tootiapps.com/markdown/product/clients/platforms.md): Platform and architecture support policy for StreamShare desktop clients. - [Homepage](https://docs.tootiapps.com/markdown/product/application/homepage.md): Understand the StreamShare homepage sections and choose which ones to display. - [Media Hub](https://docs.tootiapps.com/markdown/product/application/media-hub.md): Browse, search and play media from the sources selected in StreamShare. - [Media Library and lists](https://docs.tootiapps.com/markdown/product/application/media-library.md): Organize the personal lists exposed by the Collection source. - [Media metadata and TMDB](https://docs.tootiapps.com/markdown/product/application/media-metadata.md): Understand how StreamShare adds rich, localized metadata to media from different sources. - [Mobile application](https://docs.tootiapps.com/markdown/product/application/mobile.md): Public overview of StreamShare for phones and tablets. - [Remote control](https://docs.tootiapps.com/markdown/product/application/remote-control.md): Select and control a playback target from the StreamShare remote screen. - [Settings](https://docs.tootiapps.com/markdown/product/application/settings.md): Understand each StreamShare settings section and when to use it. - [StreamShare application](https://docs.tootiapps.com/markdown/product/application/index.md): Find the StreamShare feature you want to use on mobile or TV. - [StreamShare applications](https://docs.tootiapps.com/markdown/product/index.md): Public documentation for StreamShare on mobile, television, and desktop receiver platforms. - [Support and compatibility](https://docs.tootiapps.com/markdown/product/support-and-compatibility.md): How public StreamShare support and compatibility information is communicated. - [TV application](https://docs.tootiapps.com/markdown/product/application/tv.md): Public overview of the remote-friendly StreamShare television experience. ## Services - [@streamshare/service v1.0.1](https://docs.tootiapps.com/markdown/services/api/index.md) - [Class: StreamShareProtocolError](https://docs.tootiapps.com/markdown/services/api/classes/StreamShareProtocolError.md) - [Create your first service](https://docs.tootiapps.com/markdown/services/getting-started.md): Define a StreamShare service manifest and return a typed media response. - [Demonstration service](https://docs.tootiapps.com/markdown/services/example-service.md): Learn from the optional public reference implementation of the StreamShare service protocol. - [Development and contract testing](https://docs.tootiapps.com/markdown/services/guides/development-and-testing.md): Run a service locally, validate payloads, handle failures, and test it with StreamShare. - [Function: assertStreamShareResponse()](https://docs.tootiapps.com/markdown/services/api/functions/assertStreamShareResponse.md) - [Function: assertStreamShareService()](https://docs.tootiapps.com/markdown/services/api/functions/assertStreamShareService.md) - [Function: defineService()](https://docs.tootiapps.com/markdown/services/api/functions/defineService.md) - [Function: isStreamShareResponse()](https://docs.tootiapps.com/markdown/services/api/functions/isStreamShareResponse.md) - [Function: isStreamShareService()](https://docs.tootiapps.com/markdown/services/api/functions/isStreamShareService.md) - [Function: parseServiceDeviceAuthorization()](https://docs.tootiapps.com/markdown/services/api/functions/parseServiceDeviceAuthorization.md) - [Function: parseServiceDeviceTokenResponse()](https://docs.tootiapps.com/markdown/services/api/functions/parseServiceDeviceTokenResponse.md) - [Function: parseServiceTokenGrant()](https://docs.tootiapps.com/markdown/services/api/functions/parseServiceTokenGrant.md) - [Function: parseStreamShareResponse()](https://docs.tootiapps.com/markdown/services/api/functions/parseStreamShareResponse.md) - [Function: parseStreamShareService()](https://docs.tootiapps.com/markdown/services/api/functions/parseStreamShareService.md) - [Interface: APIEndpoint](https://docs.tootiapps.com/markdown/services/api/interfaces/APIEndpoint.md) - [Interface: ApiKeyServiceAuthentication](https://docs.tootiapps.com/markdown/services/api/interfaces/ApiKeyServiceAuthentication.md) - [Interface: BasicServiceAuthentication](https://docs.tootiapps.com/markdown/services/api/interfaces/BasicServiceAuthentication.md) - [Interface: BrowseEndpoint](https://docs.tootiapps.com/markdown/services/api/interfaces/BrowseEndpoint.md) - [Interface: DeviceCodeServiceAuthentication](https://docs.tootiapps.com/markdown/services/api/interfaces/DeviceCodeServiceAuthentication.md) - [Interface: ParamBase](https://docs.tootiapps.com/markdown/services/api/interfaces/ParamBase.md) - [Interface: ParamSelect](https://docs.tootiapps.com/markdown/services/api/interfaces/ParamSelect.md) - [Interface: ParamText](https://docs.tootiapps.com/markdown/services/api/interfaces/ParamText.md) - [Interface: PlayLink](https://docs.tootiapps.com/markdown/services/api/interfaces/PlayLink.md) - [Interface: PlayLinkMetadata](https://docs.tootiapps.com/markdown/services/api/interfaces/PlayLinkMetadata.md) - [Interface: ServiceDeviceAuthorization](https://docs.tootiapps.com/markdown/services/api/interfaces/ServiceDeviceAuthorization.md) - [Interface: ServiceDeviceTokenRequest](https://docs.tootiapps.com/markdown/services/api/interfaces/ServiceDeviceTokenRequest.md) - [Interface: ServiceRefreshTokenRequest](https://docs.tootiapps.com/markdown/services/api/interfaces/ServiceRefreshTokenRequest.md) - [Interface: ServiceTokenGrant](https://docs.tootiapps.com/markdown/services/api/interfaces/ServiceTokenGrant.md) - [Interface: StreamShareFacets](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareFacets.md) - [Interface: StreamShareMediaResult](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareMediaResult.md) - [Interface: StreamSharePagination](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamSharePagination.md) - [Interface: StreamShareResponse](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResponse.md) - [Interface: StreamShareResultBase](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultBase.md) - [Interface: StreamShareResultEpisode](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultEpisode.md) - [Interface: StreamShareResultFolder](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultFolder.md) - [Interface: StreamShareResultMovie](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultMovie.md) - [Interface: StreamShareResultSeason](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultSeason.md) - [Interface: StreamShareResultSeries](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultSeries.md) - [Interface: StreamShareResultUnclassified](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareResultUnclassified.md) - [Interface: StreamShareService](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareService.md) - [Interface: StreamShareTmdbReference](https://docs.tootiapps.com/markdown/services/api/interfaces/StreamShareTmdbReference.md) - [Results and playback variants](https://docs.tootiapps.com/markdown/services/guides/results-and-playback.md): Return media, TMDB references, navigation targets, quality labels, and pagination. - [Service authentication](https://docs.tootiapps.com/markdown/services/guides/authentication.md): Protect service endpoints with Basic credentials, a static API key, or a device-code token session. - [Service compatibility](https://docs.tootiapps.com/markdown/services/compatibility.md): Versioning and compatibility policy for remote StreamShare services. - [Service manifest](https://docs.tootiapps.com/markdown/services/guides/manifest.md): Declare endpoint semantics, parameters, authentication, and assets for a StreamShare service. - [Service protocol](https://docs.tootiapps.com/markdown/services/protocol.md): Public behavioral contract between StreamShare applications and remote services. - [StreamShare services](https://docs.tootiapps.com/markdown/services/index.md): Build remote HTTP media services with the public StreamShare service contract. - [Type Alias: MetadataColor](https://docs.tootiapps.com/markdown/services/api/type-aliases/MetadataColor.md) - [Type Alias: Param](https://docs.tootiapps.com/markdown/services/api/type-aliases/Param.md) - [Type Alias: ServiceAuthentication](https://docs.tootiapps.com/markdown/services/api/type-aliases/ServiceAuthentication.md) - [Type Alias: ServiceDeviceTokenResponse](https://docs.tootiapps.com/markdown/services/api/type-aliases/ServiceDeviceTokenResponse.md) - [Type Alias: ServiceEndpointKind](https://docs.tootiapps.com/markdown/services/api/type-aliases/ServiceEndpointKind.md) - [Type Alias: ServiceParameterRole](https://docs.tootiapps.com/markdown/services/api/type-aliases/ServiceParameterRole.md) - [Type Alias: StreamShareItemType](https://docs.tootiapps.com/markdown/services/api/type-aliases/StreamShareItemType.md) - [Type Alias: StreamShareResult](https://docs.tootiapps.com/markdown/services/api/type-aliases/StreamShareResult.md) ## Optional - [Full Markdown context](https://docs.tootiapps.com/llms-full.txt): Concatenated convenience export of every public documentation page. - [Documentation manifest](https://docs.tootiapps.com/markdown/manifest.json): Structured inventory with human-readable and Markdown URLs.