{"id":1913,"date":"2014-12-15T11:09:45","date_gmt":"2014-12-15T11:09:45","guid":{"rendered":"http:\/\/evolphin.com\/help\/?p=1913"},"modified":"2020-08-04T10:08:56","modified_gmt":"2020-08-04T14:08:56","slug":"zoom-preview-server-api","status":"publish","type":"post","link":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/","title":{"rendered":"Zoom Preview Server API"},"content":{"rendered":"\n

This section covers the API invocations related to previews<\/span> and thumbnails<\/span> in Zoom.<\/p>\n\n\n\n

All JSON responses contain these standard fields:<\/p>\n\n\n\n

\u201csuccess\u201d : \u201ctrue|false\u201d<\/div>\n\n\n\n
\u201cerrorInfo\u201d : \u201c<Error msg if success is false, else this element will not be present>\u201d<\/div>\n\n\n\n
\u201cerrorCode\u201d: A key that exists in the Zoom message catalog<\/div>\n\n\n\n

Get Preview or Thumbnail<\/h2>\n\n\n\n

Description:
<\/strong>Get thumbnail or preview associated with an asset version.<\/p>\n\n\n\n

Request URL:
<\/strong>http:\/\/192.168.1.6:8873\/review\/preview\/assetPreview<\/span><\/p>\n\n\n\n

If param “resolution” is absent or is set to 0, then the request just fetches a small thumbnail; otherwise, it fetches the preview at the specified resolution.If you specify the resolution as -1, it will return a copy of the original asset.<\/p>\n\n\n\n

Sample URL with url encoded query string parameters:<\/p>\n\n\n\n

http:\/\/192.168.1.6:8873\/review\/preview\/assetPreview?bid=1&fuid=104&rrn=530&frn=2&aspectRatio=true&fqName=%2FShared-Project%2FCocaCola%2FBarbasol.jpg<\/div>\n\n\n\n

Request parameters to get thumbnail:<\/strong><\/p>\n\n\n\n

\n

“bid” : int<\/p>\n

“fuid” : int<\/p>\n

“rrn” : long<\/p>\n

“frn” : int<\/p>\n

fqPath:String<\/p>\n<\/div>\n\n\n\n

Using Ls command or other Zoom commands, or using the Find Web API, the above parameters can be fetched for an asset.<\/p>\n\n\n\n

Response:<\/strong><\/p>\n\n\n\n

\n

<Streamed thumbnail><\/p>\n<\/div>\n\n\n\n

Request parameters to get preview:<\/strong><\/p>\n\n\n\n

\n

“bid” : int<\/p>\n

“fuid” : int<\/p>\n

“rrn” : long<\/p>\n

“resolution” : int \/\/ requested resolution minimum (height, width), aspect ratio automatically maintained<\/p>\n

\u201caspectRatio\u201d:\u201dtrue\u201d|\u201dfalse\u201d<\/p>\n

“fqPath” : String<\/p>\n

\u201cfilename\u201d:String \/\/ base file name<\/p>\n<\/div>\n\n\n\n

Response<\/strong>:<\/p>\n\n\n\n

\n

<Streamed preview><\/p>\n

or<\/p>\n

HTTP error code 404 if failed to create preview<\/p>\n

or<\/p>\n

HTTP error code 449 to retry if resources are unavailable.<\/p>\n<\/div>\n\n\n\n

Generate Default Preview<\/h2>\n\n\n\n

It is possible to trigger default preview generation for some assets on Preview server. For video assets only FLV file format is supported and for images only JPEG file format is supported.<\/p>\n\n\n\n

The follow URL can be used to trigger the preview generation:<\/p>\n\n\n\n

\nhttp:\/\/<YOUR-PREVIEW-SERVER>:8873\/review\/preview\/assetPreview\n<\/div><\/figure>\n\n\n\n

To trigger the default preview generation for video files, following parameters has to be passed to above URL<\/p>\n\n\n\n

  1. zm_server <\/strong>= http:\/\/<YOUR-ZOOM-SERVER>:8880<\/code><\/li>
  2. zm_username <\/strong>= <USER NAME><\/code><\/li>
  3. zm_password <\/strong>= <USER PASSWORD><\/code><\/li>
  4. bid <\/strong>= <\/strong>1 <\/code>\n
      \n
    1. Default is 1.<\/code><\/li>\n<\/ol>\n<\/li>
    2. fuid <\/strong>= 227 (Asset id of which preview generation needs to be triggered)<\/code><\/li>
    3. rrn <\/strong>= 197 (Repository Revision Number aka RRN. Revision number on which asset has changed)<\/code><\/li>
    4. aspectRatio = true<\/code><\/li>
    5. resolution <\/strong>= <\/em>480 (Default preview generation resolution.)<\/code>\n
        \n
      1. This value must be same as the value specified in “Preview\/Review Server Settings” in Zoom web management console.<\/li>\n<\/ol>\n<\/li>
      2. fqName <\/strong>= <Full path to Asset on Zoom server><\/code>\n
          \n
        1. \/defproj\/acme\/video\/cartoon.mp4<\/em><\/li>\n<\/ol>\n<\/li>
        2. fileType = FLV<\/code><\/li><\/ol>\n\n\n\n

          For e.g: To trigger the preview generation for asset: “\/defproj\/acme\/video\/cartoon.mp4” with id 304 at RRN: 10, following url has to be created:<\/p>\n\n\n\n

          http:\/\/192.168.0.144:8873\/review\/preview\/assetPreview?
          \n<\/em>zm_server<\/strong>=http:\/\/192.168.0.144:8880&
          \nzm_username<\/strong>=admin&<\/em>
          \nzm_password<\/strong>=admin&<\/em>
          \nbid<\/strong>=1&<\/em>
          \nfuid<\/strong>=304&<\/em>
          \nrrn<\/strong>=10&<\/em>
          \naspectRatio=true<\/strong>&<\/em>
          \nresolution=480<\/strong>&<\/em>
          \nfqName<\/strong>=\/defproj\/acme\/video\/cartoon.mp4&<\/em>
          \nfileType=FLV<\/strong><\/code><\/p>\n\n\n\n

          Response on the above URL is the actual FLV file, streamed using HTTP protocol. Above request will block till<\/strong> the preview is generated. If you just want to trigger the preview generation, then set some lower value timeout, so that connection is break after triggering the call.<\/p>\n","protected":false},"excerpt":{"rendered":"

          This section covers the API invocations related to previews and thumbnails in Zoom. All JSON responses contain these standard fields: \u201csuccess\u201d : \u201ctrue|false\u201d \u201cerrorInfo\u201d : \u201c<Error msg if success is false, else this element will not be present>\u201d \u201cerrorCode\u201d: A key that exists in the Zoom message catalog Get Preview or Thumbnail Description:Get thumbnail or preview associated […]<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"default","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","ast-disable-related-posts":"","theme-transparent-header-meta":"default","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[30,92],"tags":[],"class_list":["post-1913","post","type-post","status-publish","format-standard","hentry","category-api","category-preview"],"yoast_head":"\nZoom Preview Server API - Evolphin Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Zoom Preview Server API - Evolphin Documentation\" \/>\n<meta property=\"og:description\" content=\"This section covers the API invocations related to previews and thumbnails in Zoom. All JSON responses contain these standard fields: \u201csuccess\u201d : \u201ctrue|false\u201d \u201cerrorInfo\u201d : \u201c<Error msg if success is false, else this element will not be present>\u201d \u201cerrorCode\u201d: A key that exists in the Zoom message catalog Get Preview or Thumbnail Description:Get thumbnail or preview associated […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/\" \/>\n<meta property=\"og:site_name\" content=\"Evolphin Documentation\" \/>\n<meta property=\"article:published_time\" content=\"2014-12-15T11:09:45+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2020-08-04T14:08:56+00:00\" \/>\n<meta name=\"author\" content=\"Rahul Bhargava\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Rahul Bhargava\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/\"},\"author\":{\"name\":\"Rahul Bhargava\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/person\\\/e5f3dc53ac5f026ed258e224e75447f7\"},\"headline\":\"Zoom Preview Server API\",\"datePublished\":\"2014-12-15T11:09:45+00:00\",\"dateModified\":\"2020-08-04T14:08:56+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/\"},\"wordCount\":413,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#organization\"},\"articleSection\":[\"API and Scripting\",\"Preview Server\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/\",\"name\":\"Zoom Preview Server API - Evolphin Documentation\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#website\"},\"datePublished\":\"2014-12-15T11:09:45+00:00\",\"dateModified\":\"2020-08-04T14:08:56+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/api\\\/zoom-preview-server-api\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\\\/\\\/evolphin.com\\\/help\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Zoom Preview Server API\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#website\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/\",\"name\":\"Evolphin Documentation\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/evolphin.com\\\/help\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#organization\",\"name\":\"Evolphin Documentation\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/logo\\\/image\\\/\",\"url\":\"https:\\\/\\\/evolphin.com\\\/help\\\/wp-content\\\/uploads\\\/2020\\\/04\\\/cropped-evolphin-logo-dolphin_sm.png\",\"contentUrl\":\"https:\\\/\\\/evolphin.com\\\/help\\\/wp-content\\\/uploads\\\/2020\\\/04\\\/cropped-evolphin-logo-dolphin_sm.png\",\"width\":200,\"height\":200,\"caption\":\"Evolphin Documentation\"},\"image\":{\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/logo\\\/image\\\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\\\/\\\/evolphin.com\\\/help\\\/#\\\/schema\\\/person\\\/e5f3dc53ac5f026ed258e224e75447f7\",\"name\":\"Rahul Bhargava\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g\",\"url\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g\",\"contentUrl\":\"https:\\\/\\\/secure.gravatar.com\\\/avatar\\\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g\",\"caption\":\"Rahul Bhargava\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Zoom Preview Server API - Evolphin Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/","og_locale":"en_US","og_type":"article","og_title":"Zoom Preview Server API - Evolphin Documentation","og_description":"This section covers the API invocations related to previews and thumbnails in Zoom. All JSON responses contain these standard fields: \u201csuccess\u201d : \u201ctrue|false\u201d \u201cerrorInfo\u201d : \u201c<Error msg if success is false, else this element will not be present>\u201d \u201cerrorCode\u201d: A key that exists in the Zoom message catalog Get Preview or Thumbnail Description:Get thumbnail or preview associated […]","og_url":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/","og_site_name":"Evolphin Documentation","article_published_time":"2014-12-15T11:09:45+00:00","article_modified_time":"2020-08-04T14:08:56+00:00","author":"Rahul Bhargava","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Rahul Bhargava","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/#article","isPartOf":{"@id":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/"},"author":{"name":"Rahul Bhargava","@id":"https:\/\/evolphin.com\/help\/#\/schema\/person\/e5f3dc53ac5f026ed258e224e75447f7"},"headline":"Zoom Preview Server API","datePublished":"2014-12-15T11:09:45+00:00","dateModified":"2020-08-04T14:08:56+00:00","mainEntityOfPage":{"@id":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/"},"wordCount":413,"commentCount":0,"publisher":{"@id":"https:\/\/evolphin.com\/help\/#organization"},"articleSection":["API and Scripting","Preview Server"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/","url":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/","name":"Zoom Preview Server API - Evolphin Documentation","isPartOf":{"@id":"https:\/\/evolphin.com\/help\/#website"},"datePublished":"2014-12-15T11:09:45+00:00","dateModified":"2020-08-04T14:08:56+00:00","breadcrumb":{"@id":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/evolphin.com\/help\/api\/zoom-preview-server-api\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/evolphin.com\/help\/"},{"@type":"ListItem","position":2,"name":"Zoom Preview Server API"}]},{"@type":"WebSite","@id":"https:\/\/evolphin.com\/help\/#website","url":"https:\/\/evolphin.com\/help\/","name":"Evolphin Documentation","description":"","publisher":{"@id":"https:\/\/evolphin.com\/help\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/evolphin.com\/help\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/evolphin.com\/help\/#organization","name":"Evolphin Documentation","url":"https:\/\/evolphin.com\/help\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/evolphin.com\/help\/#\/schema\/logo\/image\/","url":"https:\/\/evolphin.com\/help\/wp-content\/uploads\/2020\/04\/cropped-evolphin-logo-dolphin_sm.png","contentUrl":"https:\/\/evolphin.com\/help\/wp-content\/uploads\/2020\/04\/cropped-evolphin-logo-dolphin_sm.png","width":200,"height":200,"caption":"Evolphin Documentation"},"image":{"@id":"https:\/\/evolphin.com\/help\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/evolphin.com\/help\/#\/schema\/person\/e5f3dc53ac5f026ed258e224e75447f7","name":"Rahul Bhargava","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/secure.gravatar.com\/avatar\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g","url":"https:\/\/secure.gravatar.com\/avatar\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/952acf4ec94a228ca32ed9b65cee4cc97a33509ea04500e768b71da346e58971?s=96&d=mm&r=g","caption":"Rahul Bhargava"}}]}},"_links":{"self":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts\/1913","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/comments?post=1913"}],"version-history":[{"count":2,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts\/1913\/revisions"}],"predecessor-version":[{"id":15503,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/posts\/1913\/revisions\/15503"}],"wp:attachment":[{"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/media?parent=1913"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/categories?post=1913"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/evolphin.com\/help\/wp-json\/wp\/v2\/tags?post=1913"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}