Syndication::Enclosure

Syndication::Enclosure Class Referenceabstract

#include <enclosure.h>

Inheritance diagram for Syndication::Enclosure:

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.

Author
Frank Osterfeld

Definition at line 32 of file enclosure.h.

Constructor & Destructor Documentation

Syndication::Enclosure::~Enclosure ( )
virtual

destructor

Definition at line 15 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 19 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

Implemented in Syndication::EnclosureRSS2Impl, and Syndication::EnclosureAtomImpl.

virtual bool Syndication::Enclosure::isNull ( ) const
pure virtual

returns whether this enclosure is a null object.

Implemented in Syndication::EnclosureRSS2Impl, and Syndication::EnclosureAtomImpl.

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

Implemented in Syndication::EnclosureRSS2Impl, and Syndication::EnclosureAtomImpl.

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.

Implemented in Syndication::EnclosureRSS2Impl, and Syndication::EnclosureAtomImpl.

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

Implemented in Syndication::EnclosureRSS2Impl, and Syndication::EnclosureAtomImpl.

virtual QString Syndication::Enclosure::url ( ) const
pure virtual

The URL of the linked resource (required).

Implemented in Syndication::EnclosureRSS2Impl, and Syndication::EnclosureAtomImpl.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Aug 8 2020 23:01:06 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.