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 that visual (video and image) items must implement.
- 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.
- DLNAProfile - Data class representing a DLNA profile. It contains the name and the corresponding DLNA mime type.
- 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 and the simplified version that Banshee uses.
- 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 - Represents a media item (Music, Video or Image).
- MediaObject - Represents a media object (container or item).
- 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.
- TranscodeManager - Responsible for management of all transcoders: # Gets the appropriate transcoder given a transcoding target. # Provide all possible transcoding resources for items.
- Transcoder - The base Transcoder class. Each implementation derives from it and must implement create_source() and get_distance().
- 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 (optionally) the transcoding and seeking capabilites of the media library in use. Derived classes also instantiate any transcoding objects supported by the media engine and specify the list of media formats the engine is capable of playing.
- HTTPSeek - HTTPSeek is an abstract representation of a ranged HTTP request.
- PlaylistItem - Represents a playlist item.

### Enums:

- LogicalOperator -
- ObjectEventType -
- HTTPSeekType -

### Error domains:

- WritableContainerError -
- MediaEngineError -
- HTTPSeekError -
- DataSourceError -