Client APIs
At its core, SyncTV is an API driven service. The APIs themselves are easy enough for developers to understand, but understanding the ecosystem is a little trickier. We've created the following tutorials to help you get your head around it.

Topics:

  • Dash manifests

This document describes the API for dash_manifests.

Note:
Each call to the SyncTV V2 API described in this section requires an MD5 hash signature.
See the Authorization (User) API for details on generating the MD5 hash signature.
Actions

Url:

  • [GET] /api/v2/media/:medium_id/dash_manifests.[xml|json]

Returns a list of media dash_manifests scoped to the user's current platform.

Required Arguments:
  • (Integer) access_id
    Access id returned from Authorization (User) client_authorize.
  • (String) signature
    MD5 hash encoded string of alphabetically sorted query parameters.
Example Request

The following example returns all dash_manifests for media 100.
[GET] https://service_name.synctv.com/api/v2/media/100/dash_manifests.xml?ownership_id=1&access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Integer) offset — Used for pagination of response data (default: 25 items per response). Specifies the offset of the next block of data to receive.
  • (Integer) ownership_id — The ID of the Ownership that is being used to validate access to the dash_manifests. (Note: required if media belongs to a bundle).
Example Response
XML JSON

<response>
  <dash_manifests>
    <dash_manifest>
      <id>1</id>
      <ingest_id>1</ingest_id>
      <file_size nil="true"/>
      <file_path>filepath/manifest/dash/file_1.ismc</file_path>
      <protected>true</protected>
      <file_url>http://smooth.mytf1vod.fr/ondemand/filepath/manifest/dash/file_1.ismc</file_url>
      <asset_size>0</asset_size>
      <av_format_set_id nil="true"/>
      <iteration>0</iteration>
      <remove_on nil="true"/>
      <marked_for_deletion>false</marked_for_deletion>
      <hd>false</hd>
      <resolution>sd</resolution>
      <license nil="true"/>
      <audio_languages/>
    </dash_manifest>
    <dash_manifest>
      <id>2</id>
      <ingest_id>2</ingest_id>
      <file_size nil="true"/>
      <file_path>filepath/manifest/dash/file_2.ismc</file_path>
      <protected>true</protected>
      <file_url>http://smooth.mytf1vod.fr/ondemand/filepath/manifest/dash/file_2.ismc</file_url>
      <asset_size>0</asset_size>
      <av_format_set_id nil="true"/>
      <iteration>0</iteration>
      <remove_on nil="true"/>
      <marked_for_deletion>false</marked_for_deletion>
      <hd>false</hd>
      <resolution>sd</resolution>
      <license nil="true"/>
      <audio_languages/>
    </dash_manifest>
  </dash_manifests>
</response>
Response Fields:
  • (Response) dash_manifests
    A list of dash_manifest items for the specified media. If a HMS license could be acquired for a manifest the contained license key attributes will indicate whether the license could be acquired or if an error occured. License status codes: code 0 (CREATED) A license instance was created but a background task to acquire a license has not been scheduled. code 1 (SCHEDULED) A new license is currently being acquired. code 2 (COMPLETED) The license was acquired and is referenced as token. code -2 (FAILED) A license could not be acquired and an error message is returned in error.