Channels
Channels
are used to organize Media assets and to manage their accessibility.
Also Media
search results can be filtered according to particular Channels
.
Further, you can customize the Channel's
appearance via Designs.
You can make Media
assets public
by adjusting the visibility
of the Channel
the assets are assigned to.
The Media
assets will then be available in the Streamdiver Public Portal if your subscription includes it.
Further, if you are using iframes
embeddings based on the Streamdiver Public Portal, the Channel
Designs
can be applied and customized for your public
and shared
content.
The shared
visibility
indicates that the Media
asset can be publicly accessed based on its URL, but will be hidden from the Streamdiver Public Portal.
When using the Streamdiver API in combination with the Streamdiver Center it is important to note
that two Channel
types are distinguished: user
and group
Channels
.
The user
Channel
has reduced configuration options and is meant only for content exclusively
managed by the particular user.
A Channel
has a collection of members, which can be used to grant access and permissions. The members
are assigned together with roles representing the desired access/usage permissions.
ποΈ List channels
Retrieve a list of all `Channels` within the current authorization scope.
ποΈ Create a channel
Create a new `Channel` of type `group`. The creator of the `Channel` is automatically a `Channel` member with role `Channel Owner`.
ποΈ Retrieve a channel
Retrieve a `Channel` by the `channelId`.
ποΈ Update a channel
Updates certain properties of a `Channel`. For adjusting the `Channel` visibility to refer to the [Update channel visibility](#tag/Channels/operation/updateChannelVisibility) endpoint.
ποΈ Delete a channel
Deletes a `Channel` and its associations to previously assigned `Media` assets.
ποΈ Update channel visibility
Update a `Channel`'s visibility by the `channelId`. With the role `Publisher` or higher, it is possible to set a `Channel`'s visibility to `public`. In combination with the Streamdiver *Public Portal*, a `public` `Channel` will then be listed in the portal, and becomes publicly accessible. `Channels` with visibility `shared` will be hidden from the portal, but can be accessed by anyone with the `Channel`'s share link.
ποΈ Feature channel
Featured `Channel` will be on top of sorting. The endpoint toggles feature state, optionally desired state can be forced with query parameter.
ποΈ Create channel members
Assign a new member of type `user` or `usergroup` to the `Channel`.
ποΈ List channel members
List all members and their roles for a `Channel`.
ποΈ Retrieve a channel member
Retrieves a `Channel` member by its identifier.
ποΈ Update a channel member
Update the properties of a `Channel` member.
ποΈ Delete a channel member
Remove the assignmend of a member from the `Channel`.
ποΈ Assign media assets to a channel
Bulk operation to assign multiple `Media` assets to a `Channel` with one request.
ποΈ Remove media assets from a channel
Bulk operation to remove multiple `Media` assets from a `Channel` with one request. Note that if the asset is in no other `Channel`, it is assigned back to the `user` `Channel` of its creator.
ποΈ Feature a media asset in channel
Featured `Media` asset will be on top of sorting inside the `Channel`. The endpoint toggles feature state, optionally desired state can be forced with query parameter.
ποΈ Retrieve the RSS feed import configuration
This endpoint returns the RSS feed import setup for the `Channel`.
ποΈ Create an RSS feed import to the channel
Configure an RSS feed import for automatically importing `Media` assets from the external feed to the specified `Channel`. You can specify a time range for the import and optionally enable monitoring for importing new assets in the future.
ποΈ Update an RSS feed import
Updates the RSS feed import for the `Channel`, you can change the time range and monitoring settings.
ποΈ Delete an RSS feed setup
Deletes a feed without deleting the Media assets which are already imported in the channel.
ποΈ Retrieve a thumbnail
Retrieve the thumbnail of the `Channel`.
ποΈ Update thumbnail
Updates the thumbnail for the selected `Channel`. <br /> Allowed image formats:
ποΈ Delete thumbnail
Delete the thumbnail from the `Channel`. The default thumbnail will then be used, which can be configured in the tenant settings.
ποΈ Assign design settings to channel
Use this endpoint to assign a previously created design template to a `Channel`. The design template will be applied to the `Channel` and will be used to render the `Channel` appearance including the player. For more details refer to the [create a channel design template](#tag/Design-Settings/operation/createChannelDesignTemplate) endpoint.
ποΈ Move livestreams into channel
Bulk operation to assign many `Livestreams` to the `Channel`
ποΈ Remove livestreams from channel
Bulk operation to remove many `Livestreams` assets from the `Channel`.