Documentation

wavinfo/wave_ixml_reader.py

@@ -3,9 +3,13 @@ import io
 
 class WavIXMLFormat:
     """
-    iXML recorder metadata, as defined by iXML 2.0
+    iXML recorder metadata.
     """
     def __init__(self, xml):
+        """
+        Parse iXML.
+        :param xml: A bytes-like object containing the iXML payload.
+        """
         self.source = xml
         xmlBytes = io.BytesIO(xml)
         self.parsed = ET.parse(xmlBytes)
@@ -17,26 +21,45 @@ class WavIXMLFormat:
 
     @property
     def project(self):
+        """
+        The project/film name entered for the recording.
+        """
         return self._get_text_value("PROJECT")
 
     @property
     def scene(self):
+        """
+        Scene/slate.
+        """
         return self._get_text_value("SCENE")
 
     @property
     def take(self):
+        """
+        Take number.
+        """
         return self._get_text_value("TAKE")
 
     @property
     def tape(self):
+        """
+        Tape name.
+        """
         return self._get_text_value("TAPE")
 
     @property
     def family_uid(self):
+        """
+        The globally-unique ID for this file family. This may be in the format
+        of a GUID, or an EBU Rec 9 source identifier, or some other dumb number.
+        """
         return self._get_text_value("FILE_SET/FAMILY_UID")
 
     @property
     def family_name(self):
+        """
+        The name of this file's file family.
+        """
         return self._get_text_value("FILE_SET/FAMILY_NAME")