Media
The Media asset object represents the files that have been uploaded and are hosted on the Streamdiver cloud.
You can upload files using the create an upload request.
We support four asset types:
videoaudioimagedocument
Channels can be used to organize the Media assets, each Media asset must be a
part of at least one Channel.
The Metadata of an uploaded file is automatically extracted, including derived content-based metadata like transcripts.
Additionally Metadata is indexed for searchability.
📄️ List media assets
Returns a list of all `Media` assets within the current authorization scope.
📄️ Bulk delete media assets
Performs a bulk operation to delete multiple `Media` assets with a single request. By default, performs a soft deletion, changing the asset status to `softDeleted`. A hard deletion, which physically deletes the assets from storage servers, can be requested optionally.
📄️ Bulk assign tags
Assigns tags to multiple `Media` assets with a single request.
📄️ Get media tags
Gets all and common `Tag`s of the given `Media` assets.
📄️ Get media asset
Returns the current representation of a `Media` asset, containing detailed information such as its `name`, `description`, and, for video/audio assets, the playlist URL. Use the optional `channelId` parameter to retrieve a `Media` asset in the context of a `Channel` for embedding purposes. Iframe embeddings will then be based on the `Channel` design options like `playerDesign`.
📄️ Update media asset
Updates the basic properties of a `Media` asset.
📄️ Remove media asset
Changes a `Media` asset's status to `softDeleted` or, optionally, performs a hard deletion, which physically deletes the `Media` asset from storage.
📄️ Recover media
Restores a soft-deleted `Media` asset with all its previous `Channel` assignments.
📄️ Get media thumbnail
Retrieves the thumbnail associated with a `Media` asset, which is a small image representing the asset.
📄️ Update media thumbnail
Updates the thumbnail for a `Media` asset. <br /> Allowed image formats:
📄️ Delete media thumbnail
Deletes the thumbnail from the `Media` asset.
📄️ Reingest media
Forces a new ingest if a previous one failed. If a `Media` asset with a successful `ingestJob` is re-ingested, the renditions will be replaced.
📄️ Share media
Assigns the `Media` asset to a new [Channel](#tag/Channels) with a `shared` visibility level. The `Channel` is named `Share_{mediaId}` and is created automatically in the background. The `Channel` and `Media` asset will not be shown on the Streamdiver Public Portal landing page; the asset can only be accessed using the `shareLink` URL.
📄️ List comments
Returns a list of comments under a specific `Media` asset.
📄️ Create comment
Creates a new comment for a `Media` asset.
📄️ Update comment
Updates a comment of a `Media` asset.
📄️ Delete comment
Removes a comment from a `Media` asset.
📄️ Get permissions on media asset
Retrieves a list of permissions the current user has on the given `Media` asset. `SuperAdmin`s have all available permissions; the permissions of all other users are based on their respective `ChannelMembership`s and `ChannelRole`s.
📄️ Get media events (SSE)
Provides events associated with the `Media` asset and dependent resources like `Media Chapter`s or `Livestream`s using Server-Sent Events (SSE).
📄️ Get SEO metadata
Provides structured metadata in `JSON/LD` format for public video `Media` assets to use for SEO enhancement when embedding. The structured-data schema is consistent with the Google SEO standard for videos ([Video structured data](https://developers.google.com/search/docs/appearance/structured-data/video)).
📄️ List channel media
Retrieves all `Media` assets assigned to a `Channel`.
📄️ Get SEO metadata
No longer maintained. Use the [SEO metadata](#tag/Media/operation/getMediaSeoMetadata) from the `Media` asset instead.