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

Retrieves a list of all `Channel`s within the current authorization scope.

📄️ Create channel

Creates a new `Channel` of type `group`. The creator of the `Channel` is automatically a `Channel` member with the role `Channel Owner`.

📄️ Get channel

Retrieves a `Channel` by its `channelId`.

📄️ Update channel

Updates certain properties of a `Channel`. To adjust the `Channel`'s visibility, refer to the [Update channel visibility](#tag/Channels/operation/updateChannelVisibility) endpoint.

📄️ Delete channel

Deletes a `Channel` and its associations to previously assigned `Media` assets.

📄️ Update channel visibility

Updates a `Channel`'s visibility by its `channelId`. A user with the role `Publisher` or higher can set a `Channel`'s visibility to `public`. In combination with the Streamdiver *Public Portal*, a `public` `Channel` will be listed in the portal and become publicly accessible. `Channel`s with visibility `shared` are hidden from the portal but can be accessed by anyone with the `Channel`'s share link.

📄️ Set channel featured

Toggles the featured state of a `Channel`, which sorts it to the top. The desired state can optionally be forced with a query parameter.

📄️ Add channel member

Assigns a new member of type `user` or `usergroup` to the `Channel`.

📄️ List channel members

Lists all members and their roles for a `Channel`.

📄️ Get channel member

Retrieves a `Channel` member by its identifier.

📄️ Update channel member

Updates the properties of a `Channel` member.

📄️ Remove channel member

Removes the assignment of a member from the `Channel`.

📄️ Add media to channel

Performs a bulk operation to assign multiple `Media` assets to a `Channel` with a single request.

📄️ Remove media from channel

Performs a bulk operation to remove multiple `Media` assets from a `Channel` with a single request. If an asset is in no other `Channel`, it is assigned back to the `user` `Channel` of its creator.

📄️ Set media featured in channel

Toggles the featured state of a `Media` asset within a `Channel`, which sorts it to the top. The desired state can optionally be forced with a query parameter.

📄️ Get channel feed import

Returns the RSS feed import setup for the `Channel`.

📄️ Create channel feed import

Configures an RSS feed import for automatically importing `Media` assets from an external feed to the specified `Channel`. A time range for the import can be specified, and monitoring for new assets can optionally be enabled.

📄️ Update channel feed import

Updates the RSS feed import for the `Channel`. The time range and monitoring settings can be changed.

📄️ Delete channel feed import

Deletes a feed without deleting the `Media` assets that have already been imported into the `Channel`.

📄️ Get channel thumbnail

Retrieves the thumbnail of the `Channel`.

📄️ Update channel thumbnail

Updates the thumbnail for the selected `Channel`. <br /> Allowed image formats:

📄️ Delete channel thumbnail

Deletes the thumbnail from the `Channel`. The default thumbnail, which can be configured in the [tenant settings](#tag/Tenants/operation/getCurrentTenantSettings), will then be used.

📄️ Assign design settings to channel

Assigns a previously created design template to a `Channel`. The design template is applied to the `Channel` and is used to render the `Channel`'s appearance, including the player. For more details, refer to the [create a channel design template](#tag/Design-Settings/operation/createChannelDesignTemplate) endpoint.