Modify the metadata of ingested media

Modified on Mon, 07 Aug 2023 at 12:40 PM


Change history: Initial version     08-23-2022         Initial version

Case study :

  • Modifying metadata for media imported from third-party storage
    • AWS S3
    • Azure Blob storage
    • Others ... 



  • Modify metadata without using the Okast Channels administration interface

  • Automate metadata modification for media stored on the instance 




Webservice operation diagram.


1) Limitations :

  • Must be an Okast client.
  • One Okast channels instance + credentials.
  • One call per owned instance.




2) Usage syntax for _updateMetadata

The call URL is >.

http://<URL_de_mon_instance>/playlist/manager/php/_updateMetadata.php


Parameters

ParameterFormatsDescriptionMandatory
filePathURLHTTPS link to the remote media file (.MP4) to be imported and ingestedYes
metadataPatchURLHTTPS link to the remote metadata file (.JSON) to be imported and processedYes


Example

https://okast.easytools.tv/synthesia/okast-channels/playlist/manager/php/_updateMetadata.php?
filePath=http%3A%2F%2Fmydomain.fr%2Fmedias%2FBigBuckBunny-1080p.mp4
&metadataPath=http%3A%2F%2Fmydomain.fr%2Fmetadata%2FBigBuckBunny-1080p-metadata-updated.json


Structure de métadonnée .JSON > PDF en bas de l'article


Metadata JSON exemple

[
   {
      "tag":"1997-01193_136_22640187",
      "title":"Media title",
      "subtitle":"Media subtitle",
      "description":"Media description, write here the full description of the media",
      "season":0,
      "episode":136,
      "category":"COMEDY",
      "host":"",
      "hostFunction":"",
      "host2":"",
      "host2Function":"",
      "host3":"",
      "host3Function":"",
      "showName":"Write the Show Name",
      "dateDay":1,
      "dateMonth":1,
      "dateYear":1994,
      "imageLink":"",
      "country":"France",
      "classification":"Tout public",
      "isrc":"",
      "isan":"",
      "plurimedia":"",
      "internal":null,
      "internalRef":"",
      "comments":"Write here comment on yout media",
      "hasOverlay":1,
      "oeCategory":"",
      "keywords":"A0000000",
      "siteUrl":"",
      "qrUrl":"",
      "qrTitle":"",
      "qrDescription":"",
      "qrInvite":"",
      "validityFromDay":9,
      "validityFromMonth":8,
      "validityFromYear":2022,
      "validityFromHour":14,
      "validityFromMinute":26,
      "validityToDay":9,
      "validityToMonth":11,
      "validityToYear":2022,
      "validityToHour":14,
      "validityToMinute":26
   }
]