This statement is used to extract various read only properties from a file. The property is saved to the specified track variable.
Note that this statement is valid in all execution contexts. However, most of the values returned are only meaningful in a Grouped execution context.
The following table describes the currently supported properties. Note that the Transfer Metadata statement can optionally create a key-value list containing the properties contained in the source file. The property names in the table below are the names of the keys. Property names followed by * are not available in the created key-value list.
- APE Version
- The version of the APE tag or empty if there is no APE tag. The value returned should be one of 2000 for version 2, or 1000 for version 1. If a version 2 tag had a header it will be identified as 2000,H. Note that it is possible that this field is non empty for MP3 files.
- Audio Container Status
- Many audio files have formatting issues which are handled by Yate, iTunes, Music, TV and most other taggers and audio players. However, it is possible that some applications cannot properly process files which have irregularities. Typically these issues can be solved by simply saving the file with Yate which corrects them when saving. Note that the property reports on issues in the audio container, not the tag metadata. This property will return 0 if irregularities have been detected which can be fixed by saving the file. Otherwise it returns 1. It is important to note that unless you are experiencing issues with other applications, these formatting issues can safely be ignored.
- Audio File Type
- This property provides a better means of testing a file's type than the filename extension. The possible return values are:
1 = mp3, mp2
2 = m4a, m4b, m4r, m4v, mp4
4 = flac
8 = aiff, aif, aifc
16 = dsf
32 = wav
64 = dff
128 = ogg, oga, opus
256 = ape
512 = wv- BEXT Metadata
- The Broadcast WAV Extension metadata is formatted as a key-value list using the standard delimiters. Additional information can be found in BEXT Metadata.
- Bit Depth
- The bit depth of the track, where applicable for the audio stream type. If not applicable, the return value will be the empty string. This is the same bit depth displayed on the Channel Mode property.
- Bit Rate (kbits/sec)
- The bit rate of the track. mp3 files can have a number followed by VBR.
- Channel Count
- The number of channels in an audio track.
- Channel Mode
- The track's channel layout. Typically Stereo. If applicable the bit depth is at the end of the string followed by a comma. eg. Stereo, 16 bit. Note, whenever possible, this property is symbolic. Numeric values can be extract by using the Channel Count and Bit Depth properties.
- Creation Date
- The date/time the file was created.
- File Count *
- The number of files being manipulated by the action.
- File Extension
- The filename extension. For /Genre/Artist/Album/Track.mp3, mp3 is returned.
- File Index *
- The index of the current file in the set of files being operated on. The index is zero based.
- File Name (with extension)
- The full filename. For /Genre/Artist/Album/Track.mp3, Track.mp3 is returned.
- File Name (without extension)
- The filename with the extension removed. For /Genre/Artist/Album/Track.mp3, Track is returned.
- File Size (bytes)
- The size of the file in bytes.
- Folder Name
- The name of the folder containing the file. For /Genre/Artist/Album/Track.mp3, Album is returned.
- Free Space (bytes)
- The size of the free space, (unused or pad), in the file.
- Grouping Compatibility *
- Describes the iTunes/Music compatibility state of the Grouping field in MP3 and AIFF files. Note that any other file type always returns an empty string. More information on the interpretation of this field can be found in Classical Metadata and the Grouping Field. The returned value contains zero to three character flags which indicate the compatibility state:
- M
- The Settings-Apple Apps-General Maximum Grouping-Work Name compatibility option is set. This is the current application setting and is not indicative to anything in the file.
- Y
- The YiTG special UDTI was in the file when it was loaded. ie. the file has been saved when Maximum Grouping-Work Name compatibility was enabled.
- G
- The non standard GRP1 frame was in the file when it was loaded. If the Y flag is not present, the Apple application wrote the file with a Grouping tag and the file had not been saved by Yate with the Maximum Grouping-Work Name compatibility YiTG UDTI.
- Has Audio
- 1 if the file contains an audio track, 0 otherwise.
- Has Chapters *
- 1 if the file contains chapter names, 0 otherwise.
- Has Modified Chapters *
- 1 if the file contains modified chapter names, 0 otherwise.
- Has Progressive Artwork *
- 1 if the file contains progressive JPEG artwork, 0 otherwise.
- Has Progressive Default Artwork *
- 1 if the file's default artwork item is a progressive JPEG, 0 otherwise.
- Has Video
- 1 if the file contains a video track, 0 otherwise.
- ID3 Version
- The empty string if the track does not have an ID3 tag. If the track only has a version 1 tag, 1 is returned. If the track has a version 2.x tag, 2.x is returned. If the track has a version 1 and version 2 tag, 2.x,1 is returned. Note that it is possible that this property will be non empty for FLAC and APE files. Yate reads ID3 tags in FLAC and APE files but typically does not write them.
- Is Artwork Modified *
- 1 if the track's artwork has been modified and not yet saved, 0 if not. This property determines modified based on the entirety of an artwork item. That means changes to metadata such as description or picture type are taken into account.
- Is Default Artwork Modified *
- 1 if the track's default artwork item has been modified and not yet saved, 0 if not. Note that this property determines modified only on the image data and will not reflect metadata changes such as in the description or picture type.
- Is Externally Modified *
- 1 if the track has been externally modified, 0 if not.
- Is Linked *
- 1 if the track is linked to iTunes/Music/TV, 0 if not.
- Is Linked with Differences*
- 1 if the track is linked to iTunes/Music/TV and has metadata which differs, 0 if not. Metadata refers to special Apple application items such as rating, skip when shuffling, etc.
- Is Modified *
- 1 if the tag metadata has unsaved changes, 0 if not.
- Leading mp3 Audio Padding
- mp3 files can have padding before the start of the audio stream. The property returns the number of bytes of leading audio padding.
- Linked PID *
- The Persistent ID if the track is linked to iTunes/Music/TV, empty if not. A PID is a sequence of hexadecimal digits. iTunes PIDs have no prefix. Music PIDs are prefixed with an M and TV PIDs are prefixed with a V.
- Loaded File UID *
- The File Index property can change when file availability action statements are executed. The Loaded File UID is a unique ID given to every loaded file which remains constant at all times. The property is not retained when Yate terminates.
- Modification Date
- The date/time the file was last modified.
- mp3 Header
- mp3 files can contain header frames which describe the audio properties of the file. Possible values are Xing, Info, VBRI or empty. If no mp3 audio frames are found this property will be set to No Audio. empty is not an error while No Audio is.
- Network Response *
- Action statements which perform network accesses on a per track basis store the last obtained network response in this property. The same workflow is applied by all setters of this property. When the action statement starts, the property is set to 0. Immediately prior to issuing a network request, the property is set to -1. When a network response is obtained, it is saved to the property.
- Original File Name (with extension) *
- The same as File Name (with extension), but is extracted from the path to the file when opened. Note that a file's name and location can be changed by rename and move statements.
- Original File Name (without extension) *
- The same as File Name (without extension), but is extracted from the path of file when opened. Note that a file's name and location can be changed by rename and move statements.
- Original Folder Name *
- The same as Folder Name, but is extracted from the path to the file when opened. Note that a file's name and location can be changed by rename and move statements.
- Original Parent Folder Name *
- The same as Parent Folder Name, but is extracted from the path to the file when opened. Note that a file's name and location can be changed by rename and move statements.
- Original Path to File *
- The original path to the file when opened.
- Original Path to File (without extension) *
- The original path to the file with the filename extension removed.
- Original Path to Folder *
- The same as Path to Folder, but is extracted from the path to the file when opened. Note that a file's name and location can be changed by rename and move statements.
- Original Path to Parent Folder *
- The same as Path to Parent Folder, but is extracted from the path to the file when opened. Note that a file's name and location can be changed by rename and move statements.
- Parent Folder Name
- The name of the folder containing the folder which contains the file. For /Genre/Artist/Album/Track.mp3, Artist is returned.
- Path to File
- The current path to the file. For /Genre/Artist/Album/Track.mp3, /Genre/Artist/Album/Track.mp3 is returned.
- Path to File (without extension)
- The current path to the file without the filename extension. For /Genre/Artist/Album/Track.mp3, /Genre/Artist/Album/Track is returned.
- Path to Folder
- The current path to the folder containing the file. For /Genre/Artist/Album/Track.mp3, /Genre/Artist/Album is returned.
- Path to Parent Folder
- The current path to the folder containing the folder which contains the file. For /Genre/Artist/Album/Track.mp3, /Genre/Artist is returned.
- Retained Path 1 *
- This property is set by the Rename, Create Symbolic Link, Copy Files, Move and Export Metadata statements. On success these statements will set the property to the destination path. On failure the property will be empty. Note that an empty value for the property might also mean that the operation did not take place because the source and destination paths were the same.
- Retained Path 2 *
- This property is cleared by the following statements on failure. It is set as described on success
- Create Symbolic Link statement
- The property will contain the value, absolute or relative, inside the link.
- Copy and Move Files statements
- The property will be set to the source file's path.
- Rename statement
- The property will be set to the original path.
- Export Metadata statement
- The property will be set to the base filename.
- Sample Rate (Hz)
- The sample rate of the track.
- Save Error *
- Set to 0 if the last Save operation succeeded. Set to 1 if it failed.
- Stem Data
- The specific read-only metadata available in a Stem file can be viewed in a snapshot or by double clicking on an audio properties table. If you wish to manually parse the data, you can extract it via this property.
- Stream
- A symbolic representation of the type of audio stream contained in a track. For example MPEG-1, Layer 3.
If the file contains one or more video tracks video will be appended. For example AAC, video.- Time (hh:mm:ss)
- The duration of the track described in standard notation.
- Time (ms)
- The duration of the track in milliseconds.
- Video Size (wxh)
- The width x height of the largest video track in the file. If the file does not contain video, an empty string is returned.
- Xattrs *
- A string representing the extended attributes which can be repaired by the File Maintenance statement. The following codes may be present in the string:
- F
- The Finder info extended attribute is present.
- R
- The file has a resource fork.
- D
- The Doppler extended attribute is present.