Requêtes de visionneuse de médias

La diffusion d’images fournit un mécanisme permettant de récupérer une réponse de texte hiérarchique (xml ou json) qui représente toutes les ressources et métadonnées associées à catalog::ImageSet pour un enregistrement particulier.

Les utilisateurs peuvent utiliser ce mécanisme pour générer des réponses afin d’informer la présentation d’images, de vidéos, de visionneuses de vidéos, de séries d’échantillons, de visionneuses à 360°, de visionneuses de pages (catalogues électroniques) et de visionneuses de supports simples.

Syntaxe de requête

La réponse définie pour un catalog::ImageSet peut être récupérée à l'aide du modificateur req=set et en référençant l'ID d'enregistrement du catalogue dans le chemin d'accès réseau. Vous pouvez également spécifier directement la visionneuse d’images dans l’URL à l’aide du modificateur imageset=. Si le modificateur imageset= est utilisé pour spécifier la visionneuse d’images, la valeur entière doit être entourée d’accolades afin d’échapper à la valeur de la visionneuse d’images et de s’assurer que les modificateurs inclus ne sont pas interprétés comme faisant partie de la chaîne de requête d’URL.

Types de réponses définies

Le mécanisme d'ensemble prend en charge les types de réponses suivants :

images simples	Un enregistrement d'image sans catalog::ImageSet défini.
vidéos simples	Enregistrement vidéo dans le catalogue de contenu statique.
séries d’échantillons	Ensemble d’éléments constitué d’une référence à un enregistrement d’image et d’une référence distincte facultative à un enregistrement d’image utilisé comme échantillon.
jeux d’échantillons hiérarchiques	Ensemble d’éléments constitué d’un élément d’échantillon de base ou d’une référence à un enregistrement d’ensemble d’échantillons.
visionneuses à 360	Ensemble d’éléments constitué d’une simple liste d’ID d’image.
visionneuses à 360° bidimensionnelles	Ensemble d’éléments constitué d’une simple image ou d’une référence à une visionneuse à 360° de base.
jeux de pages	Ensemble d’éléments constitué d’une liste d’images de trois pages au maximum
visionneuses de supports	Ensemble d’éléments comprenant des images simples, des visionneuses de vidéos, des séries d’échantillons, des séries d’échantillons hiérarchiques, des visionneuses à 360°, des visionneuses à 360° bidimensionnelles, des visionneuses de pages et des fichiers vidéo. Chaque élément de visionneuse de supports peut également contenir une nuance facultative.
visionneuses de vidéos	Ensemble d’éléments constitué d’une liste de vidéos simples.

Détection du type d'ensemble externe

Lorsqu'une demande req=set est reçue, le type de réponse à générer est déterminé par la valeur de catalog::AssetType. Si catalog::AssetType n'est pas défini, le type de réponse est déterminé par les règles suivantes :

Si l'enregistrement se trouve dans le catalogue d'images ET catalog::ImageSet est défini
- Supposons qu’un jeu de catalogues électroniques soit défini si au moins une entrée du champ Imageset d’enregistrement contient un deux-points
- Supposons que le jeu de médias comporte au moins une entrée dans le champ Imageset de l’enregistrement contenant deux points-virgules.
- Supposons que la visionneuse d’images comporte au moins une entrée dans le champ Imageset de l’enregistrement contenant un point-virgule.
- Supposons qu’une visionneuse à 360° ne contienne pas de point-virgule ou de point-virgule, mais qu’au moins une entrée contienne une visionneuse à 360° référencée ou une visionneuse en ligne (il s’agit d’une visionneuse à 360° 2D).
- Supposons qu’un ensemble soit inconnu si aucune entrée ne contient deux points, un point-virgule ou un ensemble référencé ou un ensemble en ligne (c’est-à-dire une liste d’images séparée par des virgules).
Si l’enregistrement est détecté dans les catalogues d’images ET de contenu statique
- Supposons que l’extension de fichier se trouve dans l’ensemble suivant : mp3, mp4, flv, f4v, swf, xml
- Hypothèse de l'image autrement
Si l'enregistrement se trouve dans le catalogue de contenu statique mais PAS dans le catalogue d'images
- Supposons que l’extension de fichier se trouve dans l’ensemble suivant : mp3, mp4, flv, f4v, swf, xml
- Supposons qu’il soit statique sinon
Si l'enregistrement est détecté dans le catalogue d'images mais PAS dans le catalogue de contenu statique
- Utiliser l'image
Si l'enregistrement n'est PAS trouvé dans le catalogue d'images et n'est PAS trouvé dans le catalogue de contenu statique
- Supposons que la vidéo basée sur des fichiers se trouve dans l’ensemble suivant : mp3, mp4, flv, f4v, swf, xml
- Supposons qu’une image basée sur un fichier soit utilisée autrement

Dans tous les cas, la réponse XML résultante sera conforme au document XML spécifié avec le noeud racine défini correspondant au type détecté.

Détection du type de jeu interne

Lorsque l'ensemble externe est détecté comme un ensemble de supports de type, la réponse contient un ensemble d'éléments de visionneuse de supports correspondant à chaque entrée de visionneuse de supports dans catalog::ImageSet. Si le paramètre de type facultatif est spécifié pour une entrée de jeu de supports particulière, il est mappé à un type de sortie selon le tableau suivant :

Type d’entrée	Type de sortie
`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`

Si le paramètre de type facultatif pour une entrée de jeu de supports spécifique n'est pas spécifié ou correspond à un type non pris en charge, le type d'élément de jeu de supports est détecté automatiquement en utilisant les mêmes règles que celles appliquées au niveau de l'ensemble externe.

Spécification XML

La réponse xml renvoyée est conforme aux spécifications suivantes :

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

LabelKey

Le modificateur labelkey= est utilisé avec le champ catalog::UserDatapour générer des libellés pour les images et les échantillons. Le champ catalog:UserData est analysé sous la forme d'un ensemble de paires clé/valeur et la clé d'étiquette indexe cet ensemble pour récupérer la valeur de la clé donnée. Cette valeur est ensuite renvoyée dans l'attribut l pour les attributs s et i.

Restrictions appliquées

Afin de limiter la taille de la réponse et d’éviter les problèmes d’auto-référence, la profondeur d’imbrication maximale est contrôlée par la propriété de serveur PS::fvctx.nestingLimit. Si cette limite est dépassée, une erreur est renvoyée.

Afin de limiter la taille des réponses xml pour les jeux de catalogues électroniques volumineux, les métadonnées privées sont supprimées pour les éléments de jeu de brochures en fonction de la propriété de serveur PS::fvctx.brochureLimit. Toutes les métadonnées privées associées à la brochure seront exportées jusqu'à ce que la limite de la brochure soit atteinte. Une fois la limite dépassée, les cartes privées et les données utilisateur seront supprimées et un indicateur correspondant sera défini pour indiquer quel type de données a été supprimé.

Les visionneuses de supports imbriquées ne sont pas prises en charge. Une visionneuse de supports imbriquée est définie comme une visionneuse de supports contenant un élément de visionneuse de supports de type visionneuse de supports. Si cette condition est détectée, une erreur est renvoyée.