Rygel – librygel-server Reference Manual

# Rygel

## Description:

## Content:

### Interfaces:

- SearchableContainer - The base class for searchable containers.
- TrackableContainer - The base class for containers that provide automatic change tracking.
- TrackableItem
- VisualItem - An interface representing visual properties of an item stored in a file.
- WritableContainer - This interface should be implemented by 'writable' containers - ones that allow adding (via upload), removal and editing of items directly under them. Currently, only addition and removal are supported.
- DataSource - Interface for all data streams provided by a #RygelMediaEngine.
- UpdatableObject - This interface should be implemented by 'updatable' objects - ones that allow modifying their own metadata in some persistent storage.

### Classes:

- AudioItem - Represents an audio item contained in a file.
- ImageItem - Represents an image item.
- LogicalExpression - This is a parsed UPnP search expression consisting of two other search expressions joined by a boolean operator such as AND or OR.
- MediaArtStore - This maps RygelMusicItem objects to their cached cover art, implementing the GNOME MediaArt storage specification.
- MediaObjects - An array list that keeps media objects.
- MusicItem - Represents a music item.
- PhotoItem - Represents a photo item.
- RelationalExpression - This is a parsed UPnP search expression consisting of two strings joined by a relational operator such as such <, <=, ==, !=, >, >=, derivedFrom or exists.
- SimpleContainer - A simple implementation of RygelMediaContainer that keeps all RygelMediaObjects in memory. You should add children via rygel_simple_container_add_child_item().
- Subtitle - Represents a subtitle for a video.
- Thumbnail - Represents a picture or video thumbnail.
- VideoItem - Represents a video item.
- MediaContainer - This is a container (folder) for media items and child containers.
- MediaItem - Abstract class representing a MediaItem
- MediaFileItem - Represents a file- accessible or http-accessible media item (music file, image file, video file, etc) with some pre-established metadata or a content placeholder for uploaded content.
- MediaObject - Represents a media object (container or item).
- MediaResource - Represents a media resource (Music, Video, Image, etc).
- MediaServerPlugin - This is the base class for every Rygel implementation of a UPnP media server. It should be used either for a real plug-in for the Rygel process or used in-process via the librygel-server API.
- SearchExpression - Represents a SearchExpression tree.
- MediaServer - This class may be used to implement in- process UPnP-AV media servers.
- MediaEngine - This is the base class for media engines that contain knowledge about the streaming and transformational capabilites of the media library in use.
- HTTPSeekRequest - HTTPSeekRequest is an abstract base for a variety of seek request types.
- PlaylistItem - Represents a playlist item.
- ContentDirectory - Basic implementation of UPnP ContentDirectory service version 2. Most often plugins will provide a child of this class. The inheriting classes should override create_root_container method.
- HTTPByteSeekRequest
- HTTPByteSeekResponse
- HTTPGetHandler - HTTP GET request handler interface.
- HTTPGet - Responsible for handling HTTP GET & HEAD client requests.
- HTTPItemURI
- HTTPRequest - Base class for HTTP client requests.
- HTTPResponse
- HTTPResponseElement - This abstract class represents an entity that can contribute response headers to a HTTP request.
- HTTPServer
- HTTPTimeSeekRequest - This class represents a DLNA TimeSeekRange request.
- HTTPTimeSeekResponse
- Serializer - Proxy class hiding the different serializers (DIDL, DIDL_S, M3U) behind a single implementation.
- PlaySpeed - This is a container for a PlaySpeed value.
- PlaySpeedRequest - This class represents a DLNA PlaySpeed request (PlaySpeed.dlna.org)
- PlaySpeedResponse - This class represents a DLNA PlaySpeed response (PlaySpeed.dlna.org)
- DTCPCleartextRequest
- DTCPCleartextResponse
- DLNAAvailableSeekRangeRequest - This class represents a DLNA getAvailableSeekRange request.
- DLNAAvailableSeekRangeResponse

### Enums:

- LogicalOperator
- ObjectEventType
- SerializerType

### Error domains:

- WritableContainerError
- MediaEngineError
- HTTPSeekRequestError - Various errors that can be thrown when attempting to seek into a stream.
- DataSourceError
- HTTPRequestError
- PlaySpeedError