getID3

Properties · 40

$encodingstringpublic

CASE SENSITIVE! - i.e. (must be supported by iconv()). Examples: ISO-8859-1 UTF-8 UTF-16 UTF-16BE

$encoding_id3v1stringpublic

Should always be 'ISO-8859-1', but some tags may be written in other encodings such as 'EUC-CN' or 'CP1252'

$encoding_id3v1_autodetectboolpublic

ID3v1 should always be 'ISO-8859-1', but some tags may be written in other encodings such as 'Windows-1251' or 'KOI8-R'. If true attempt to detect these encodings, but may return incorrect values for some tags actually in ISO-8859-1 encoding

$option_tag_id3v1boolpublic

Read and process ID3v1 tags

$option_tag_id3v2boolpublic

Read and process ID3v2 tags

$option_tag_lyrics3boolpublic

Read and process Lyrics3 tags

$option_tag_apetagboolpublic

Read and process APE tags

$option_tags_processboolpublic

Copy tags to root key 'tags' and encode to $this->encoding

$option_tags_htmlboolpublic

Copy tags to root key 'tags_html' properly translated from various encodings to HTML entities

$option_extra_infoboolpublic

Calculate additional info such as bitrate, channelmode etc

$option_save_attachmentsbool|stringpublic

Defaults to true (ATTACHMENTS_INLINE) for backward compatibility

$option_md5_databoolpublic

Get MD5 sum of data part - slow

$option_md5_data_sourceboolpublic

Use MD5 of source file if available - only FLAC and OptimFROG

$option_sha1_databoolpublic

Get SHA1 sum of data part - slow

$option_max_2gb_checkbool|nullpublic

Check whether file is larger than 2GB and thus not supported by 32-bit PHP (null: auto-detect based on PHP_INT_MAX)

$option_fread_buffer_sizeintpublic

Read buffer size in bytes

$options_archive_rar_use_php_rar_extensionboolpublic

archive.rar if true use PHP RarArchive extension, if false (non-extension parsing not yet written in getID3)

$options_archive_gzip_parse_contentsboolpublic

archive.gzip Optional file list - disable for speed.

$options_audio_midi_scanwholefileboolpublic

audio.midi if false only parse most basic information, much faster for some files but may be inaccurate

$options_audio_mp3_allow_bruteforceboolpublic

audio.mp3 Forces getID3() to scan the file byte-by-byte and log all the valid audio frame headers - extremely slow, unrecommended, but may provide data from otherwise-unusable files.

$options_audio_mp3_mp3_valid_check_framesintpublic

audio.mp3 number of frames to scan to determine if MPEG-audio sequence is valid Lower this number to 5-20 for faster scanning Increase this number to 50+ for most accurate detection of valid VBR/CBR mpeg-audio streams

$options_audio_wavpack_quick_parsingboolpublic

audio.wavpack Avoid scanning all frames (break after finding ID_RIFF_HEADER and ID_CONFIG_BLOCK, significantly faster for very large files but other data may be missed

$options_audiovideo_flv_max_framesintpublic

audio-video.flv Break out of the loop if too many frames have been scanned; only scan this many if meta frame does not contain useful duration.

$options_audiovideo_matroska_hide_clustersboolpublic

audio-video.matroska If true, do not return information about CLUSTER chunks, since there's a lot of them and they're not usually useful [default: TRUE].

$options_audiovideo_matroska_parse_whole_fileboolpublic

audio-video.matroska True to parse the whole file, not only header [default: FALSE].

$options_audiovideo_quicktime_ReturnAtomDataboolpublic

audio-video.quicktime return all parsed data from all atoms if true, otherwise just returned parsed metadata

$options_audiovideo_quicktime_ParseAllPossibleAtomsboolpublic

audio-video.quicktime return all parsed data from all atoms if true, otherwise just returned parsed metadata

$options_audiovideo_swf_ReturnAllTagDataboolpublic

audio-video.swf return all parsed tags if true, otherwise do not return tags not parsed by getID3

$options_graphic_bmp_ExtractPaletteboolpublic

graphic.bmp return BMP palette

$options_graphic_bmp_ExtractDataboolpublic

graphic.bmp return image data

$options_graphic_png_max_data_bytesintpublic

graphic.png If data chunk is larger than this do not read it completely (getID3 only needs the first few dozen bytes for parsing).

$options_misc_pdf_returnXREFboolpublic

misc.pdf return full details of PDF Cross-Reference Table (XREF)

$options_misc_torrent_max_torrent_filesizeintpublic

misc.torrent Assume all .torrent files are less than 1MB and just read entire thing into memory for easy processing.

$filenamestringpublic

Filename of file being analysed.

$fpresourcepublic

Filepointer to file being analysed.

$infoarraypublic

Result array.

$tempdirstringpublic

$memory_limitintpublic

$startup_errorstringprotected

$startup_warningstringprotected

Methods · 23

• __construct()
• version()
• fread_buffer_size()
• setOption()
• openfile()
• analyze()analyze file
• error()Error handling.
• warning()Warning handling.
• CleanUp()
• GetFileFormatArray()Return array containing information about all supported formats.
• GetFileFormat()
• CharConvert()Converts array to $encoding charset from $this->encoding.
• HandleAllTags()
• CopyTagsToComments()Calls getid3_lib::CopyTagsToComments() but passes in the option_tags_html setting from this instance of getID3
• getHashdata()
• ChannelsBitratePlaytimeCalculations()
• CalculateCompressionRatioVideo()
• CalculateCompressionRatioAudio()
• CalculateReplayGain()
• ProcessAudioStreams()
• getid3_tempnam()
• include_module()
• is_writable()

Source

View on Trac ↗View on GitHub ↗

78class getID379{80	/*81	 * Settings82	 */83 84	/**85	 * CASE SENSITIVE! - i.e. (must be supported by iconv()). Examples:  ISO-8859-1  UTF-8  UTF-16  UTF-16BE86	 *87	 * @var string88	 */89	public $encoding        = 'UTF-8';90 91	/**92	 * Should always be 'ISO-8859-1', but some tags may be written in other encodings such as 'EUC-CN' or 'CP1252'93	 *94	 * @var string95	 */96	public $encoding_id3v1  = 'ISO-8859-1';97 98	/**99	 * ID3v1 should always be 'ISO-8859-1', but some tags may be written in other encodings such as 'Windows-1251' or 'KOI8-R'. If true attempt to detect these encodings, but may return incorrect values for some tags actually in ISO-8859-1 encoding100	 *101	 * @var bool102	 */103	public $encoding_id3v1_autodetect  = false;104 105	/*106	 * Optional tag checks - disable for speed.107	 */108 109	/**110	 * Read and process ID3v1 tags111	 *112	 * @var bool113	 */114	public $option_tag_id3v1         = true;115 116	/**117	 * Read and process ID3v2 tags118	 *119	 * @var bool120	 */121	public $option_tag_id3v2         = true;122 123	/**124	 * Read and process Lyrics3 tags125	 *126	 * @var bool127	 */128	public $option_tag_lyrics3       = true;129 130	/**131	 * Read and process APE tags132	 *133	 * @var bool134	 */135	public $option_tag_apetag        = true;136 137	/**138	 * Copy tags to root key 'tags' and encode to $this->encoding139	 *140	 * @var bool141	 */142	public $option_tags_process      = true;143 144	/**145	 * Copy tags to root key 'tags_html' properly translated from various encodings to HTML entities146	 *147	 * @var bool148	 */149	public $option_tags_html         = true;150 151	/*152	 * Optional tag/comment calculations153	 */154 155	/**156	 * Calculate additional info such as bitrate, channelmode etc157	 *

History

Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/ID3/getid3.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.