Data object MediaId
interface struct MediaId
The MediaId type is designed for the purpose of uniquely identifying media
content within a catalog system.
It encapsulates two critical pieces of information. The identifier and the
name of the catalog to which the media belongs.
For example, contentId = “tt0050083”, catalogName = “imdb” identifies a title
from the imdb database.
For additional usage information, see the package that is using MediaId.
Fields
contentId
string — Required
A string that serves as the unique identifier for the media within its
catalog.
This ID is the primary key that differentiates one piece of media
from another within the same catalog, ensuring precise identification and
retrieval of media items.
catalogName
string — Required
A string representing the name of the catalog where the media is stored.
This property provides context to the contentId, specifying which catalog
or library the contentId refers to. This is particularly useful in systems
that interact with multiple media catalogs, as it helps prevent confusion
between identically named media in different catalogs.
Use reverse DNS name notation when possible to identify the catalog name.
For example, if you catalog provider is hosted by a service named
com.provider.some.service, then use com.provider.some.service for the
catalog name.
For media streaming apps that stream content from their own catalog,
the catalog name matches the application’s package ID.
For example: com.somevendor.mystreamingserviceplus