Updates to REST APIs, Webhooks, and GraphQL.

2024-10-15 | REST APIs & Webhooks

You'll find this latest REST API update provides access to the new live clipping feature and ability to manage media assets such as recordings and clips.

You can find additional related changes in the Dashboard and Applications Release Notes.

🆕 Live Clipping

With live clipping you can capture a partial clip from an active ongoing stream that is immediately available. This can power many solutions such as social network sharing, replay capabilities, as well as archival and auditing. Learn more from the Stream Recordings guide.

• Use the Media Assets REST endpoint to find all of your recordings and clips. The Create Media Asset allows you to send a clip request that can be configured to be stored in your own cloud storage configuration. Review the Stream Recordings guide to learn more about live clipping and how to manage media assets.
• For shorter clips processing will happen very quickly, but for longer clips there can be some processing time before the media file is available for retrieval. You can use the Media Assets endpoint to poll for the status or register a callback with the Media Webhook for status changes on any recordings or clips.
• Be aware that these new endpoints have a /api/v3 url path.

The Recording Hooks and Recordings REST endpoints will continue to work but are being deprecated so you should transition any applications and services.

🆕 Account Settings

For capabilities such as Geo-blocking and Geo-cascading there are settings that can default new publish tokens to specific values.

• The new Account Security and Account Distribution REST endpoints replace the previous endpoints for managing these account-wide settings. You'll find geo-blocking as a security setting and geo-cascading as a distribution setting.
• The new Media Assets Storage Profiles and Media Assets Expiration Rules REST endpoints allow you to configure and validate cloud storage and retention rules respectively. This provides default settings to be used when creating new clips and working with media assets.
• Be aware that these new endpoints have a /api/v3 url path.

The Read Account Geo Restrictions and Read Account Geo Cascade Settings endpoints will continue to work but are being deprecated so you should transition any applications and services.

2024-09-30 | Webhooks

🆕 ViewerConnection Hooks

For long-running streams, it can be helpful to start and stop the stream only when there are viewers connected. Using the new ViewerConnection webhook, you can write a service that listens for viewerAttempt and noActiveViewers events to start or stop a broadcast to better manage your bandwidth usage.

View the Webhooks guide to learn more about setting up webhooks.

2024-04-11 | REST APIs

Features

• Introduced a new Live Clipping feature in Limited Availability (LA). Live Clipping provides the ability to record streams and extract a clip, such as a highlight, before the stream is finished. This allows you to share key moments or highlights during an ongoing event, providing mezzanine file for uploading to social media or a VOD platform. The following Record Files REST APIs are introduced to support capturing multiple simultaneous recordings while a broadcast event is in progress:

  • Create Clip
  • Get Clip Request
  • List Clip Requests
  • List Available Clip Sources

  For more information, see the Live Clipping document. During the LA phase, this feature is behind a feature flag. Please contact your Dolby account executive or the support team if you would like to try the feature.

• Introduced a new Cloud Transcoder feature in Limited Availability (LA). One of the benefits of Millicast is that the platform can ingest multi-bitrate contribution feeds and deliver them as adaptive bitrate playback. When encoding at the studio or broadcast center, this eliminates channel fees and has the fastest glass-to-glass latency. Sometimes multi-bitrate ingest is not possible and a single, high-quality ingest is sent instead. Cloud Transcoder provides the ability to ingest SRT or RTMP and generate a latency-optimized adaptive bitrate ladder generation. The Cloud Transcoder can accept H.264 or H.265 ingest (including B-frames) and creates WebRTC-optimized adaptive bitrate delivery with only a couple of frames of latency. A new Create Transcoder REST API is introduced for transcoder management. During the LA phase, this feature is behind a feature flag. Please contact your Dolby account executive or the support team if you would like to try the feature. For more information, see the Cloud Transcoder guide.

2023-03-29 | REST APIs

REST APIs

Introduced the following Analytics REST APIs to query information based on the viewer's tracking ID:

• Total bandwidth per TrackingID per stream

• Series bandwidth per TrackingID per stream

• Total bandwidth for streams specified by TrackingID

• Series bandwidth for streams specified by TrackingID

GraphQL APIs

Features

The GraphQL API StreamView operation now includes the trackingID field.

2022-10-31

REST APIs

Features

Introduced the stream_stopstream and stream_stopbyaccount REST APIs to stop an active stream, or stop all active streams associated with the account. This allows users to stop a stream that is published to moderate their content.