Admin 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:

  • Mp4 encode

This document describes the API for reading mp4_encodes.

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/mp4_encodes.[xml|json]

Returns a list of media mp4_encodes. By default they are scoped to the user's current platform.

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

The following example returns all mp4_encodes for media 100.
[GET] https://service_name.synctv.com/api/v2/media/100/mp4_encodes.xml?ownership_id=1&access_id=1234&signature=674aaff974348eb1a1bdd72dce75053d
Request Field:
  • (Integer) ownership_id — Ownership ID under which a client trys to aquire mp4_encodes.
  • (Integer) offset — Used for pagination of response data (default: 25 items per response). Specifies the offset of the next block of data to receive.
Example Response
XML JSON

<response>
  <mp4_encodes>
    <mp4_encode>
      <id>1</id>
      <ingest_id>1</ingest_id>
      <av_format_id>1</av_format_id>
      <file_size nil="true"/>
      <file_path>filepath/web/encode/file_1.mp4</file_path>
      <audio_languages>
        <audio_language>eng</audio_language>
        <audio_language>fre</audio_language>
      </audio_languages>
      <protected>false</protected>
      <bitrate>1792100</bitrate>
      <file_url>http://smooth.mytf1vod.fr/ondemand/filepath/web/encode/file_1.mp4</file_url>
      <iteration>0</iteration>
      <remove_on nil="true"/>
      <marked_for_deletion>false</marked_for_deletion>
    </mp4_encode>
    <mp4_encode>
      <id>2</id>
      <ingest_id>2</ingest_id>
      <av_format_id>2</av_format_id>
      <file_size nil="true"/>
      <file_path>filepath/web/encode/file_2.mp4</file_path>
      <audio_languages>
        <audio_language>eng</audio_language>
        <audio_language>fre</audio_language>
      </audio_languages>
      <protected>false</protected>
      <bitrate>1792100</bitrate>
      <file_url>http://smooth.mytf1vod.fr/ondemand/filepath/web/encode/file_2.mp4</file_url>
      <iteration>0</iteration>
      <remove_on nil="true"/>
      <marked_for_deletion>false</marked_for_deletion>
    </mp4_encode>
  </mp4_encodes>
</response>
Response Fields:
  • (Response) mp4_encodes
    A list of mp4_encode items for the specified media. See below for a description of the mp4_encode response fields.