Syndication Library
#include <enclosure.h>
Public Member Functions | |
virtual | ~Enclosure () |
virtual QString | debugInfo () const |
virtual uint | duration () const =0 |
virtual bool | isNull () const =0 |
virtual uint | length () const =0 |
virtual QString | title () const =0 |
virtual QString | type () const =0 |
virtual QString | url () const =0 |
Detailed Description
An enclosure describes a (media) file available on the net.
Most of the time, enclosures are used for "podcasts", i.e. audio files announced and distributed via syndication.
Constructor & Destructor Documentation
Syndication::Enclosure::~Enclosure | ( | ) | [virtual] |
destructor
Definition at line 29 of file enclosure.cpp.
Member Function Documentation
QString Syndication::Enclosure::debugInfo | ( | ) | const [virtual] |
description of this enclosure for debugging purposes
- Returns:
- debug string
Definition at line 33 of file enclosure.cpp.
virtual uint Syndication::Enclosure::duration | ( | ) | const [pure virtual] |
for audio/video files, the duration of the file in seconds
- Returns:
- the duration of the file in seconds, or 0 if not specified
virtual bool Syndication::Enclosure::isNull | ( | ) | const [pure virtual] |
returns whether this enclosure is a null object.
virtual uint Syndication::Enclosure::length | ( | ) | const [pure virtual] |
returns the length of the linked file in bytes
- Returns:
- the length of the file in bytes, 0 if not specified
virtual QString Syndication::Enclosure::title | ( | ) | const [pure virtual] |
title of the enclosure.
This is a human-readable description of the linked file. If available, the title should be used in user interfaces instead of the URL. If no title is set (e.g., RSS2 enclosures don't have titles), use url() as fallback.
- Returns:
- title describing the enclosure, or a null string if not specified.
virtual QString Syndication::Enclosure::type | ( | ) | const [pure virtual] |
mimetype of the enclosure.
TODO: link mimetype specs
Examples are "audio/mpeg"
for MP3, or "application/pdf"
for PDF.
- Returns:
- the mimetype of the file, or a null string if not specified
virtual QString Syndication::Enclosure::url | ( | ) | const [pure virtual] |
The URL of the linked resource (required).
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Aug 27 2012 22:08:47 by doxygen 1.7.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.