RygelMediaRendererPlugin

RygelMediaRendererPlugin — This is the base class for every Rygel UPnP renderer plugin.

Synopsis

#define             RYGEL_TYPE_MEDIA_RENDERER_PLUGIN
RygelMediaPlayer *  rygel_media_renderer_plugin_get_player
                                                        (RygelMediaRendererPlugin *self);
gchar *             rygel_media_renderer_plugin_get_protocol_info
                                                        (RygelMediaRendererPlugin *self);
RygelMediaRendererPlugin * rygel_media_renderer_plugin_new
                                                        (const gchar *name,
                                                         const gchar *title,
                                                         const gchar *description,
                                                         RygelPluginCapabilities capabilities);
struct              RygelMediaRendererPlugin;
struct              RygelMediaRendererPluginClass;

Object Hierarchy

  GObject
   +----GUPnPResourceFactory
         +----RygelPlugin
               +----RygelMediaRendererPlugin

Description

This class is useful when implementing Rygel renderer plugins.

Renderer plugins should also implement their own RygelMediaPlayer and return an instance of it from their get_player() implementation.

Details

RYGEL_TYPE_MEDIA_RENDERER_PLUGIN

#define RYGEL_TYPE_MEDIA_RENDERER_PLUGIN (rygel_media_renderer_plugin_get_type ())

The type for RygelMediaRendererPlugin.


rygel_media_renderer_plugin_get_player ()

RygelMediaPlayer *  rygel_media_renderer_plugin_get_player
                                                        (RygelMediaRendererPlugin *self);

self :

the RygelMediaRendererPlugin instance

rygel_media_renderer_plugin_get_protocol_info ()

gchar *             rygel_media_renderer_plugin_get_protocol_info
                                                        (RygelMediaRendererPlugin *self);

self :

the RygelMediaRendererPlugin instance

rygel_media_renderer_plugin_new ()

RygelMediaRendererPlugin * rygel_media_renderer_plugin_new
                                                        (const gchar *name,
                                                         const gchar *title,
                                                         const gchar *description,
                                                         RygelPluginCapabilities capabilities);

Create an instance of the plugin.

name :

The non-human-readable name for the plugin and its renderer, used in UPnP messages and in the Rygel configuration file. [in]

title :

An optional human-readable name (friendlyName) of the UPnP renderer provided by the plugin. If the title is empty then the name will be used. [in][allow-none]

description :

An optional human-readable description (modelDescription) of the UPnP renderer provided by the plugin. [in][allow-none]

struct RygelMediaRendererPlugin

struct RygelMediaRendererPlugin;

This is the base class for every Rygel UPnP renderer plugin.

This class is useful when implementing Rygel renderer plugins.

Renderer plugins should also implement their own RygelMediaPlayer and return an instance of it from their get_player() implementation.


struct RygelMediaRendererPluginClass

struct RygelMediaRendererPluginClass {
	RygelPluginClass parent_class;
	RygelMediaPlayer* (*get_player) (RygelMediaRendererPlugin* self);
};

The class structure for RYGEL_TYPE_MEDIA_RENDERER_PLUGIN. All the fields in this structure are private and should never be accessed directly.

RygelPluginClass parent_class;

the parent class structure

get_player ()

virtual method called by rygel_media_renderer_plugin_get_player()