From 326ae0ab3ef6cfee50290d1cc30d470fba99781b Mon Sep 17 00:00:00 2001 From: David Soria Parra Date: Mon, 22 Dec 2008 01:21:10 +0000 Subject: [PATCH] Add ktaglib documentation git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@271733 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ktaglib/audioproperties.xml | 59 ++++ .../ktaglib/audioproperties/getBitrate.xml | 48 ++++ .../ktaglib/audioproperties/getChannels.xml | 48 ++++ .../ktaglib/audioproperties/getLayer.xml | 48 ++++ .../ktaglib/audioproperties/getLength.xml | 48 ++++ .../audioproperties/getSampleBitrate.xml | 48 ++++ .../ktaglib/audioproperties/getVersion.xml | 49 ++++ .../ktaglib/audioproperties/isCopyrighted.xml | 48 ++++ .../ktaglib/audioproperties/isOriginal.xml | 48 ++++ .../audioproperties/isProtectionEnabled.xml | 48 ++++ reference/ktaglib/book.xml | 49 ++++ reference/ktaglib/configure.xml | 35 +++ reference/ktaglib/constants.xml | 265 ++++++++++++++++++ reference/ktaglib/examples.xml | 47 ++++ .../ktaglib/id3v2attachedpictureframe.xml | 60 ++++ .../getDescription.xml | 48 ++++ .../id3v2attachedpictureframe/getMimeType.xml | 58 ++++ .../id3v2attachedpictureframe/getType.xml | 51 ++++ .../id3v2attachedpictureframe/savePicture.xml | 48 ++++ .../id3v2attachedpictureframe/setMimeType.xml | 42 +++ .../id3v2attachedpictureframe/setPicture.xml | 51 ++++ .../id3v2attachedpictureframe/setType.xml | 42 +++ reference/ktaglib/id3v2frame.xml | 61 ++++ reference/ktaglib/id3v2frame/getSize.xml | 48 ++++ reference/ktaglib/id3v2frame/toString.xml | 49 ++++ reference/ktaglib/id3v2tag.xml | 61 ++++ reference/ktaglib/id3v2tag/addFrame.xml | 48 ++++ reference/ktaglib/id3v2tag/getFrameList.xml | 47 ++++ reference/ktaglib/mpegfile.xml | 59 ++++ reference/ktaglib/mpegfile/construct.xml | 72 +++++ .../ktaglib/mpegfile/getAudioProperties.xml | 49 ++++ reference/ktaglib/mpegfile/getID3v1Tag.xml | 49 ++++ reference/ktaglib/mpegfile/getID3v2Tag.xml | 49 ++++ reference/ktaglib/setup.xml | 39 +++ reference/ktaglib/tag.xml | 59 ++++ reference/ktaglib/tag/getAlbum.xml | 49 ++++ reference/ktaglib/tag/getArtist.xml | 49 ++++ reference/ktaglib/tag/getComment.xml | 49 ++++ reference/ktaglib/tag/getGenre.xml | 49 ++++ reference/ktaglib/tag/getTitle.xml | 49 ++++ reference/ktaglib/tag/getTrack.xml | 49 ++++ reference/ktaglib/tag/getYear.xml | 49 ++++ reference/ktaglib/tag/isEmpty.xml | 49 ++++ 43 files changed, 2370 insertions(+) create mode 100644 reference/ktaglib/audioproperties.xml create mode 100644 reference/ktaglib/audioproperties/getBitrate.xml create mode 100644 reference/ktaglib/audioproperties/getChannels.xml create mode 100644 reference/ktaglib/audioproperties/getLayer.xml create mode 100644 reference/ktaglib/audioproperties/getLength.xml create mode 100644 reference/ktaglib/audioproperties/getSampleBitrate.xml create mode 100644 reference/ktaglib/audioproperties/getVersion.xml create mode 100644 reference/ktaglib/audioproperties/isCopyrighted.xml create mode 100644 reference/ktaglib/audioproperties/isOriginal.xml create mode 100644 reference/ktaglib/audioproperties/isProtectionEnabled.xml create mode 100644 reference/ktaglib/book.xml create mode 100644 reference/ktaglib/configure.xml create mode 100644 reference/ktaglib/constants.xml create mode 100644 reference/ktaglib/examples.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/getDescription.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/getType.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/savePicture.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/setPicture.xml create mode 100644 reference/ktaglib/id3v2attachedpictureframe/setType.xml create mode 100644 reference/ktaglib/id3v2frame.xml create mode 100644 reference/ktaglib/id3v2frame/getSize.xml create mode 100644 reference/ktaglib/id3v2frame/toString.xml create mode 100644 reference/ktaglib/id3v2tag.xml create mode 100644 reference/ktaglib/id3v2tag/addFrame.xml create mode 100644 reference/ktaglib/id3v2tag/getFrameList.xml create mode 100644 reference/ktaglib/mpegfile.xml create mode 100644 reference/ktaglib/mpegfile/construct.xml create mode 100644 reference/ktaglib/mpegfile/getAudioProperties.xml create mode 100644 reference/ktaglib/mpegfile/getID3v1Tag.xml create mode 100644 reference/ktaglib/mpegfile/getID3v2Tag.xml create mode 100644 reference/ktaglib/setup.xml create mode 100644 reference/ktaglib/tag.xml create mode 100644 reference/ktaglib/tag/getAlbum.xml create mode 100644 reference/ktaglib/tag/getArtist.xml create mode 100644 reference/ktaglib/tag/getComment.xml create mode 100644 reference/ktaglib/tag/getGenre.xml create mode 100644 reference/ktaglib/tag/getTitle.xml create mode 100644 reference/ktaglib/tag/getTrack.xml create mode 100644 reference/ktaglib/tag/getYear.xml create mode 100644 reference/ktaglib/tag/isEmpty.xml diff --git a/reference/ktaglib/audioproperties.xml b/reference/ktaglib/audioproperties.xml new file mode 100644 index 0000000000..3415dd0f49 --- /dev/null +++ b/reference/ktaglib/audioproperties.xml @@ -0,0 +1,59 @@ + + + + The KTaglib_MPEG_AudioProperties class + KTaglib_MPEG_AudioProperties + + + + +
+ &reftitle.intro; + +Represents the audio properties of a MPEG file, like length, bitrate or samplerate. + +
+ + +
+ Class synopsis + + + + KTaglib_MPEG_Audioproperties + + + + + KTaglib_MPEG_AudioProperties + + + +
+ + + +&reference.ktaglib.entities.audioproperties; + + + + diff --git a/reference/ktaglib/audioproperties/getBitrate.xml b/reference/ktaglib/audioproperties/getBitrate.xml new file mode 100644 index 0000000000..982801a0f5 --- /dev/null +++ b/reference/ktaglib/audioproperties/getBitrate.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::getBitrate + Returns the bitrate of the MPEG file + + + &reftitle.description; + + public + integer + KTaglib_MPEG_AudioProperties::getBitrate + + + + Returns the bitrate of the MPEG file + + + + &reftitle.returnvalues; + + Returns the bitrate as an integer + + + + + + diff --git a/reference/ktaglib/audioproperties/getChannels.xml b/reference/ktaglib/audioproperties/getChannels.xml new file mode 100644 index 0000000000..837b03edcb --- /dev/null +++ b/reference/ktaglib/audioproperties/getChannels.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::getChannels + Returns the amount of channels of a MPEG file + + + &reftitle.description; + + public + integer + KTaglib_MPEG_AudioProperties::getChannels + + + + Returns the amount of channels of the MPEG file + + + + &reftitle.returnvalues; + + Returns the channel count as an integer + + + + + + diff --git a/reference/ktaglib/audioproperties/getLayer.xml b/reference/ktaglib/audioproperties/getLayer.xml new file mode 100644 index 0000000000..1a04fdbad0 --- /dev/null +++ b/reference/ktaglib/audioproperties/getLayer.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::getLayer + Returns the layer of a MPEG file + + + &reftitle.description; + + public + integer + KTaglib_MPEG_AudioProperties::getLayer + + + + Returns the layer of the MPEG file (usually 3 for MP3). + + + + &reftitle.returnvalues; + + Returns the layer as an integer + + + + + + diff --git a/reference/ktaglib/audioproperties/getLength.xml b/reference/ktaglib/audioproperties/getLength.xml new file mode 100644 index 0000000000..89f0ac27f9 --- /dev/null +++ b/reference/ktaglib/audioproperties/getLength.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::getLength + Returns the length of a MPEG file + + + &reftitle.description; + + public + integer + KTaglib_MPEG_AudioProperties::getLength + + + + Returns the length of the MPEG file + + + + &reftitle.returnvalues; + + Returns the length as an integer + + + + + + diff --git a/reference/ktaglib/audioproperties/getSampleBitrate.xml b/reference/ktaglib/audioproperties/getSampleBitrate.xml new file mode 100644 index 0000000000..2a428e5c4e --- /dev/null +++ b/reference/ktaglib/audioproperties/getSampleBitrate.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::getSampleBitrate + Returns the sample bitrate of a MPEG file + + + &reftitle.description; + + public + integer + KTaglib_MPEG_AudioProperties::getSampleBitrate + + + + Returns the sample bitrate of the MPEG file + + + + &reftitle.returnvalues; + + Returns the sample bitrate as an integer + + + + + + diff --git a/reference/ktaglib/audioproperties/getVersion.xml b/reference/ktaglib/audioproperties/getVersion.xml new file mode 100644 index 0000000000..d3550e07ff --- /dev/null +++ b/reference/ktaglib/audioproperties/getVersion.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_MPEG_AudioProperties::getVersion + Returns the version of a MPEG file + + + &reftitle.description; + + public + integer + KTaglib_MPEG_AudioProperties::getVersion + + + + Returns the version of the MPEG file header. The possible versions are + defined in Tag_MPEG_Header (Version1, Version2, Version2.5). + + + + &reftitle.returnvalues; + + Returns the version + + + + + + diff --git a/reference/ktaglib/audioproperties/isCopyrighted.xml b/reference/ktaglib/audioproperties/isCopyrighted.xml new file mode 100644 index 0000000000..2a0124ec69 --- /dev/null +++ b/reference/ktaglib/audioproperties/isCopyrighted.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::isCopyrighted + Returns the length of a MPEG file + + + &reftitle.description; + + public + boolean + KTaglib_MPEG_AudioProperties::isCopyrighted + + + + Returns true if the MPEG file is copyrighted + + + + &reftitle.returnvalues; + + Returns true if the MPEG file is copyrighted + + + + + + diff --git a/reference/ktaglib/audioproperties/isOriginal.xml b/reference/ktaglib/audioproperties/isOriginal.xml new file mode 100644 index 0000000000..9ca1394a76 --- /dev/null +++ b/reference/ktaglib/audioproperties/isOriginal.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::isOriginal + Returns the length of a MPEG file + + + &reftitle.description; + + public + boolean + KTaglib_MPEG_AudioProperties::isOriginal + + + + Returns true if the file is marked as the original file + + + + &reftitle.returnvalues; + + Returns true if the file is marked as the original file + + + + + + diff --git a/reference/ktaglib/audioproperties/isProtectionEnabled.xml b/reference/ktaglib/audioproperties/isProtectionEnabled.xml new file mode 100644 index 0000000000..6ae068daa7 --- /dev/null +++ b/reference/ktaglib/audioproperties/isProtectionEnabled.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_MPEG_AudioProperties::isProtectionEnabled + Returns the length of a MPEG file + + + &reftitle.description; + + public + boolean + KTaglib_MPEG_AudioProperties::isProtectionEnabled + + + + Returns true if protection mechanism (like DRM) are enabled for this file + + + + &reftitle.returnvalues; + + Returns true if protection mechanism (like DRM) are enabled for this file + + + + + + diff --git a/reference/ktaglib/book.xml b/reference/ktaglib/book.xml new file mode 100644 index 0000000000..9f14238991 --- /dev/null +++ b/reference/ktaglib/book.xml @@ -0,0 +1,49 @@ + + + + + + + KTaglib + + &reftitle.intro; + + The module enables you to read and write ID3v1, ID3v2 and Ogg tags. + It is build using the taglib extension from the KDE project. + + + + At the moment ktaglib is able to read and write ID3v1 and ID3v2 tags. + + + + &reference.ktaglib.setup; + &reference.ktaglib.constants; + &reference.ktaglib.mpegfile; + &reference.ktaglib.audioproperties; + &reference.ktaglib.tag; + &reference.ktaglib.id3v2tag; + &reference.ktaglib.id3v2frame; + &reference.ktaglib.id3v2attachedpictureframe; + + + diff --git a/reference/ktaglib/configure.xml b/reference/ktaglib/configure.xml new file mode 100644 index 0000000000..fe9ca13799 --- /dev/null +++ b/reference/ktaglib/configure.xml @@ -0,0 +1,35 @@ + + +
+ &reftitle.install; + + KTaglib support in PHP is not enabled by default. You will need to + configure PHP + + + + KTaglib is part of PECL. + + +
+ + diff --git a/reference/ktaglib/constants.xml b/reference/ktaglib/constants.xml new file mode 100644 index 0000000000..588adfa362 --- /dev/null +++ b/reference/ktaglib/constants.xml @@ -0,0 +1,265 @@ + + + + &reftitle.constants; + &extension.constants; + + + KTaglib uses class constants. Most of the constants are mappings to the according + Taglib enums and constants. + + + + + KTaglib_MPEG_Header::Version1 + (integer) + + + + ID3 version is 1.0 + + + + + KTaglib_MPEG_Header::Version2 + (integer) + + + + ID3 version is 2.0 + + + + + KTaglib_MPEG_Header::Version2_5 + (integer) + + + + ID3 version is 2.5 + + + + + KTaglib_ID3v2_AttachedPictureFrame::Other + (integer) + + + + Picture type Other + + + + + KTaglib_ID3v2_AttachedPictureFrame::FileIcon + (integer) + + + + Picture type FileIcon + + + + + KTaglib_ID3v2_AttachedPictureFrame::OtherFileIcon + (integer) + + + + Picture type OtherFileIcon + + + + + KTaglib_ID3v2_AttachedPictureFrame::FrontCover + (integer) + + + + Picture type FrontCover + + + + + KTaglib_ID3v2_AttachedPictureFrame::BackCover + (integer) + + + + Picture type BackCover + + + + + KTaglib_ID3v2_AttachedPictureFrame::LeafletPage + (integer) + + + + Picture type LeafletPage + + + + + KTaglib_ID3v2_AttachedPictureFrame::Media + (integer) + + + + Picture type Media + + + + + KTaglib_ID3v2_AttachedPictureFrame::LeadArtist + (integer) + + + + Picture type LeadArtist + + + + + KTaglib_ID3v2_AttachedPictureFrame::Artist + (integer) + + + + Picture type Artist + + + + + KTaglib_ID3v2_AttachedPictureFrame::Conductor + (integer) + + + + Picture type Condutor + + + + + KTaglib_ID3v2_AttachedPictureFrame::Band + (integer) + + + + Picture type Band + + + + + KTaglib_ID3v2_AttachedPictureFrame::Composer + (integer) + + + + Picture type Composer + + + + + KTaglib_ID3v2_AttachedPictureFrame::Lyricist + (integer) + + + + Picture type Lyricist + + + + + KTaglib_ID3v2_AttachedPictureFrame::RecordingLocation + (integer) + + + + Picture type RecordingLocation + + + + + KTaglib_ID3v2_AttachedPictureFrame::DuringRecording + (integer) + + + + Picture type DuringRecording + + + + + KTaglib_ID3v2_AttachedPictureFrame::DuringPerformance + (integer) + + + + Picture type DuringPerformance + + + + + KTaglib_ID3v2_AttachedPictureFrame::MovieScreenCapture + (integer) + + + + Picture type MovieScreenCapture + + + + + KTaglib_ID3v2_AttachedPictureFrame::ColouredFish + (integer) + + + + Picture type ColouredFish + + + + + KTaglib_ID3v2_AttachedPictureFrame::Illustration + (integer) + + + + Picture type Illustration + + + + + KTaglib_ID3v2_AttachedPictureFrame::BandLogo + (integer) + + + + Picture type BandLogo + + + + + + + diff --git a/reference/ktaglib/examples.xml b/reference/ktaglib/examples.xml new file mode 100644 index 0000000000..716ba1eeb6 --- /dev/null +++ b/reference/ktaglib/examples.xml @@ -0,0 +1,47 @@ + + + + + &reftitle.examples; + + The example read an ID3v2 tag from an MP3 and saves it's attached + cover. + + + Small Taglib Example + +getID3v2Tag()->getFrameList(); +if (isset($frames['APIC'])) { + $frames['APIC']->savePicture('example.png'); +} else { + die("No picture frame"); +} +?> +]]> + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe.xml b/reference/ktaglib/id3v2attachedpictureframe.xml new file mode 100644 index 0000000000..857278ffcc --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe.xml @@ -0,0 +1,60 @@ + + + + The KTaglib_ID3v2_AttachedPictureFrame class + KTaglib_ID3v2_AttachedPictureFrame + + + + +
+ &reftitle.intro; + + Represents an ID3v2 frame that can hold a picture. + +
+ + +
+ Class synopsis + + + + KTaglib_ID3v2_AttachedPictureFrame + + + + + extends + KTagLib_ID3v2_Frame + + + +
+ + + +&reference.ktaglib.entities.id3v2attachedpictureframe; + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/getDescription.xml b/reference/ktaglib/id3v2attachedpictureframe/getDescription.xml new file mode 100644 index 0000000000..a406c20ace --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/getDescription.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::getDescription + Returns a description for the picture in a picture frame + + + &reftitle.description; + + public + string + KTaglib_ID3v2_AttachedPictureFrame::getDescription + + + + Returns the attached description for a picture frame in an ID3v2.x frame. + + + + &reftitle.returnvalues; + + Returns a description for the picture in a picture frame + + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml b/reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml new file mode 100644 index 0000000000..5022ffc011 --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/getMimeType.xml @@ -0,0 +1,58 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::getMimeType + Returns the mime type of the picture + + + &reftitle.description; + + public + string + KTaglib_ID3v2_AttachedPictureFrame::getMimeType + + + + Returns the mime type of the image represented by the attached picture frame. + + + Please notice that this method might return different types. While ID3v2.2 + have a mime type that doesn't start with "image/", ID3v2.3 and v2.4 usually + start with "image/". Therefore the method might return "image/png" for IDv2.3 frames + and just "PNG" for ID3v2.2 frames. + + + Notice that even the frame is an attached picture, the mime type might not be set + and therefore an empty string might be returned. + + + + &reftitle.returnvalues; + + Returns the mime type of the image represented by the attached picture frame. + + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/getType.xml b/reference/ktaglib/id3v2attachedpictureframe/getType.xml new file mode 100644 index 0000000000..fe3abddc25 --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/getType.xml @@ -0,0 +1,51 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::getType + Returns the type of the image + + + &reftitle.description; + + public + integer + KTaglib_ID3v2_AttachedPictureFrame::getType + + + + Returns the type of the image. + + + The ID3v2 specification allows an AttachedPictureFrame to set the type of an image. This can be e.g. FrontCover or FileIcon. Please refer to the KTagLib_ID3v2_AttachedPictureFrame class description for a list of available types. + + + + &reftitle.returnvalues; + + Returns the integer representation of the type. + + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/savePicture.xml b/reference/ktaglib/id3v2attachedpictureframe/savePicture.xml new file mode 100644 index 0000000000..92e788daa5 --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/savePicture.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::savePicture + Saves the picture to a file + + + &reftitle.description; + + public + boolean + KTaglib_ID3v2_AttachedPictureFrame::savePicture + stringfilename + + + Saves the attached picture to the given filename. + + + + &reftitle.returnvalues; + + Returns true on success, otherwise false + + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml b/reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml new file mode 100644 index 0000000000..2ad523623f --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/setMimeType.xml @@ -0,0 +1,42 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::setMimeType + Set's the mime type of the picture + + + &reftitle.description; + + public + void + KTaglib_ID3v2_AttachedPictureFrame::getMimeType + stringtype + + + Sets the mime type of the image. This should in most cases be "image/png" or "image/jpeg". + + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/setPicture.xml b/reference/ktaglib/id3v2attachedpictureframe/setPicture.xml new file mode 100644 index 0000000000..1309aae3ec --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/setPicture.xml @@ -0,0 +1,51 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::setPicture + Sets the frame picture to the given image + + + &reftitle.description; + + public + boolean + KTaglib_ID3v2_AttachedPictureFrame::setPicture + stringfilename + + + Sets the picture to the give image. The image is loaded from the given filename. + Please note that the picture is not saved unless you call the save method of the + corresponding file object. + + + + &reftitle.returnvalues; + + Returns true on success, otherwise false + + + + + + + diff --git a/reference/ktaglib/id3v2attachedpictureframe/setType.xml b/reference/ktaglib/id3v2attachedpictureframe/setType.xml new file mode 100644 index 0000000000..09d894754d --- /dev/null +++ b/reference/ktaglib/id3v2attachedpictureframe/setType.xml @@ -0,0 +1,42 @@ + + + + + KTaglib_ID3v2_AttachedPictureFrame::setType + Set the type of the image + + + &reftitle.description; + + public + void + KTaglib_ID3v2_AttachedPictureFrame::setType + integertype + + + Sets the type of the image. This can be e.g. FrontCover or FileIcon. Please refer to the KTaglib_ID3v2_AttachedPictureFrame class description for a list of available types and their constant mappings. + + + + + + diff --git a/reference/ktaglib/id3v2frame.xml b/reference/ktaglib/id3v2frame.xml new file mode 100644 index 0000000000..eac4955734 --- /dev/null +++ b/reference/ktaglib/id3v2frame.xml @@ -0,0 +1,61 @@ + + + + The KTagLib_ID3v2_Frame class + KTaglib_ID3v2_Frame + + + + +
+ &reftitle.intro; + +The base class for ID3v2 frames. ID3v2 tags are separated in various +specialized frames. Some frames can exists multiple times. + +
+ + +
+ Class synopsis + + + + KTagLib_ID3v2_Frame + + + + + extends + KTagLib_Tag + + + +
+ + + +&reference.ktaglib.entities.id3v2frame; + + + + diff --git a/reference/ktaglib/id3v2frame/getSize.xml b/reference/ktaglib/id3v2frame/getSize.xml new file mode 100644 index 0000000000..697cacc568 --- /dev/null +++ b/reference/ktaglib/id3v2frame/getSize.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_ID3v2_Frame::getSize + Returns the size of the frame in bytes + + + &reftitle.description; + + public + integer + KTaglib_ID3v2_Frame::getSize + + + + Returns the size of the frame in bytes. Please refer to id3.org to see what + ID3v2 frames are and how they are defined. + + + + &reftitle.returnvalues; + + Returns the size of the frame in bytes + + + + + diff --git a/reference/ktaglib/id3v2frame/toString.xml b/reference/ktaglib/id3v2frame/toString.xml new file mode 100644 index 0000000000..085c9d1401 --- /dev/null +++ b/reference/ktaglib/id3v2frame/toString.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_ID3v2_Frame::__toString + Returns a string representation of the frame + + + &reftitle.description; + + public + string + KTaglib_ID3v2_Frame::__toString + + + + Returns a string representation of the frame. This might be just the + frame id, but might contain more information. Please see the ktaglib + documentation for more information + + + + &reftitle.returnvalues; + + Returns a string representation of the frame. + + + + + diff --git a/reference/ktaglib/id3v2tag.xml b/reference/ktaglib/id3v2tag.xml new file mode 100644 index 0000000000..b90c7b4fc0 --- /dev/null +++ b/reference/ktaglib/id3v2tag.xml @@ -0,0 +1,61 @@ + + + + The KTagLib_ID3v2_Tag class + KTaglib_ID3v2_Tag + + + + +
+ &reftitle.intro; + + Represents and ID3v2 tag. It provides a list of ID3v2 frames and can be uesd + to add and remove additional frames. + +
+ + +
+ Class synopsis + + + + KTagLib_ID3v2_Tag + + + + + extends + KTagLib_Tag + + + +
+ + + +&reference.ktaglib.entities.id3v2tag; + + + + diff --git a/reference/ktaglib/id3v2tag/addFrame.xml b/reference/ktaglib/id3v2tag/addFrame.xml new file mode 100644 index 0000000000..05e318c079 --- /dev/null +++ b/reference/ktaglib/id3v2tag/addFrame.xml @@ -0,0 +1,48 @@ + + + + + KTaglib_ID3v2_Tag::addFrame + Add a frame to the ID3v2 tag + + + &reftitle.description; + + public + boolean + KTaglib_ID3v2_Tag::addFrame + + + + Adds a frame to the ID3v2 tag. The frame must be a valid KTagLib_ID3v2_Frame object. + To save the tag, the save function needs to be invoked. + + + + &reftitle.returnvalues; + + Returns true on success, otherwise false. + + + + + diff --git a/reference/ktaglib/id3v2tag/getFrameList.xml b/reference/ktaglib/id3v2tag/getFrameList.xml new file mode 100644 index 0000000000..c61790c58e --- /dev/null +++ b/reference/ktaglib/id3v2tag/getFrameList.xml @@ -0,0 +1,47 @@ + + + + + KTaglib_ID3v2_Tag::getFrameList + Returns an array of ID3v2 frames, associated with the ID3v2 tag + + + &reftitle.description; + + public + integer + KTaglib_ID3v2_Tag::getFrameList + + + + Returns an array of ID3v2 frames, associated with the ID3v2 tag. + + + + &reftitle.returnvalues; + + Return an array of KTaglib_ID3v2_Frame objects + + + + + diff --git a/reference/ktaglib/mpegfile.xml b/reference/ktaglib/mpegfile.xml new file mode 100644 index 0000000000..e9a65d3b1c --- /dev/null +++ b/reference/ktaglib/mpegfile.xml @@ -0,0 +1,59 @@ + + + + The KTagLib_MPEG_File class + KTaglib_MPEG_File + + + + +
+ &reftitle.intro; + +Represents an MPEG file. MPEG files can have ID3v1, ID3v2 tags and audio properties. + +
+ + +
+ Class synopsis + + + + KTagLib_MPEG_File + + + + + KTagLib_MPEG_File + + + +
+ + + +&reference.ktaglib.entities.mpegfile; + + + + diff --git a/reference/ktaglib/mpegfile/construct.xml b/reference/ktaglib/mpegfile/construct.xml new file mode 100644 index 0000000000..4d24150710 --- /dev/null +++ b/reference/ktaglib/mpegfile/construct.xml @@ -0,0 +1,72 @@ + + + + + KTaglib_MPEG_File::__construct + Opens a new file + + + &reftitle.description; + + KTaglib_MPEG_File::__construct + stringfilename + + + Opens a new MPEG file. + + + + + &reftitle.parameters; + + + + filename + + + The file to read + + + + + + + + &reftitle.examples; + + + Opens a new MP3 file and read the title + +getID3v1Tag()->getTitle(); +?> +]]> + + + + + + + + diff --git a/reference/ktaglib/mpegfile/getAudioProperties.xml b/reference/ktaglib/mpegfile/getAudioProperties.xml new file mode 100644 index 0000000000..a412e5c766 --- /dev/null +++ b/reference/ktaglib/mpegfile/getAudioProperties.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_MPEG_File::getAudioProperties + Returns an object that provides access to the audio properties + + + &reftitle.description; + + public + KTaglib_MPEG_File: + KTaglib_MPEG_File::getAudioProperties + + + + Returns an object that provides access to the audio properties of + the mpeg file. + + + + + &reftitle.returnvalues; + + Returns an KTaglib_MPEG_AudioProperties object or false. + + + + + diff --git a/reference/ktaglib/mpegfile/getID3v1Tag.xml b/reference/ktaglib/mpegfile/getID3v1Tag.xml new file mode 100644 index 0000000000..2681df3487 --- /dev/null +++ b/reference/ktaglib/mpegfile/getID3v1Tag.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_MPEG_File::getID3v1Tag + Returns an object representing an ID3v1 tag + + + &reftitle.description; + + public + KTaglib_ID3v1_Tag + KTaglib_MPEG_File::getID3v1Tag + + + + Returns an object that represents an ID3v1 tag, which can be used + to get information about the ID3v1 tag. + + + + + &reftitle.returnvalues; + + Returns an KTaglib_MPEG_ID3v1Tag object or false if there is no ID3v1 tag. + + + + + diff --git a/reference/ktaglib/mpegfile/getID3v2Tag.xml b/reference/ktaglib/mpegfile/getID3v2Tag.xml new file mode 100644 index 0000000000..03ffca3bc4 --- /dev/null +++ b/reference/ktaglib/mpegfile/getID3v2Tag.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_MPEG_File::getID3v2Tag + Returns a ID3v2 object + + + &reftitle.description; + + public + KTaglib_ID3v2_Tag + KTaglib_MPEG_File::getID3v2Tag + + + + Returns a ID3v2 object for the mpeg file. If no ID3v2 Tag is present, an + KTaglib_TagNotFoundException is thrown. + + + + &reftitle.returnvalues; + + Returns the KTaglib_ID3v2_Tag object of the MPEG file or false if there is +no ID3v2 tag + + + + + diff --git a/reference/ktaglib/setup.xml b/reference/ktaglib/setup.xml new file mode 100644 index 0000000000..60825d46b0 --- /dev/null +++ b/reference/ktaglib/setup.xml @@ -0,0 +1,39 @@ + + + + + &reftitle.setup; + + +
+ &reftitle.required; + &no.requirement; +
+ + + + &reference.ktaglib.configure; + + + + + diff --git a/reference/ktaglib/tag.xml b/reference/ktaglib/tag.xml new file mode 100644 index 0000000000..dc1c0432a0 --- /dev/null +++ b/reference/ktaglib/tag.xml @@ -0,0 +1,59 @@ + + + + The KTaglib_Tag class + KTaglib_Tag + + + + +
+ &reftitle.intro; + + Base class for ID3v1 or ID3v2 tags + +
+ + +
+ Class synopsis + + + + KTaglib_Tag + + + + + KTaglib_Tag + + + +
+ + + +&reference.ktaglib.entities.tag; + + + + diff --git a/reference/ktaglib/tag/getAlbum.xml b/reference/ktaglib/tag/getAlbum.xml new file mode 100644 index 0000000000..2333e75eef --- /dev/null +++ b/reference/ktaglib/tag/getAlbum.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getAlbum + Returns the title string from a ID3 tag + + + &reftitle.description; + + public + string + KTaglib_Tag::getAlbum + + + + Returns the album string of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the album string + + + + + + diff --git a/reference/ktaglib/tag/getArtist.xml b/reference/ktaglib/tag/getArtist.xml new file mode 100644 index 0000000000..28df1e618e --- /dev/null +++ b/reference/ktaglib/tag/getArtist.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getArtist + Returns the artist string from a ID3 tag + + + &reftitle.description; + + public + string + KTaglib_Tag::getArtist + + + + Returns the artist string of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the artist string + + + + + + diff --git a/reference/ktaglib/tag/getComment.xml b/reference/ktaglib/tag/getComment.xml new file mode 100644 index 0000000000..51bba2ae51 --- /dev/null +++ b/reference/ktaglib/tag/getComment.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getComment + Returns the comment from a ID3 tag + + + &reftitle.description; + + public + string + KTaglib_Tag::getComment + + + + Returns the comment of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the comment string + + + + + + diff --git a/reference/ktaglib/tag/getGenre.xml b/reference/ktaglib/tag/getGenre.xml new file mode 100644 index 0000000000..8047fcb13a --- /dev/null +++ b/reference/ktaglib/tag/getGenre.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getGenre + Returns the genre from a ID3 tag + + + &reftitle.description; + + public + string + KTaglib_Tag::getGenre + + + + Returns the genre of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the genre string + + + + + + diff --git a/reference/ktaglib/tag/getTitle.xml b/reference/ktaglib/tag/getTitle.xml new file mode 100644 index 0000000000..138ca9615a --- /dev/null +++ b/reference/ktaglib/tag/getTitle.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getTitle + Returns the title string from a ID3 tag + + + &reftitle.description; + + public + string + KTaglib_Tag::getTitle + + + + Returns the title string of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the title string + + + + + + diff --git a/reference/ktaglib/tag/getTrack.xml b/reference/ktaglib/tag/getTrack.xml new file mode 100644 index 0000000000..3990693d99 --- /dev/null +++ b/reference/ktaglib/tag/getTrack.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getTrack + Returns the track number from a ID3 tag + + + &reftitle.description; + + public + integer + KTaglib_Tag::getTrack + + + + Returns the track number of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the track number as an integer + + + + + + diff --git a/reference/ktaglib/tag/getYear.xml b/reference/ktaglib/tag/getYear.xml new file mode 100644 index 0000000000..6df29dc016 --- /dev/null +++ b/reference/ktaglib/tag/getYear.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::getYear + Returns the year from a ID3 tag + + + &reftitle.description; + + public + integer + KTaglib_Tag::getYear + + + + Returns the year of an ID3 tag. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns the year as an integer + + + + + + diff --git a/reference/ktaglib/tag/isEmpty.xml b/reference/ktaglib/tag/isEmpty.xml new file mode 100644 index 0000000000..81cfcf4441 --- /dev/null +++ b/reference/ktaglib/tag/isEmpty.xml @@ -0,0 +1,49 @@ + + + + + KTaglib_Tag::isEmpty + Returns true if the tag is empty + + + &reftitle.description; + + public + boolean + KTaglib_Tag::isEmpty + + + + Returns true if the tag exists, but is empty. This method is implemented + in ID3v1 and ID3v2 tags. + + + + &reftitle.returnvalues; + + Returns true if the tag is empty, otherwise false. + + + + + +