ClapperGtk.Audio
Description: Reference for ClapperGtk.Audio

### Class

# ClapperGtkAudio

since: 0.10

#### Description [src]

    final class ClapperGtk.Audio : ClapperGtk.Av
      implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget {
      /* No available fields */
    }

A GTK widget for audio playback with Clapper API.

`ClapperGtkAudio` is a widget meant for integrating audio playback within GTK application. It exposes `ClapperPlayer` through its base class `ClapperGtkAv:player` property.

Other widgets (buttons, seek bar, etc.) provided by `ClapperGtk` library, once placed anywhere inside audio container (including nesting within another widget like `GtkBox`) will automatically control `ClapperGtkAudio` they are within. This allows to freely create custom UI best suited for specific application.

# Basic usage

A typical use case is to embed audio widget as part of your app where audio playback is needed (can be even the very first child of the window). Get the `ClapperPlayer` belonging to the AV widget and start adding new `ClapperMediaItem` items to the `ClapperQueue` for playback. For more information please refer to the Clapper playback library documentation.

# Actions

You can use built-in actions of parent `ClapperGtkAv`. See its documentation for the list of available ones.

# ClapperGtkAudio as GtkBuildable

`ClapperGtkAudio` implementation of the `GtkBuildable` interface supports placing a single widget (which might then hold multiple widgets) as `<child>` element.

    <object class="ClapperGtkAudio" id="audio">
      <child>
        <object class="GtkBox">
          <property name="orientation">horizontal</property>
          <child>
            <object class="ClapperGtkPreviousItemButton">
          </child>
          <child>
            <object class="ClapperGtkTogglePlayButton">
          </child>
          <child>
            <object class="ClapperGtkNextItemButton">
          </child>
        </object>
      </child>
    </object>

Available since: 0.10

#### Hierarchy

#### Ancestors

- ClapperGtkAv
- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget

#### Constructors

###### clapper_gtk_audio_new

Creates a new `ClapperGtkAudio` instance.

#### Instance methods

###### clapper_gtk_audio_get_child

Get a child `GtkWidget` of `audio`.

###### clapper_gtk_audio_set_child

Set a child `GtkWidget` of `audio`.

##### Methods inherited from ClapperGtkAv (4)

###### clapper_gtk_av_get_auto_inhibit

Get whether automatic session inhibit is enabled.

since: 0.10

###### clapper_gtk_av_get_inhibited

Get whether session is currently inhibited by `ClapperGtkAv:auto-inhibit`.

since: 0.10

###### clapper_gtk_av_get_player

Get `ClapperPlayer` used by this `ClapperGtkAv` instance.

since: 0.10

###### clapper_gtk_av_set_auto_inhibit

Set whether widget should try to automatically inhibit session from idling (and possibly screen going black) when media is playing.

since: 0.10

##### Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

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

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (20)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

###### gtk_accessible_get_platform_state

Queries a platform state, such as focus.

###### gtk_accessible_reset_property

Resets the accessible property to its default value.

###### gtk_accessible_reset_relation

Resets the accessible relation to its default value.

###### gtk_accessible_reset_state

Resets the accessible state to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

###### gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

#### Properties

###### ClapperGtk.Audio:child

The child widget of `ClapperGtkAudio`.

##### Properties inherited from ClapperGtkAv (3)

###### ClapperGtk.Av:auto-inhibit

Try to automatically inhibit session when media is playing.

###### ClapperGtk.Av:inhibited

Get whether session is currently inhibited by playback.

###### ClapperGtk.Av:player

A `ClapperPlayer` used by widget.

##### Properties inherited from GtkWidget (35)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the `GtkWidget::query-tooltip` signal on `widget`.

###### Gtk.Widget:height-request

Overrides for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Overrides for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### Gtk.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

#### Signals

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### 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.

#### Class structure

    struct ClapperGtkAudioClass {
      ClapperGtkAvClass parent_class;

    }

No description available.

###### Class members

`parent_class: ClapperGtkAvClass`

  No description available.