Syndication::Enclosure
#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.
Definition at line 31 of file enclosure.h.
Constructor & Destructor Documentation
◆ ~Enclosure()
|
virtual |
destructor
Definition at line 12 of file enclosure.cpp.
Member Function Documentation
◆ debugInfo()
|
virtual |
description of this enclosure for debugging purposes
- Returns
- debug string
Definition at line 16 of file enclosure.cpp.
◆ duration()
|
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
Implemented in Syndication::EnclosureAtomImpl, and Syndication::EnclosureRSS2Impl.
◆ isNull()
|
pure virtual |
returns whether this enclosure is a null object.
Implemented in Syndication::EnclosureAtomImpl, and Syndication::EnclosureRSS2Impl.
◆ length()
|
pure virtual |
returns the length of the linked file in bytes
- Returns
- the length of the file in bytes, 0 if not specified
Implemented in Syndication::EnclosureAtomImpl, and Syndication::EnclosureRSS2Impl.
◆ title()
|
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.
Implemented in Syndication::EnclosureAtomImpl, and Syndication::EnclosureRSS2Impl.
◆ type()
|
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
Implemented in Syndication::EnclosureAtomImpl, and Syndication::EnclosureRSS2Impl.
◆ url()
|
pure virtual |
The URL of the linked resource (required).
Implemented in Syndication::EnclosureAtomImpl, and Syndication::EnclosureRSS2Impl.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Dec 6 2024 12:02:22 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.