![]() |
![]() |
![]() |
Grilo Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy |
#include <grilo.h> struct GrlConfig; struct GrlConfigClass; #define GRL_CONFIG_KEY_APIKEY #define GRL_CONFIG_KEY_APIKEY_BLOB #define GRL_CONFIG_KEY_APISECRET #define GRL_CONFIG_KEY_APITOKEN #define GRL_CONFIG_KEY_PASSWORD #define GRL_CONFIG_KEY_PLUGIN #define GRL_CONFIG_KEY_SOURCE #define GRL_CONFIG_KEY_USERNAME GrlConfig * grl_config_new (const gchar *plugin
,const gchar *source
); gchar * grl_config_get_api_key (GrlConfig *config
); guint8 * grl_config_get_api_key_blob (GrlConfig *config
,gsize *size
); gchar * grl_config_get_api_secret (GrlConfig *config
); gchar * grl_config_get_api_token (GrlConfig *config
); guint8 * grl_config_get_binary (GrlConfig *config
,const gchar *param
,gsize *size
); gboolean grl_config_get_boolean (GrlConfig *config
,const gchar *param
); gfloat grl_config_get_float (GrlConfig *config
,const gchar *param
); gint grl_config_get_int (GrlConfig *config
,const gchar *param
); gchar * grl_config_get_password (GrlConfig *config
); gchar * grl_config_get_plugin (GrlConfig *config
); gchar * grl_config_get_source (GrlConfig *config
); gchar * grl_config_get_string (GrlConfig *config
,const gchar *param
); gchar * grl_config_get_username (GrlConfig *config
); gboolean grl_config_has_param (GrlConfig *config
,const gchar *param
); void grl_config_set (GrlConfig *config
,const gchar *param
,const GValue *value
); void grl_config_set_api_key (GrlConfig *config
,const gchar *key
); void grl_config_set_api_key_blob (GrlConfig *config
,const guint8 *blob
,gsize size
); void grl_config_set_api_secret (GrlConfig *config
,const gchar *secret
); void grl_config_set_api_token (GrlConfig *config
,const gchar *token
); void grl_config_set_binary (GrlConfig *config
,const gchar *param
,const guint8 *blob
,gsize size
); void grl_config_set_boolean (GrlConfig *config
,const gchar *param
,gboolean value
); void grl_config_set_float (GrlConfig *config
,const gchar *param
,gfloat value
); void grl_config_set_int (GrlConfig *config
,const gchar *param
,gint value
); void grl_config_set_password (GrlConfig *config
,const gchar *password
); void grl_config_set_plugin (GrlConfig *config
,const gchar *plugin
); void grl_config_set_source (GrlConfig *config
,const gchar *source
); void grl_config_set_string (GrlConfig *config
,const gchar *param
,const gchar *value
); void grl_config_set_username (GrlConfig *config
,const gchar *username
);
This class is used to configure plugins during a session.
Pre-defined settings are read from plugin specific configuration files. The settings can be changed to properly setup the session, but are not persistent. Changes are local to each GrlConfig instance.
GrlConfig * grl_config_new (const gchar *plugin
,const gchar *source
);
Creates a new data config object that will be associated with a plugin
(if source
is NULL), or a specific source spawned from a plugin (if
source
is not NULL). The latter may be useful for plugins
spawning various sources, each one needing a different configuration.
|
plugin id for this configuration |
|
source id for this configuration. [allow-none] |
Returns : |
a newly-allocated data config. The data config associated with the plugin should not be freed until the plugin has been unloaded. [transfer none] |
Since 0.1.4
gchar * grl_config_get_api_key (GrlConfig *config
);
|
the config instance |
Returns : |
the webservice API key |
Since 0.1.4
guint8 * grl_config_get_api_key_blob (GrlConfig *config
,gsize *size
);
|
the config instance |
|
pointer to size of data |
Returns : |
the binary API key, size will reflect the size of the buffer |
Since 0.1.9
gchar * grl_config_get_api_secret (GrlConfig *config
);
|
the config instance |
Returns : |
the webservice API passphrase |
Since 0.1.4
gchar * grl_config_get_api_token (GrlConfig *config
);
|
the config instance |
Returns : |
the webservice API token |
Since 0.1.4
guint8 * grl_config_get_binary (GrlConfig *config
,const gchar *param
,gsize *size
);
Gets the value of param
encoded as base64. If size
is not NULL
, it puts
there the size of the value.
|
the config instance |
|
a binary type parameter |
|
place for size of value. [allow-none] |
Returns : |
param value |
Since 0.1.9
gboolean grl_config_get_boolean (GrlConfig *config
,const gchar *param
);
|
the config instance |
|
a boolean type parameter |
Returns : |
param value |
Since 0.1.8
gfloat grl_config_get_float (GrlConfig *config
,const gchar *param
);
|
the config instance |
|
a float type parameter |
Returns : |
param value |
Since 0.1.5
gint grl_config_get_int (GrlConfig *config
,const gchar *param
);
|
the config instance |
|
an integer type parameter |
Returns : |
param value |
Since 0.1.5
gchar * grl_config_get_password (GrlConfig *config
);
|
the config instance |
Returns : |
the password |
Since 0.1.8
gchar * grl_config_get_plugin (GrlConfig *config
);
|
the config instance |
Returns : |
the plugin id |
Since 0.1.4
gchar * grl_config_get_source (GrlConfig *config
);
|
the config instance |
Returns : |
the source id |
gchar * grl_config_get_string (GrlConfig *config
,const gchar *param
);
|
the config instance |
|
a string type paramter |
Returns : |
param value |
Since 0.1.5
gchar * grl_config_get_username (GrlConfig *config
);
|
the config instance |
Returns : |
the username |
Since 0.1.8
gboolean grl_config_has_param (GrlConfig *config
,const gchar *param
);
|
the config instance |
|
the param |
Returns : |
TRUE if params has a defined value within config , FALSE
otherwise. |
Since 0.1.8
void grl_config_set (GrlConfig *config
,const gchar *param
,const GValue *value
);
Set param
value
.
|
the config instance |
|
a parameter |
|
value |
Since 0.1.5
void grl_config_set_api_key (GrlConfig *config
,const gchar *key
);
Set the webservice API key in the configuration
|
the config instance |
|
the API key |
Since 0.1.4
void grl_config_set_api_key_blob (GrlConfig *config
,const guint8 *blob
,gsize size
);
Set the binary API key in the configuration
|
the config instance |
|
the binary API key blob |
|
the size of the blob |
Since 0.1.9
void grl_config_set_api_secret (GrlConfig *config
,const gchar *secret
);
Set the webservice passphrase in the configuration
|
the config instance |
|
the webservice passphrase |
Since 0.1.4
void grl_config_set_api_token (GrlConfig *config
,const gchar *token
);
Set the webservice API token in the configuration
|
the config instance |
|
the API token |
Since 0.1.4
void grl_config_set_binary (GrlConfig *config
,const gchar *param
,const guint8 *blob
,gsize size
);
Set param
value.
|
the config instance |
|
a binary type parameter |
|
a base64 encoded binary value |
|
size of value
|
Since 0.1.9
void grl_config_set_boolean (GrlConfig *config
,const gchar *param
,gboolean value
);
Set param
value
.
|
the config instance |
|
a boolean type parameter |
|
a value |
Since 0.1.8
void grl_config_set_float (GrlConfig *config
,const gchar *param
,gfloat value
);
Set param
value
.
|
the config instance |
|
a float type parameter |
|
a value |
Since 0.1.5
void grl_config_set_int (GrlConfig *config
,const gchar *param
,gint value
);
Set param
value
.
|
the config instance |
|
an integer type parameter |
|
a value |
Since 0.1.5
void grl_config_set_password (GrlConfig *config
,const gchar *password
);
Set the password in the configuration
|
the config instance |
|
the password |
Since 0.1.8
void grl_config_set_plugin (GrlConfig *config
,const gchar *plugin
);
Set the plugin key in the configuration
|
the config instance |
|
the plugin id |
Since 0.1.4
void grl_config_set_source (GrlConfig *config
,const gchar *source
);
Set the source key in the configuration
|
the config instance |
|
the source id |
Since 0.1.4
void grl_config_set_string (GrlConfig *config
,const gchar *param
,const gchar *value
);
Set param
value
.
|
the config instance |
|
a string type parameter |
|
a value |
Since 0.1.5
void grl_config_set_username (GrlConfig *config
,const gchar *username
);
Set the username in the configuration
|
the config instance |
|
the username |
Since 0.1.8