grl_operation_options_new ()

GrlOperationOptions *
grl_operation_options_new (GrlCaps *caps);

Creates a new GrlOperationOptions object.

Since: 0.2.0

grl_operation_options_copy ()

GrlOperationOptions *
grl_operation_options_copy (GrlOperationOptions *options);

Since: 0.2.0

grl_operation_options_get_count ()

gint
grl_operation_options_get_count (GrlOperationOptions *options);

Get the count option, that is, the number of elements to retrieve in an operation done with options .

Since: 0.2.0

grl_operation_options_get_resolution_flags ()

GrlResolutionFlags
grl_operation_options_get_resolution_flags
                               (GrlOperationOptions *options);

Since: 0.2.12

grl_operation_options_get_key_filter ()

GValue *
grl_operation_options_get_key_filter (GrlOperationOptions *options,
                                      GrlKeyID key);

Since: 0.2.0

grl_operation_options_get_key_filter_list ()

GList *
grl_operation_options_get_key_filter_list
                               (GrlOperationOptions *options);

Since: 0.2.0

grl_operation_options_get_key_range_filter ()

void
grl_operation_options_get_key_range_filter
                               (GrlOperationOptions *options,
                                GrlKeyID key,
                                GValue **min_value,
                                GValue **max_value);

Stores the limits of the range in the filter for key in min_value and max_value . If some of the values has no limit, it will set a NULL.

Since: 0.2.0

grl_operation_options_get_key_range_filter_list ()

GList *
grl_operation_options_get_key_range_filter_list
                               (GrlOperationOptions *options);

Since: 0.2.0

grl_operation_options_get_skip ()

guint
grl_operation_options_get_skip (GrlOperationOptions *options);

Get the skip option, that is, the number of elements to skip before retrieving media items in an operation done with options .

Since: 0.2.0

grl_operation_options_get_type_filter ()

GrlTypeFilter
grl_operation_options_get_type_filter (GrlOperationOptions *options);

Since: 0.2.0

grl_operation_options_obey_caps ()

gboolean
grl_operation_options_obey_caps (GrlOperationOptions *options,
                                 GrlCaps *caps,
                                 GrlOperationOptions **supported_options,
                                 GrlOperationOptions **unsupported_options);

Check whether options obey to caps . Optionally provide the options that match (respectively don't match) caps in supported_options (respectively unsupported_options ). This would typically (but not necessarily) be used with a GrlOperationOptions instance that was created with NULL caps.

Since: 0.2.0

grl_operation_options_set_count ()

gboolean
grl_operation_options_set_count (GrlOperationOptions *options,
                                 gint count);

Set the count option for an operation. Will only succeed if count obey to the inherent capabilities of options .

Since: 0.2.0

grl_operation_options_set_resolution_flags ()

gboolean
grl_operation_options_set_resolution_flags
                               (GrlOperationOptions *options,
                                GrlResolutionFlags flags);

Set the resolution flags for an operation. Will only succeed if flags obey to the inherent capabilities of options .

Since: 0.2.12

grl_operation_options_set_key_filter_dictionary ()

gboolean
grl_operation_options_set_key_filter_dictionary
                               (GrlOperationOptions *options,
                                GHashTable *filters);

[rename-to grl_operation_options_set_key_filters]

Since: 0.2.0

grl_operation_options_set_key_filter_value ()

gboolean
grl_operation_options_set_key_filter_value
                               (GrlOperationOptions *options,
                                GrlKeyID key,
                                GValue *value);

Set filter as "key == value ".

Since: 0.2.0

grl_operation_options_set_key_filters ()

gboolean
grl_operation_options_set_key_filters (GrlOperationOptions *options,
                                       ...);

Set filter as "k1 == v1 AND k2 == v2 AND ..."

  grl_operation_options_set_key_filters (my_options,
                                         GRL_METADATA_KEY_ALBUM, "Frozen",
                                         GRL_METADATA_KEY_BITRATE, 256,
                                         NULL);
 

Since: 0.2.0

grl_operation_options_set_key_range_filter ()

gboolean
grl_operation_options_set_key_range_filter
                               (GrlOperationOptions *options,
                                ...);

Set filter as "min1 <= k1 <= max1 AND min2 <= k2 <= max2 AND ..."

The range can be open if some of the minX, maxX values are NULL.

  grl_operation_options_set_key_range_filters (my_options,
                                               GRL_METADATA_KEY_ALBUM, "Ta", "Tz",
                                               GRL_METADATA_KEY_BITRATE, 256, NULL,
                                               NULL);
 

Since: 0.2.0

grl_operation_options_set_key_range_filter_value ()

gboolean
grl_operation_options_set_key_range_filter_value
                               (GrlOperationOptions *options,
                                GrlKeyID key,
                                GValue *min_value,
                                GValue *max_value);

Set filter as "min_value <= key <= max_value ".

If min_value is NULL, then filter is "key <= max_value ".

If max_value is NULL, then filter is "key >= min_value ".

Since: 0.2.0

grl_operation_options_set_skip ()

gboolean
grl_operation_options_set_skip (GrlOperationOptions *options,
                                guint skip);

Set the skip option for an operation. Will only succeed if skip obeys to the inherent capabilities of options .

Since: 0.2.0

grl_operation_options_set_type_filter ()

gboolean
grl_operation_options_set_type_filter (GrlOperationOptions *options,
                                       GrlTypeFilter filter);

Set the type of media filter for an operation. Only those media elements that match the filter will be returned. Will only succeed if filter obey to the inherent capabilities of options .

Since: 0.2.0

GrlOperationOptions

typedef struct _GrlOperationOptions GrlOperationOptions;

GrlOperationOptionsClass

typedef struct {
  GObjectClass parent;
} GrlOperationOptionsClass;

Grilo Operation Options class.

GRL_COUNT_INFINITY

#define GRL_COUNT_INFINITY (-1)