Welcome to Emby DEV

This is the one-stop location for all information around software development within the Emby ecosystem.

What's new?

Conceptual Documentation

This part is familiar stuff in a new shape:

  • The documentation from the GitHub Wiki has been migrated to Emby DEV
    • All articels have been revised and updated
    • The content is fully searchable now (even in the offline version of the docs)
    • All mentioned types and REST Api calls are linked to the reference documentation sections
  • Just take a look and see

Reference Documentation

For REST API

Previously there was only that swagger link on the server dashboard from which you could browse the API endpoints via the Swagger web app. This is tedious in handling and doesn't allow searching through API endpoints

  • The REST API reference documentation has been moved to this site now
  • It gets automatically updated with each new Emby Server release - when changes were introduced to the REST API surface
  • It is fully searchable
  • All related schema types are included on each endpoint documentation page
  • REST API schema types have cross-references to the native .NET API types
  • Go for it and Start Here!

For Emby Server .NET API

Totally new: We have a complete reference documentation for all types which are available to Plugin developers.

  • Structured browsing via tree TOC
  • Fully searchable
  • Might help you to find out things you weren't able to before
  • Surely not that much exciting for reading from top to bottom, but it's still Worth a Look. The real value will become apparent once you are looking for something specific.

The Emby SDK

At the core of all this, we have the new Emby SDK.

Previously, all information has been spread over many places
=> Now it's all in a single download package

Previously, all code, information and tools were permanently outdated => Not anymore: The new Emby SDK is getting updated and released automatically whenever a change is made to either the REST API or the Plugin API.

Previously, it wasn't always clear which APIs are new and specific to the current beta version or where these are available with the Release version => All concerns clear: The Emby SDK releases will be dual branched. This means that we have to release channels for the SDK (Release/Beta), just like the server itself

SDK Content

Besides two plugin sample projects, another highlight are the new Emby Server REST API client implementations in more than 6 different programming languages - of course including source code.

Check these out in the SDK Content section.