Source Previews

Get Source Preview Stream

Gets the information required for the Low Latency Preview Player to enable playback.

'PUT /v2/{org}/sources/{source-id}/preview' SHOULD be called prior to ensure that the necessary Source Preview resources have been created. Otherwise, the Source Preview Stream will not be available and this API route will never succeed.

get/v2/{org}/sources/{source-id}/preview/stream

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/sources/{source-id}/preview/stream
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Path parameters

orgstring required

Organization name

source-idstring required

Unique source identifier

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

default_urlstring

default_url contains the default URL that can be used to start playback. Ex: https://example.com/cluster/org/isp/ext_id/foo/play?vid_id=2&aud_id=6 The vid_id and aud_id can be changed utilizing the ones provided by the 'audio_tracks' and 'video_tracks' fields to see different combinations.

tokenstring

JWT Bearer token that shall be supplied with a 'pre-flight' to myriapod.js to send the auth token to the server.

Example response

{
  "$schema": "https://api.istreamplanet.com/schemas/GetSourcePreviewStreamResponseBody.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.