媒體集要求

上次更新: 2023-11-04
  • 建立對象:
  • Developer
    User

「影像伺服」提供一種機制,用於擷取階層文字回應(xml或json),該回應代表與特定記錄的catalog::ImageSet相關聯的所有資源和中繼資料。

檢視者可以使用此機制產生回應,以告知簡報簡單影像、影片、影片集、色票集、迴轉集、頁面集(e-catalog)和媒體集。

要求語法

設定的回應 catalog::ImageSet 可透過以下方式擷取: req=set 修飾元並參照網路路徑中的目錄記錄id。 或者,您也可以使用直接在URL中指定影像集 imageset= 修飾元。 如果 imageset= 修飾元可用來指定影像集,整個值應以大括弧括住,以便逸出影像集值,並確保任何包含的修飾元不會解譯為URL查詢字串的一部分。

集合回應的型別

設定機制支援下列型別的回應:

簡單影像

影像記錄,但不包含 catalog::ImageSet 已定義。

簡單影片

靜態內容目錄中的視訊記錄。

色票集

一組專案,包含影像記錄的參照和作為色票使用的影像記錄的選擇性個別參照。

階層式色票集

一組專案,包含基本色票專案或色票集記錄的參照。

迴轉集

由影像ID的簡單清單組成的一組專案。

二維迴轉集

由簡單影像或基本迴轉集參照組成的一組專案。

頁面集

一組專案,包含最多三個頁面影像的清單

媒體集

一組專案,包含簡單影像、視訊集、色票集、階層式色票集、迴轉集、二維迴轉集、頁面集和視訊資產。 每個媒體集專案也可以包含選用的色票。

視訊集

由簡單影片清單組成的一組專案。

外部集合型別偵測

req=set 收到要求,要產生的回應型別由的值決定 catalog::AssetType. 如果 catalog::AssetType 未定義,則回應型別由以下規則決定:

  • 如果在影像目錄中找到記錄,並且 catalog::ImageSet 已定義

    • 如果記錄影像集欄位中至少有一個專案包含冒號,則假設電子目錄集
    • 如果記錄影像集欄位中至少有一個專案包含兩個分號,則假設媒體已設定。
    • 如果記錄影像集欄位中至少有一個專案包含一個分號,則假設影像集。
    • 如果沒有任何專案包含冒號或分號,但至少有一個專案包含參考集或內嵌集(這是2D迴轉集),請假設迴轉集。
    • 如果沒有專案包含冒號、分號、參照集合或內嵌集合(亦即以逗號分隔的影像清單),則假設為未知集合。
  • 如果在影像和靜態內容目錄中都能找到記錄

    • 如果檔案副檔名為下列集,則假設視訊: mp3、mp4、flv、f4v、swf、xml
    • 否則,假設影像
  • 如果在靜態內容目錄中找到記錄,但未在影像目錄中找到

    • 如果檔案副檔名為下列集,則假設視訊: mp3、mp4、flv、f4v、swf、xml
    • 假設為靜態,否則
  • 如果在影像目錄中找到記錄但未在靜態內容目錄中找到

    • 假設影像
  • 如果在影像目錄中找不到記錄,且在靜態內容目錄中找不到

    • 如果檔案副檔名是以下組合,則假設使用檔案式視訊: mp3、mp4、flv、f4v、swf、xml
    • 否則採用檔案型影像

在所有情況下,產生的xml回應會符合指定的XML檔案,且設定根節點會對應偵測到的型別。

內部集合型別偵測

當偵測到外部集為型別媒體集時,回應會包含一組媒體集專案,這些專案會與中的每個媒體集專案相對應。 catalog::ImageSet. 如果為特定媒體集專案指定了可選的型別引數,則會根據下表將其對應至輸出型別:

輸入類型 輸出型別
img img
basic img
advanced_image img
img_set img_set
advanced_image_set img_set
advanced_swatchset img_set
spin spin
video video
video_set video_set
static static
ecat ecat

如果未指定特定媒體集專案的選擇性型別引數,或該引數對應至不支援的型別,則會使用與套用至外部集層級的規則相同的規則來自動偵測媒體集專案型別。

XML規格

傳回的xml回應符合以下規格:

http://crc.scene7.com/is-docs/examples/mediaset.dtd

標籤索引鍵

labelkey= 修飾元會與 catalog::UserData產生影像和色票標籤的欄位。 此 catalog:UserData 欄位會剖析為一組索引鍵/值組,而此組中的標籤索引鍵會擷取給定索引鍵的值。 此值隨後會傳回至 l 屬性 si.

強制的限制

為了限制回應大小並防止自我參照問題,最大巢狀深度是由伺服器屬性所控制 PS::fvctx.nestingLimit. 如果超過此限制,則會傳回錯誤。

為了限制大型e-catalog集的xml回應大小,會根據伺服器屬性抑制手冊集專案的私人中繼資料 PS::fvctx.brochureLimit. 會匯出與手冊相關的所有私人中繼資料,直到達到手冊限製為止。 超過限制後,會隱藏私人地圖和使用者資料,並設定對應的旗標,以指出隱藏的資料型別。

不支援巢狀媒體集。 巢狀媒體集定義為包含型別媒體集的媒體集專案的媒體集。 如果偵測到這種情況,則會傳回錯誤。

範例

針對以下專案的XML回應範例: req=set 如需詳細資訊,請參閱HTML範例標題下的屬性頁面。

http://crc.scene7.com/is-docs/examples/properties.htm

另請參閱

需要=影像集=catalog::ImageSet影像目錄參考

此頁面上的