OMSS Core is the official TypeScript runtime and plugin orchestrator for building OMSS-compliant media streaming services.
The core is intentionally minimal. Its sole responsibility is to manage the OMSS lifecycle, load plugins, and expose shared states between them. All additional functionality — HTTP transport, caching, resolvers, auth — is added via OMSS Plugins.
Note
The project is in beta. The API shown here is preliminary.
- Install
- Quick Start
- Features
- Documentation
- Ecosystem
- ID Convention
- Contributing
- Support
- Team
- Acknowledgments
- License
- Dependencies
npm install @omss/coreyarn add @omss/corepnpm add @omss/coreimport { OMSSServer } from '@omss/core'
import httpPlugin from '@omss/plugin-http'
import cachePlugin from '@omss/plugin-cache'
const server = new OMSSServer({
name: 'My Media Server',
})
await server.plugins.register(httpPlugin, {
port: 3000,
})
// and many other features.Do you want to know more? Check out the documentation for a more in-depth guide.
- Modular by design: The core ships with almost no functionality. Everything is a plugin.
- OMSS Lifecycle: Use hooks to get notified of OMSS lifecycle events.
- Fully typed: Built in TypeScript with full type exports for Everything (no
anyused!) - Extensible: OMSS Core is fully extensible via its hooks, plugins, and decorators.
- Middleware support: Certain services expose middleware chains that plugins can extend (e.g., caching layers).
- Developer friendly: The framework is built to be very expressive and help developers in their daily use without sacrificing performance.
- Standards-compliant: Built with the OMSS Specification in mind.
The documentation is currently under development. You can find the latest version at https://omss.mintlify.site.
We are working on a comprehensive ecosystem of plugins that can be used to extend OMSS.
The current Open Media Streaming Specification can always be found at https://github.com/omss-spec/omss-spec.
An official plugin registry is planned for the future.
Official Plugins (maintained by the OMSS team):
Note
These plugins are a WIP.
| Plugin | Description |
|---|---|
@omss/plugin-http |
HTTP transport via Fastify |
@omss/plugin-cache |
Memory and Redis caching |
@omss/plugin-auth |
Basic authentication support |
Resolvers are used to resolve OMSS IDs to media metadata.
Official Resolvers (maintained by the OMSS team):
Note
These resolvers are a WIP.
| Resolver | Description |
|---|---|
@omss/resolver-tmdb |
TMDB resolver |
IDs follow the format <namespace>:<value_1>:<value_2>:...:<value_n>. Values can contain any character — use URL encoding if your value includes : or whitespaces. Values are URL-decoded during parsing.
However, the following namespaces are reserved for the OMSS specification and must follow the rules below. More namespaces may be added in the future:
TMDB:
- Movie:
tmdb:<movie_id>— e.g.,tmdb:155 - TV Episode:
tmdb:<show_id>:<season>:<episode>— e.g.,tmdb:1396:3:7
Note
All values must be natural numbers (≥ 1), except season_number which may be 0 (specials).
IMDb (Movies and TV Episodes only — not series):
- Movie:
imdb:tt<digits>— e.g.,imdb:tt0468569 - TV Episode:
imdb:tt<digits>— e.g.,imdb:tt1480055
Note
Valid IMDb IDs consist of the prefix tt followed by exactly seven digits.
A full list of supported namespaces and their values can be found in the OMSS Specification and the docs (coming soon).
Whether reporting bugs, discussing improvements, or writing code — contributions are welcome. Please read the CONTRIBUTING guidelines before opening a pull request.
We are active on GitHub Discussions.
OMSS Core (and its plugins) is the result of a great community (alphabetically sorted).
Lead Maintainers:
Contributors:
(Join us by contributing!)
This project (rather it's ecosystem/API) is inspired by Fastify.
Licensed under MIT.
This is a pure TypeScript project, meaning it has no production dependencies.