ZenphotoCMS 1.6.5

getID3

in package

• misc

Table of Contents

Constants

ATTACHMENTS_INLINE  = \true

ATTACHMENTS_NONE  = \false

FREAD_BUFFER_SIZE  = 32768

VERSION  = '1.9.23-202310190849'

Properties

$encoding  : string

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

$encoding_id3v1  : string

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

$encoding_id3v1_autodetect  : bool

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

$filename  : string

Filename of file being analysed.

$fp  : resource

Filepointer to file being analysed.

$info  : array<string|int, mixed>

Result array.

$memory_limit  : int

$option_extra_info  : bool

Calculate additional info such as bitrate, channelmode etc

$option_fread_buffer_size  : int

Read buffer size in bytes

$option_max_2gb_check  : bool|null

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

$option_md5_data  : bool

Get MD5 sum of data part - slow

$option_md5_data_source  : bool

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

$option_save_attachments  : bool|string

Defaults to true (ATTACHMENTS_INLINE) for backward compatibility

$option_sha1_data  : bool

Get SHA1 sum of data part - slow

$option_tag_apetag  : bool

Read and process APE tags

$option_tag_id3v1  : bool

Read and process ID3v1 tags

$option_tag_id3v2  : bool

Read and process ID3v2 tags

$option_tag_lyrics3  : bool

Read and process Lyrics3 tags

$option_tags_html  : bool

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

$option_tags_process  : bool

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

$options_archive_gzip_parse_contents  : bool

archive.gzip Optional file list - disable for speed.

$options_archive_rar_use_php_rar_extension  : bool

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

$options_audio_midi_scanwholefile  : bool

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

$options_audio_mp3_allow_bruteforce  : bool

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_frames  : int

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_parsing  : bool

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_frames  : int

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_clusters  : bool

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_file  : bool

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

$options_audiovideo_quicktime_ParseAllPossibleAtoms  : bool

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

$options_audiovideo_quicktime_ReturnAtomData  : bool

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

$options_audiovideo_swf_ReturnAllTagData  : bool

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

$options_graphic_bmp_ExtractData  : bool

graphic.bmp return image data

$options_graphic_bmp_ExtractPalette  : bool

graphic.bmp return BMP palette

$options_graphic_png_max_data_bytes  : int

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_returnXREF  : bool

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

$options_misc_torrent_max_torrent_filesize  : int

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

$tempdir  : string

$startup_error  : string

$startup_warning  : string

Methods

__construct()  : mixed

analyze()  : array<string|int, mixed>

analyze file

CalculateCompressionRatioAudio()  : bool

CalculateCompressionRatioVideo()  : bool

CalculateReplayGain()  : bool

ChannelsBitratePlaytimeCalculations()  : mixed

CharConvert()  : mixed

Converts array to $encoding charset from $this->encoding.

CopyTagsToComments()  : bool

Calls getid3_lib::CopyTagsToComments() but passes in the option_tags_html setting from this instance of getID3

error()  : array<string|int, mixed>

Error handling.

fread_buffer_size()  : int

GetFileFormat()  : mixed|false

GetFileFormatArray()  : array<string|int, mixed>

Return array containing information about all supported formats.

getHashdata()  : array<string|int, mixed>|bool

getid3_tempnam()  : string|bool

HandleAllTags()  : bool

include_module()  : bool

is_writable()  : bool

openfile()  : bool

ProcessAudioStreams()  : bool

setOption()  : bool

version()  : string

warning()  : bool

Warning handling.

CleanUp()  : bool