API Reference

Get default playback for session streaming/recording

Get default playback details for the session associated with the event.

Using this API you can get playback details like playBackId, assetId, playBackRestrictionToken, thumbnailRestrictionToken, duration for streaming/recording any session.

To call this API, you need to pass eventurl and id as path parameters.

This API can be used by authenticated users only, and it will require super admin/event admin/event staff level access.

Here is the description of response attributes, which returns to the form of JSON.

AttributesDescription
assetId Asset id for mux
createdAt Creation date of asset
createdBy Created By User ID
defaultPlayback Is current playback is default selected, it will return true else false.
duration Duration of playback asset
fileName File name for download playback session.
id Unique ID for playback session.
playBackId Playback ID for streaming
playBackRestrictionToken It's contains playback restriction token, which is allows you to set additional rules for playing videos. For instance, viewers can play videos embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any Video requests from other websites are denied.
signed Check whether stream playback signed with playback validation or not.
thumbnailRestrictionToken It's contains playback restriction token, which is allows you to set additional rules for thumbnails. For instance, viewers can view thumbnails embedded on the https://example.com website when you set the Playback Restrictions with example.com as an allowed domain. Any thumbnails request from other websites are denied.

Here is the possible error messages, which return if any condition gets failed or required data is missing for processing.

Error CodeError Description
400The request could not be understood by the server due to malformed syntax.
401You are not authorized to view the resource.
403Accessing the resource you were trying to reach is forbidden.
404The resource you were trying to reach is not found.
Language
Credentials
Header
Click Try It! to start a request and see the response here!