Class getID3

Located at zp-extensions/class-video/getid3/getid3.php

Methods summary
`public`	# `__construct( )`
`public string`	# `version( )` Returns string
`public integer`	# `fread_buffer_size( )` Returns integer
`public boolean`	# `setOption( array $optArray )` Parameters `$optArray` Returns boolean
`public boolean`	# `openfile( string $filename, integer $filesize = null, resource $fp = null )` Parameters `$filename` `$filesize` `$fp` Returns boolean Throws `getid3_exception`
`public array`	# `analyze( string $filename, integer $filesize = null, string $original_filename = '', resource $fp = null )` analyze file analyze file Parameters `$filename` `$filesize` `$original_filename` `$fp` Returns array
`public array`	# `error( string $message )` Error handling. Error handling. Parameters `$message` Returns array
`public boolean`	# `warning( string $message )` Warning handling. Warning handling. Parameters `$message` Returns boolean
`public array`	# `GetFileFormatArray( )` Return array containing information about all supported formats. Return array containing information about all supported formats. Returns array
`public mixed\|false`	# `GetFileFormat( string & $filedata, string $filename = '' )` Parameters `$filedata` `$filename` Returns mixed\|false
`public`	# `CharConvert( array & $array, string $encoding )` Converts array to $encoding charset from $this->encoding. Converts array to $encoding charset from $this->encoding. Parameters `$array` `$encoding`
`public boolean`	# `HandleAllTags( )` Returns boolean
`public boolean`	# `CopyTagsToComments( array & $ThisFileInfo )` Calls getid3_lib::CopyTagsToComments() but passes in the option_tags_html setting from this instance of getID3 Calls getid3_lib::CopyTagsToComments() but passes in the option_tags_html setting from this instance of getID3 Parameters `$ThisFileInfo` Returns boolean
`public array\|boolean`	# `getHashdata( string $algorithm )` Parameters `$algorithm` Returns array\|boolean
`public`	# `ChannelsBitratePlaytimeCalculations( )`
`public boolean`	# `CalculateCompressionRatioVideo( )` Returns boolean
`public boolean`	# `CalculateCompressionRatioAudio( )` Returns boolean
`public boolean`	# `CalculateReplayGain( )` Returns boolean
`public boolean`	# `ProcessAudioStreams( )` Returns boolean
`public string\|boolean`	# `getid3_tempnam( )` Returns string\|boolean
`public boolean`	# `include_module( string $name )` Parameters `$name` Returns boolean Throws `getid3_exception`
`public static boolean`	# `is_writable( string $filename )` Parameters `$filename` Returns boolean

Constants summary
`string`	`VERSION`	# `'1.9.20-202006061653'`
`integer`	`FREAD_BUFFER_SIZE`	# `32768`
`boolean`	`ATTACHMENTS_NONE`	# `false`
`boolean`	`ATTACHMENTS_INLINE`	# `true`

Properties summary
`public string`	`$encoding` CASE SENSITIVE! - i.e. (must be supported by iconv()). Examples: ISO-8859-1 UTF-8 UTF-16 UTF-16BE CASE SENSITIVE! - i.e. (must be supported by iconv()). Examples: ISO-8859-1 UTF-8 UTF-16 UTF-16BE	# `'UTF-8'`
`public string`	`$encoding_id3v1` Should always be 'ISO-8859-1', but some tags may be written in other encodings such as 'EUC-CN' or 'CP1252' Should always be 'ISO-8859-1', but some tags may be written in other encodings such as 'EUC-CN' or 'CP1252'	# `'ISO-8859-1'`
`public boolean`	`$encoding_id3v1_autodetect` 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 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	# `false`
`public boolean`	`$option_tag_id3v1` Read and process ID3v1 tags Read and process ID3v1 tags	# `true`
`public boolean`	`$option_tag_id3v2` Read and process ID3v2 tags Read and process ID3v2 tags	# `true`
`public boolean`	`$option_tag_lyrics3` Read and process Lyrics3 tags Read and process Lyrics3 tags	# `true`
`public boolean`	`$option_tag_apetag` Read and process APE tags Read and process APE tags	# `true`
`public boolean`	`$option_tags_process` Copy tags to root key 'tags' and encode to $this->encoding Copy tags to root key 'tags' and encode to $this->encoding	# `true`
`public boolean`	`$option_tags_html` Copy tags to root key 'tags_html' properly translated from various encodings to HTML entities Copy tags to root key 'tags_html' properly translated from various encodings to HTML entities	# `true`
`public boolean`	`$option_extra_info` Calculate additional info such as bitrate, channelmode etc Calculate additional info such as bitrate, channelmode etc	# `true`
`public boolean\|string`	`$option_save_attachments` Defaults to true (ATTACHMENTS_INLINE) for backward compatibility Defaults to true (ATTACHMENTS_INLINE) for backward compatibility	# `true`
`public boolean`	`$option_md5_data` Get MD5 sum of data part - slow Get MD5 sum of data part - slow	# `false`
`public boolean`	`$option_md5_data_source` Use MD5 of source file if availble - only FLAC and OptimFROG Use MD5 of source file if availble - only FLAC and OptimFROG	# `false`
`public boolean`	`$option_sha1_data` Get SHA1 sum of data part - slow Get SHA1 sum of data part - slow	# `false`
`public boolean\|null`	`$option_max_2gb_check` Check whether file is larger than 2GB and thus not supported by 32-bit PHP (null: auto-detect based on PHP_INT_MAX) Check whether file is larger than 2GB and thus not supported by 32-bit PHP (null: auto-detect based on PHP_INT_MAX)	#
`public integer`	`$option_fread_buffer_size` Read buffer size in bytes Read buffer size in bytes	# `32768`
`public string`	`$filename` Filename of file being analysed. Filename of file being analysed.	#
`public resource`	`$fp` Filepointer to file being analysed. Filepointer to file being analysed.	#
`public array`	`$info` Result array. Result array.	#
`public string`	`$tempdir`	# `GETID3_TEMP_DIR`
`public integer`	`$memory_limit`	# `0`
`protected string`	`$startup_error`	# `''`
`protected string`	`$startup_warning`	# `''`

Classes

Interfaces

Exceptions

Functions

Class getID3

Returns

Returns

Parameters

Returns

Parameters

Returns

Throws

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Throws

Parameters

Returns