nexxOMNIA API
Search…
Introduction
API Design
Media API
Usage
Endpoints
Management API
Frontend API
API Clients
Notification Gateway
Changelog
Powered By GitBook
Media API
The Media Endpoint offers the most important Methods for most Usecases. Due to the fact, that the nexxOMNIA API supports a variety of Media Types ("Streamtypes"), this Documentation will only mention "streamtype" as Endpoint Parameter, which can be replaced and is valid for all the following Streamtypes.

Default Media

Video

Live
Scenes
Audio
Radio
Images
Files
Articles
Events
Posts
​
Please notice, that the API uses always the Plural Form of a Streamtype in URL Building.

Container Media

in various Cases, there are "Collections" of Media in one Container. These "Container Media" are often also references as "Parent" and they take the following Streamtypes:

Playlists

Container for Videos

Series

Container for Playlists

Audio Albums

Container for Audio

Albums

Container for Images

Magazines

Container for Articles

Folders

Container for Files

Groups

Container for Persons

Racks

Container for Video/LiveStream Alternatives

Sets

Container for Lists of Videos and Scenes

Collections

Container for Lists of all single Streamtypes

Bundles

Container for Lists of Container Elements

Teams

Container for Users
​
Container Media Types are handled identically in the Media API. They use the same Endpoints and Methods as "Default Media".

Referencing Media

Some Streamtypes are rarely used directly, but often used on other Media Types. For example, a Video might have a List of Links or Files connected to it. These are "referencing Media Items"

Persons

Shows
Places
Products
Links
Studios
​
Referencing Media Types are also handled identically in the Media API. They use the same Endpoints and Methods as "Default Media".
​
Previous
Response Object
Next
Usage
Last modified 6mo ago
Copy link
On this page
Default Media
Container Media
Referencing Media