API Documentation

API Documentation / Wiki

The following pages provide an overview about all functions of the API (Application Programming Interface) of the hyper Content & Digital Asset Management Server.
Please note, that you might usually only require few functions for the development of Plugins, template functions like navigation, sitemap and so on. Please read the Template Designers Guide and Programers Guide for a better insight.
The API is primarily used for the implementation of standalone applications that leverage the capabilities of the hyper Content & Digital Asset Management Server. The API is not to be confused with the OpenAPI, which is based on a SOA (Service Oriented Architecture), and is not part of the Free Edition.

For Questions & Answers please visit the Google Group.

hyperCMS API Function Reference

  1. Main API Functions
  2. Get API Functions
  3. Set API Functions
  4. Connect API Functions
  5. Security API Functions
  6. Media API Functions
  7. Metadata API Functions
  8. Link API Functions
  9. Plugin API Functions
  10. User Interface API Functions
  11. Template Engine API Functions
  12. XML API Functions
  13. Report API Functions
  14. Project API Functions
  15. Task API Functions
  16. Workflow API Functions
  17. Cloud Storage API Functions
  18. Import/Export API Functions

Cloud Storage API Functions

loadcloudobject


Description
This functions load/streams an object/file from the cloud storage and saves it the local media repository on request

Syntax
loadcloudobject ($site, $location, $file, $user="", $save=true, $directoutput=false)

Input parameters
  • $site ... publication name [string]
  • $location ... media file location [string]
  • $file ... media file name [string]
  • $user ... user name [string] (optional)
  • $save ... save file in local media repository or return content as result [true, false] (optional)
  • $directoutput ... direct output of the streamed content [true, false] (optional)

global input parameters
  • $mgmt_config

Output
  • data / false on error


savecloudobject


Description
This function saves an object/file in the cloud storage if no daily cloud snyc has been defined, see main configuration setting $mgmt_config['storage_dailycloudsnyc'].
The file must have a valid container ID identifier in the file name.

Syntax
savecloudobject ($site, $location, $file, $user="")

Input parameters
  • $site ... publication name [string]
  • $location ... media file location [string]
  • $file ... media file name [string]
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false on error


copycloudobject


Description
This functions renames an object/file in the cloud storage

Syntax
copycloudobject ($site, $location, $file_old, $file_new, $user="")

Input parameters
  • $site ... publication name [string]
  • $location ... media file location [string]
  • $file_old ... source media file name [string]
  • $file_new ... destination media file name [string]
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false on error


renamecloudobject


Description
This functions renames an object/file in the cloud storage

Syntax
renamecloudobject ($site, $location, $file_old, $file_new, $user="")

Input parameters
  • $site ... publication name [string]
  • $location ... media file location [string]
  • $file_old ... old media file name [string]
  • $file_new ... new media file name [string]
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false on error


deletecloudobject


Description
This function deletes an object/file and its data from the cloud storage

Syntax
deletecloudobject ($site, $location, $file, $user="")

Input parameters
  • $site ... publication name [string]
  • $location ... media file location [string]
  • $file ... media file name [string]
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false on error


synccloudobjects


Description
This function snychronizes all local objects/files with the cloud storage.
See also main configuration settings $mgmt_config['storage_dailycloudsnyc'] and $mgmt_config['storage_type'].

Syntax
synccloudobjects ($user="")

Input parameters
  • $user ... user name [string] (optional)

global input parameters
  • $mgmt_config

Output
  • true / false on error


GCanalyzevideo


Description
Analyzes a video and finds labels, based on Google Video Intelligence.

Syntax
GCanalyzevideo ($site, $path)

Input parameters
  • $site ... publication name [string]
  • $path ... path or URI to a video file [string]

global input parameters
  • $mgmt_config

Output
  • result array / false on error


GCanalyzeimage


Description
Analyzes an image and finds labels, based on Google Vision.

Syntax
GCanalyzeimage ($site, $path)

Input parameters
  • $site ... publication name [string]
  • $path ... path or URI to a video file [string]

global input parameters
  • $mgmt_config

Output
  • result array / false on error


GCspeech2text


Description
Analyzes a video or audio and extracts the text from the audio stream, based on Google Cloud Speech.
Google Speech supports the following language codes:
af-ZA, am-ET, hy-AM, az-AZ, id-ID, ms-MY, bn-BD, bn-IN, ca-ES, cs-CZ, da-DK, de-DE, en-AU, en-CA, en-GH, en-GB, en-IN, en-IE, en-KE, en-NZ, en-NG, en-PH, en-ZA, en-TZ, en-US,
es-AR, es-BO, es-CL, es-CO, es-CR, es-EC, es-SV, es-ES, es-US, es-GT, es-HN, es-MX, es-NI, es-PA, es-PY, es-PE, es-PR, es-DO, es-UY, es-VE, eu-ES, fil-PH, fr-CA, fr-FR, gl-ES, ka-GE, gu-IN,
hr-HR, zu-ZA, is-IS, it-IT, jv-ID, kn-IN, km-KH, lo-LA, lv-LV, lt-LT, hu-HU, ml-IN, mr-IN, nl-NL, ne-NP, nb-NO, pl-PL, pt-BR, pt-PT, ro-RO, si-LK, sk-SK, sl-SI, su-ID, sw-TZ, sw-KE, fi-FI, sv-SE,
ta-IN, ta-SG, ta-LK, ta-MY, te-IN, vi-VN, tr-TR, ur-PK, ur-IN, el-GR, bg-BG, ru-RU, sr-RS, uk-UA, he-IL, ar-IL,
ar-JO, ar-AE, ar-BH, ar-DZ, ar-SA, ar-IQ, ar-KW, ar-MA, ar-TN, ar-OM, ar-PS, ar-QA, ar-LB, ar-EG, fa-IR, hi-IN, th-TH, ko-KR, cmn-Hant-TW, yue-Hant-HK, ja-JP, cmn-Hans-HK, cmn-Hans-CN

Syntax
GCspeech2text ($site, $path, $langcode="en-US")

Input parameters
  • $site ... publication name [string]
  • $path ... path or URI to a video file [string]
  • $langcode ... language code [string] (optional)

global input parameters
  • $mgmt_config
  • $mgmt_imagepreview
  • $mgmt_mediapreview
  • $mgmt_mediaoptions
  • $mgmt_imageoptions
  • $mgmt_maxsizepreview
  • $mgmt_mediametadata
  • $mgmt_compress
  • $hcms_ext

Output
  • result array / false on error


This website uses cookies to ensure you get the best experience on our website. More info