Version 1.0

Avertissement

Encore en alpha !

Classes

Status

Classe abstraite

Statuts possibles : approved, rejected, waiting review. Le statut par défaut est waiting review.

• type : String = Abstract
• parameters:
  • date: String -> Date de création en ISO UTC : rfc3339
  • author: String-> Auteur de la note.
  • value: String-> État du statut.

XML

<status date="2020-10-13T10:38:14.173325+00:00" author="Alice">approved</status>

Description TOML

Contenu de Status.toml :

type = "Object"
available = [ "approved", "rejected", "waiting review",]

[parameters]
date = "String"
author = "String"
value = "String"

Review

Classe abstraite

• type : String = Abstract

• parameters:

  • media_path: String -> Chemin vers le média. Les séquences d’image sont décrites avec un “#” par digit (image_seq-###.exr).
  • media_signature: String -> Signature MD5 du media pour garantir son authenticité.
  • status_history: Dict{Dict} -> Tous les changements statuts, le dernier de la liste étant le statut courant.
  • notes: Dict{Dict} -> Notes associées à la review. La date de création est utilisée pour l’identification.
  • optional:

  • metadata: (optionel) Dict{AnyType} = {} -> Permet de stocker toute donnée supplémentaire relative à la review.

XML

<review media_path="/path/to/other_media.ext" media_signature="d41d8cd98f00b204e9800998ecf8427e">
  <metadata key="value"/>
  <statuses>
    ...
  </statuses>
  <notes>
    ...
  </notes>
</review>

Description TOML

Contenu de Review.toml :

type = "Object"

[parameters]
media_path = "String"
status_history = "Array[Status]"
notes = "Array[Note]"

[parameters.optional]
metadata = [ "Dict", "None",]

Note

Classe abstraite

• type : String = Abstract

• parameters:

  • date: String -> Date de création en ISO UTC : rfc3339
  • author: String -> Auteur de la note.
  • optional:

  • parent: (optionel) String = “” -> Date (id) de la note à laquelle cette note est une réponse.
  • metadata: (optionel) Dict{AnyType} = {} -> Permet de stocker toute donnée supplémentaire relative à la review.

XML

<note date="2020-10-13T10:38:14.173325+00:00" author="Michel" parent="">
  <contents>
    ...
  </contents>
  <metadata key="value"/>
</note>

Description TOML

Contenu de Note.toml :

type = "Object"

[parameters]
date = "String"
author = "String"
value = "String"

[parameters.optional]
parent = [ "String", "",]
metadata = [ "Dict", "None",]

Contents

TextComment

Commentaire texte concernant tout le media.

• type : String = Content. -> Type de la classe dont sont héritées les propriétés.
• parameters :
  • body : String -> Contenu textuel du commentaire.

XML

<TextComment body="Text content body"/>

Description TOML

Contenu de TextComment.toml :

type = "Content"

[parameters]
body = "String"

TextAnnotation

Commentaire texte relatif à un fragment temporel d’un média. Composé d’une image de départ et d’une durée.

• type : String = TextComment. -> Type de la classe dont sont héritées les propriétés.
• parameters :
  • frame : Integer = 0 -> Image à laquelle l’annotation commence.
  • duration : Integer = 1 -> Durée de l’annotation en nombre d’images.

XML

<TextAnnotation body="Text annotation body" duration="7" frame="10"/>

Description TOML

Contenu de TextAnnotation.toml :

type = "TextComment"

[parameters]
frame = "Integer"
duration = "Integer"

Image

Classe abstraite. Les fichiers image acceptés sont les fichiers aux extensions JPEG, JPG et PNG.

• type : String = Abstract
• mime : Array[String] -> MIME_ autorisé pour les images : JPG, JPEG or PNG.
• parameters:
  • path_to_image : String -> Chemin vers le fichier image.

XML

<Image path_to_image="/path/to/image.png"/>

Description TOML

Contenu de Image.toml :

type = "Content"
mime = [ "jpeg", "jpg", "png",]

[parameters]
path_to_image = "String"

ImageAnnotation

Annotation par image concernant une partie du media.

• type: String = Content. -> Type de la classe dont sont héritées les propriétés.

• paramètres :

  • image : Image
  • frame : Integer = 0 -> Image à laquelle l’annotation commence.
  • duration : Integer = 1 -> Durée de l’annotation en nombre d’images.
  • optional:

  • reference_image: (optionel) String = “” -> Chemin vers le fichier image utilisé comme référence de l’annotation.

XML

<ImageAnnotation duration="10" frame="3" path_to_image="/path/to/image_annotation.png" reference_image="/path/to/reference_image.png"/>

Description TOML

Contenu de ImageAnnotation.toml :

type = "Image"

[parameters]
frame = "Integer"
duration = "Integer"

[parameters.optional]
reference_image = [ "Image", "",]

Fichier de démonstration

<?xml version='1.0' encoding='UTF-8'?>
<review media_path="/path/to/other_media.ext" media_signature="d41d8cd98f00b204e9800998ecf8427e">
  <metadata/>
  <statuses>
    <status date="2020-10-13T10:38:14.173325+00:00" author="Michel">rejected</status>
    <status date="2020-10-13T10:38:14.176828+00:00" author="Alice">approved</status>
  </statuses>
  <notes>
    <note date="2020-10-13T10:38:14.173325+00:00" author="Michel" parent="">
      <contents>
        <TextComment body="Text content body"/>
        <TextAnnotation body="Text annotation body" duration="7" frame="10"/>
        <Image path_to_image="/path/to/image.png"/>
        <ImageAnnotation duration="10" frame="3" path_to_image="/path/to/image_annotation.png" reference_image="/path/to/reference_image.png"/>
      </contents>
      <metadata key="value"/>
    </note>
  </notes>
</review>