Clapper.Queue
Description: Reference for Clapper.Queue

### Class

# ClapperQueue

#### Description [src]

    final class Clapper.Queue : Gst.Object
      implements Gio.ListModel {
      /* No available fields */
    }

A queue of media to be played.

#### Hierarchy

#### Ancestors

- GstObject
- GInitiallyUnowned
- GObject

#### Implements

- GListModel

#### Instance methods

###### clapper_queue_add_item

Add another `ClapperMediaItem` to the end of queue.

###### clapper_queue_clear

Removes all media items from the queue.

###### clapper_queue_find_item

Get the index of `ClapperMediaItem` within `ClapperQueue`.

###### clapper_queue_get_current_index

Get index of the currently selected `ClapperMediaItem`.

###### clapper_queue_get_current_item

Get the currently selected `ClapperMediaItem`.

###### clapper_queue_get_gapless

Get if `ClapperQueue` is set to use gapless progression.

###### clapper_queue_get_instant

Get if `ClapperQueue` is set to use instant media item changes.

###### clapper_queue_get_item

Get the `ClapperMediaItem` at index.

###### clapper_queue_get_n_items

Get the number of items in `ClapperQueue`.

###### clapper_queue_get_progression_mode

Get the `ClapperQueueProgressionMode` of the `ClapperQueue`.

###### clapper_queue_insert_item

Insert another `ClapperMediaItem` at `index` position to the queue.

###### clapper_queue_item_is_current

Checks if given `ClapperMediaItem` is currently selected.

###### clapper_queue_remove_index

Removes `ClapperMediaItem` at `index` from the queue.

###### clapper_queue_remove_item

Removes `ClapperMediaItem` from the queue.

###### clapper_queue_reposition_item

Change position of one `ClapperMediaItem` within the queue.

###### clapper_queue_select_index

Selects `ClapperMediaItem` at `index` from `queue` as current one or unselects currently selected index when `index` is `CLAPPER_QUEUE_INVALID_POSITION`.

###### clapper_queue_select_item

Selects `ClapperMediaItem` from `queue` as current one or unselects currently selected item when `item` is `NULL`.

###### clapper_queue_select_next_item

Selects next `ClapperMediaItem` from `queue` for playback.

###### clapper_queue_select_previous_item

Selects previous `ClapperMediaItem` from `queue` for playback.

###### clapper_queue_set_gapless

Set `ClapperQueue` progression to be gapless.

###### clapper_queue_set_instant

Set `ClapperQueue` media item changes to be instant.

###### clapper_queue_set_progression_mode

Set the `ClapperQueueProgressionMode` of the `ClapperQueue`.

###### clapper_queue_steal_index

Removes `ClapperMediaItem` at `index` from the queue.

##### Methods inherited from GstObject (25)

Please see GstObject for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GListModel (5)

###### g_list_model_get_item

Get the item at `position`.

###### g_list_model_get_item_type

Gets the type of the items in `list`.

###### g_list_model_get_n_items

Gets the number of items in `list`.

###### g_list_model_get_object

Get the item at `position`.

###### g_list_model_items_changed

Emits the `GListModel::items-changed` signal on `list`.

#### Properties

###### Clapper.Queue:current-index

Index of currently selected media item for playback.

###### Clapper.Queue:current-item

Currently selected media item for playback.

###### Clapper.Queue:gapless

Use gapless progression.

###### Clapper.Queue:instant

Use instant media item changes.

###### Clapper.Queue:n-items

Number of media items in the queue.

###### Clapper.Queue:progression-mode

Queue progression mode.

##### Properties inherited from GstObject (2)

###### Gst.Object:name

No description available.

###### Gst.Object:parent

The parent of the object. Please note, that when changing the ‘parent’ property, we don’t emit `GObject::notify` and `GstObject::deep-notify` signals due to locking issues. In some cases one can use `GstBin::element-added` or `GstBin::element-removed` signals on the parent to achieve a similar effect.

#### Signals

##### Signals inherited from GstObject (1)

###### GstObject::deep-notify

The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

##### Signals inherited from GListModel (1)

###### GListModel::items-changed

This signal is emitted whenever items were added to or removed from `list`. At `position`, `removed` items were removed and `added` items were added in their place.

#### Class structure

    struct ClapperQueueClass {
      GstObjectClass parent_class;

    }

No description available.

###### Class members

`parent_class: GstObjectClass`

  No description available.