From 28fd45a300e47b7b17f0aa0f71d3de0d9f01875d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Dzi=C4=99giel?= Date: Sun, 21 Jan 2024 20:50:31 +0100 Subject: [PATCH] doc: Update Clapper API reference --- doc/clapper/clapper.devhelp2 | 2 +- doc/clapper/clapper.toml | 2 +- doc/clapper/class.Discoverer.html | 183 ++++- doc/clapper/class.Feature.html | 198 ++++- doc/clapper/class.MediaItem.html | 164 +++- doc/clapper/class.Mpris.html | 144 +++- doc/clapper/class.Player.html | 117 ++- doc/clapper/class.Queue.html | 269 ++++++- doc/clapper/class.Server.html | 754 ++++++++++++++++++ doc/clapper/class.Stream.html | 535 +++++++++++++ doc/clapper/class.StreamList.html | 702 ++++++++++++++++ doc/clapper/class.ThreadedObject.html | 92 ++- doc/clapper/classes_hierarchy.html | 19 +- doc/clapper/const.HAVE_DISCOVERER.html | 153 ++++ doc/clapper/const.HAVE_MPRIS.html | 2 +- doc/clapper/const.HAVE_SERVER.html | 153 ++++ doc/clapper/const.MAJOR_VERSION.html | 2 +- doc/clapper/const.MICRO_VERSION.html | 2 +- doc/clapper/const.MINOR_VERSION.html | 2 +- doc/clapper/const.QUEUE_INVALID_POSITION.html | 153 ++++ .../const.STREAM_LIST_INVALID_POSITION.html | 153 ++++ doc/clapper/const.TIME_FORMAT.html | 158 ++++ doc/clapper/const.TIME_MS_FORMAT.html | 157 ++++ doc/clapper/const.VERSION_S.html | 2 +- doc/clapper/ctor.Discoverer.new.html | 6 +- doc/clapper/ctor.MediaItem.new.html | 6 +- doc/clapper/ctor.MediaItem.new_from_file.html | 6 +- doc/clapper/ctor.MediaItem.new_take.html | 6 +- doc/clapper/ctor.Mpris.new.html | 6 +- doc/clapper/ctor.Player.new.html | 6 +- doc/clapper/ctor.Server.new.html | 197 +++++ doc/clapper/enum.DiscovererDiscoveryMode.html | 209 +++++ doc/clapper/enum.PlayerSeekMethod.html | 57 +- doc/clapper/enum.PlayerState.html | 72 +- doc/clapper/enum.QueueProgressionMode.html | 72 +- doc/clapper/func.CHECK_VERSION.html | 4 +- doc/clapper/func.DISCOVERER_CAST.html | 4 +- doc/clapper/func.ENCODE_VERSION.html | 4 +- doc/clapper/func.FEATURE_CAST.html | 2 +- doc/clapper/func.MEDIA_ITEM_CAST.html | 4 +- doc/clapper/func.MPRIS_CAST.html | 2 +- doc/clapper/func.PLAYER_CAST.html | 2 +- doc/clapper/func.QUEUE_CAST.html | 2 +- doc/clapper/func.SERVER_CAST.html | 196 +++++ doc/clapper/func.STREAM_CAST.html | 196 +++++ doc/clapper/func.STREAM_LIST_CAST.html | 196 +++++ doc/clapper/func.THREADED_OBJECT_CAST.html | 4 +- doc/clapper/func.TIME_ARGS.html | 198 +++++ doc/clapper/func.TIME_MS_ARGS.html | 198 +++++ doc/clapper/func.init.html | 10 +- doc/clapper/func.init_check.html | 10 +- doc/clapper/index.html | 211 ++++- doc/clapper/index.json | 2 +- doc/clapper/main.js | 3 +- .../method.Discoverer.get_discovery_mode.html | 211 +++++ ...method.Discoverer.set_discovery_mode.html} | 48 +- ...> method.MediaItem.get_audio_streams.html} | 73 +- ...method.MediaItem.get_container_format.html | 14 +- .../method.MediaItem.get_duration.html | 14 +- ...uris.html => method.MediaItem.get_id.html} | 46 +- ...method.MediaItem.get_subtitle_streams.html | 223 ++++++ doc/clapper/method.MediaItem.get_title.html | 14 +- doc/clapper/method.MediaItem.get_uri.html | 14 +- ...> method.MediaItem.get_video_streams.html} | 79 +- .../method.Mpris.get_fallback_art_url.html | 12 +- .../method.Mpris.get_queue_controllable.html | 215 +++++ .../method.Mpris.set_fallback_art_url.html | 12 +- .../method.Mpris.set_queue_controllable.html | 227 ++++++ doc/clapper/method.Player.add_feature.html | 8 +- .../method.Player.get_audio_filter.html | 6 +- doc/clapper/method.Player.get_audio_sink.html | 6 +- ...thod.Player.get_current_audio_decoder.html | 6 +- ...thod.Player.get_current_video_decoder.html | 6 +- doc/clapper/method.Player.get_mute.html | 6 +- doc/clapper/method.Player.get_position.html | 6 +- doc/clapper/method.Player.get_queue.html | 6 +- doc/clapper/method.Player.get_speed.html | 6 +- doc/clapper/method.Player.get_state.html | 6 +- .../method.Player.get_video_filter.html | 6 +- doc/clapper/method.Player.get_video_sink.html | 6 +- doc/clapper/method.Player.get_volume.html | 6 +- doc/clapper/method.Player.pause.html | 6 +- doc/clapper/method.Player.play.html | 6 +- doc/clapper/method.Player.seek.html | 6 +- doc/clapper/method.Player.seek_custom.html | 10 +- .../method.Player.set_audio_filter.html | 8 +- doc/clapper/method.Player.set_audio_sink.html | 8 +- doc/clapper/method.Player.set_mute.html | 6 +- doc/clapper/method.Player.set_speed.html | 6 +- .../method.Player.set_video_filter.html | 8 +- doc/clapper/method.Player.set_video_sink.html | 8 +- doc/clapper/method.Player.set_volume.html | 8 +- doc/clapper/method.Player.stop.html | 6 +- doc/clapper/method.Queue.add_item.html | 28 +- doc/clapper/method.Queue.clear.html | 26 +- doc/clapper/method.Queue.find_item.html | 28 +- .../method.Queue.get_current_index.html | 254 ++++++ .../method.Queue.get_current_item.html | 28 +- doc/clapper/method.Queue.get_gapless.html | 253 ++++++ doc/clapper/method.Queue.get_instant.html | 253 ++++++ doc/clapper/method.Queue.get_item.html | 26 +- doc/clapper/method.Queue.get_n_items.html | 28 +- .../method.Queue.get_progression_mode.html | 26 +- doc/clapper/method.Queue.insert_item.html | 28 +- doc/clapper/method.Queue.item_is_current.html | 278 +++++++ doc/clapper/method.Queue.remove_index.html | 252 ++++++ doc/clapper/method.Queue.remove_item.html | 28 +- doc/clapper/method.Queue.reposition_item.html | 273 +++++++ doc/clapper/method.Queue.select_index.html | 280 +++++++ doc/clapper/method.Queue.select_item.html | 30 +- .../method.Queue.select_next_item.html | 28 +- .../method.Queue.select_previous_item.html | 28 +- doc/clapper/method.Queue.set_gapless.html | 265 ++++++ doc/clapper/method.Queue.set_instant.html | 265 ++++++ .../method.Queue.set_progression_mode.html | 26 +- doc/clapper/method.Queue.steal_index.html | 278 +++++++ .../method.Server.get_current_port.html | 223 ++++++ doc/clapper/method.Server.get_enabled.html | 223 ++++++ doc/clapper/method.Server.get_port.html | 223 ++++++ .../method.Server.get_queue_controllable.html | 223 ++++++ doc/clapper/method.Server.get_running.html | 223 ++++++ doc/clapper/method.Server.set_enabled.html | 235 ++++++ doc/clapper/method.Server.set_port.html | 230 ++++++ .../method.Server.set_queue_controllable.html | 235 ++++++ doc/clapper/method.Stream.get_caps.html | 209 +++++ .../method.StreamList.get_current_index.html | 220 +++++ .../method.StreamList.get_current_stream.html | 219 +++++ .../method.StreamList.get_n_streams.html | 213 +++++ doc/clapper/method.StreamList.get_stream.html | 246 ++++++ .../method.StreamList.select_index.html | 244 ++++++ .../method.StreamList.select_stream.html | 244 ++++++ .../method.ThreadedObject.get_context.html | 4 +- .../property.Discoverer.discovery-mode.html | 192 +++++ .../property.MediaItem.audio-streams.html | 202 +++++ .../property.MediaItem.container-format.html | 14 +- doc/clapper/property.MediaItem.duration.html | 14 +- ...uburis.html => property.MediaItem.id.html} | 36 +- .../property.MediaItem.subtitle-streams.html | 202 +++++ doc/clapper/property.MediaItem.title.html | 14 +- doc/clapper/property.MediaItem.uri.html | 14 +- .../property.MediaItem.video-streams.html | 202 +++++ doc/clapper/property.Mpris.desktop-entry.html | 14 +- .../property.Mpris.fallback-art-url.html | 10 +- doc/clapper/property.Mpris.identity.html | 14 +- doc/clapper/property.Mpris.own-name.html | 14 +- .../property.Mpris.queue-controllable.html | 200 +++++ doc/clapper/property.Player.audio-filter.html | 8 +- doc/clapper/property.Player.audio-sink.html | 8 +- ...property.Player.current-audio-decoder.html | 4 +- ...property.Player.current-video-decoder.html | 4 +- doc/clapper/property.Player.mute.html | 8 +- doc/clapper/property.Player.position.html | 6 +- doc/clapper/property.Player.queue.html | 4 +- doc/clapper/property.Player.speed.html | 8 +- doc/clapper/property.Player.state.html | 6 +- doc/clapper/property.Player.video-filter.html | 8 +- doc/clapper/property.Player.video-sink.html | 8 +- doc/clapper/property.Player.volume.html | 8 +- doc/clapper/property.Queue.current-index.html | 200 +++++ doc/clapper/property.Queue.current-item.html | 10 +- doc/clapper/property.Queue.gapless.html | 202 +++++ doc/clapper/property.Queue.instant.html | 202 +++++ doc/clapper/property.Queue.n-items.html | 12 +- .../property.Queue.progression-mode.html | 14 +- doc/clapper/property.Server.current-port.html | 198 +++++ doc/clapper/property.Server.enabled.html | 200 +++++ doc/clapper/property.Server.port.html | 200 +++++ .../property.Server.queue-controllable.html | 200 +++++ doc/clapper/property.Server.running.html | 198 +++++ doc/clapper/property.Stream.caps.html | 188 +++++ .../property.StreamList.current-index.html | 192 +++++ .../property.StreamList.current-stream.html | 190 +++++ doc/clapper/search.js | 67 +- doc/clapper/signal.Player.error.html | 8 +- doc/clapper/signal.Player.missing-plugin.html | 12 +- doc/clapper/signal.Player.warning.html | 8 +- doc/clapper/signal.Server.error.html | 214 +++++ doc/clapper/style.css | 185 ++++- doc/clapper/urlmap.js | 12 +- ...d.html => vfunc.Feature.item_updated.html} | 30 +- doc/clapper/vfunc.Feature.mute_changed.html | 16 +- ...=> vfunc.Feature.played_item_changed.html} | 42 +- .../vfunc.Feature.position_changed.html | 16 +- doc/clapper/vfunc.Feature.prepare.html | 16 +- .../vfunc.Feature.property_changed.html | 236 ++++++ doc/clapper/vfunc.Feature.queue_cleared.html | 16 +- .../vfunc.Feature.queue_item_added.html | 16 +- .../vfunc.Feature.queue_item_removed.html | 36 +- ...vfunc.Feature.queue_item_repositioned.html | 249 ++++++ ...unc.Feature.queue_progression_changed.html | 18 +- doc/clapper/vfunc.Feature.speed_changed.html | 16 +- doc/clapper/vfunc.Feature.state_changed.html | 16 +- doc/clapper/vfunc.Feature.unprepare.html | 16 +- doc/clapper/vfunc.Feature.volume_changed.html | 16 +- .../vfunc.ThreadedObject.thread_start.html | 6 +- .../vfunc.ThreadedObject.thread_stop.html | 6 +- 196 files changed, 17729 insertions(+), 772 deletions(-) create mode 100644 doc/clapper/class.Server.html create mode 100644 doc/clapper/class.Stream.html create mode 100644 doc/clapper/class.StreamList.html create mode 100644 doc/clapper/const.HAVE_DISCOVERER.html create mode 100644 doc/clapper/const.HAVE_SERVER.html create mode 100644 doc/clapper/const.QUEUE_INVALID_POSITION.html create mode 100644 doc/clapper/const.STREAM_LIST_INVALID_POSITION.html create mode 100644 doc/clapper/const.TIME_FORMAT.html create mode 100644 doc/clapper/const.TIME_MS_FORMAT.html create mode 100644 doc/clapper/ctor.Server.new.html create mode 100644 doc/clapper/enum.DiscovererDiscoveryMode.html create mode 100644 doc/clapper/func.SERVER_CAST.html create mode 100644 doc/clapper/func.STREAM_CAST.html create mode 100644 doc/clapper/func.STREAM_LIST_CAST.html create mode 100644 doc/clapper/func.TIME_ARGS.html create mode 100644 doc/clapper/func.TIME_MS_ARGS.html create mode 100644 doc/clapper/method.Discoverer.get_discovery_mode.html rename doc/clapper/{method.Discoverer.discover_item.html => method.Discoverer.set_discovery_mode.html} (70%) rename doc/clapper/{method.MediaItem.set_suburis.html => method.MediaItem.get_audio_streams.html} (70%) rename doc/clapper/{method.MediaItem.get_suburis.html => method.MediaItem.get_id.html} (77%) create mode 100644 doc/clapper/method.MediaItem.get_subtitle_streams.html rename doc/clapper/{method.MediaItem.append_suburi.html => method.MediaItem.get_video_streams.html} (68%) create mode 100644 doc/clapper/method.Mpris.get_queue_controllable.html create mode 100644 doc/clapper/method.Mpris.set_queue_controllable.html create mode 100644 doc/clapper/method.Queue.get_current_index.html create mode 100644 doc/clapper/method.Queue.get_gapless.html create mode 100644 doc/clapper/method.Queue.get_instant.html create mode 100644 doc/clapper/method.Queue.item_is_current.html create mode 100644 doc/clapper/method.Queue.remove_index.html create mode 100644 doc/clapper/method.Queue.reposition_item.html create mode 100644 doc/clapper/method.Queue.select_index.html create mode 100644 doc/clapper/method.Queue.set_gapless.html create mode 100644 doc/clapper/method.Queue.set_instant.html create mode 100644 doc/clapper/method.Queue.steal_index.html create mode 100644 doc/clapper/method.Server.get_current_port.html create mode 100644 doc/clapper/method.Server.get_enabled.html create mode 100644 doc/clapper/method.Server.get_port.html create mode 100644 doc/clapper/method.Server.get_queue_controllable.html create mode 100644 doc/clapper/method.Server.get_running.html create mode 100644 doc/clapper/method.Server.set_enabled.html create mode 100644 doc/clapper/method.Server.set_port.html create mode 100644 doc/clapper/method.Server.set_queue_controllable.html create mode 100644 doc/clapper/method.Stream.get_caps.html create mode 100644 doc/clapper/method.StreamList.get_current_index.html create mode 100644 doc/clapper/method.StreamList.get_current_stream.html create mode 100644 doc/clapper/method.StreamList.get_n_streams.html create mode 100644 doc/clapper/method.StreamList.get_stream.html create mode 100644 doc/clapper/method.StreamList.select_index.html create mode 100644 doc/clapper/method.StreamList.select_stream.html create mode 100644 doc/clapper/property.Discoverer.discovery-mode.html create mode 100644 doc/clapper/property.MediaItem.audio-streams.html rename doc/clapper/{property.MediaItem.suburis.html => property.MediaItem.id.html} (80%) create mode 100644 doc/clapper/property.MediaItem.subtitle-streams.html create mode 100644 doc/clapper/property.MediaItem.video-streams.html create mode 100644 doc/clapper/property.Mpris.queue-controllable.html create mode 100644 doc/clapper/property.Queue.current-index.html create mode 100644 doc/clapper/property.Queue.gapless.html create mode 100644 doc/clapper/property.Queue.instant.html create mode 100644 doc/clapper/property.Server.current-port.html create mode 100644 doc/clapper/property.Server.enabled.html create mode 100644 doc/clapper/property.Server.port.html create mode 100644 doc/clapper/property.Server.queue-controllable.html create mode 100644 doc/clapper/property.Server.running.html create mode 100644 doc/clapper/property.Stream.caps.html create mode 100644 doc/clapper/property.StreamList.current-index.html create mode 100644 doc/clapper/property.StreamList.current-stream.html create mode 100644 doc/clapper/signal.Server.error.html rename doc/clapper/{vfunc.Feature.media_item_updated.html => vfunc.Feature.item_updated.html} (87%) rename doc/clapper/{vfunc.Feature.current_media_item_changed.html => vfunc.Feature.played_item_changed.html} (83%) create mode 100644 doc/clapper/vfunc.Feature.property_changed.html create mode 100644 doc/clapper/vfunc.Feature.queue_item_repositioned.html diff --git a/doc/clapper/clapper.devhelp2 b/doc/clapper/clapper.devhelp2 index 442519d1..0c59b03c 100644 --- a/doc/clapper/clapper.devhelp2 +++ b/doc/clapper/clapper.devhelp2 @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/doc/clapper/clapper.toml b/doc/clapper/clapper.toml index e8ce1c87..9bfbc553 100644 --- a/doc/clapper/clapper.toml +++ b/doc/clapper/clapper.toml @@ -31,7 +31,7 @@ dependencies = ["GLib-2.0", "GObject-2.0", "Gio-2.0", "Gst-1.0"] [dependencies."Gst-1.0"] name = "Gst" description = "GStreamer core library" - docs_url = "https://gstreamer.freedesktop.org/documentation/" + docs_url = "https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html" [dependencies."GstBase-1.0"] name = "GstBase" diff --git a/doc/clapper/class.Discoverer.html b/doc/clapper/class.Discoverer.html index 53a3d038..5e98682e 100644 --- a/doc/clapper/class.Discoverer.html +++ b/doc/clapper/class.Discoverer.html @@ -85,6 +85,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later +
Constructors
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Player.seek_custom.html b/doc/clapper/method.Player.seek_custom.html index 295ac245..ffd4453f 100644 --- a/doc/clapper/method.Player.seek_custom.html +++ b/doc/clapper/method.Player.seek_custom.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -185,14 +185,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]

Request the player to perform a seek operation.

Same as clapper_player_seek(), but also allows to specify -ClapperPlayerSeekMethod to use for seek operation.

+ClapperPlayerSeekMethod to use for seek.

@@ -237,7 +237,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
method

Type: ClapperPlayerSeekMethod

-

No description available.

+

A ClapperPlayerSeekMethod.

diff --git a/doc/clapper/method.Player.set_audio_filter.html b/doc/clapper/method.Player.set_audio_filter.html index 7fdae8d0..c4d76650 100644 --- a/doc/clapper/method.Player.set_audio_filter.html +++ b/doc/clapper/method.Player.set_audio_filter.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - +
The data is owned by the caller of the function.
The data is owned by the caller of the method.
diff --git a/doc/clapper/method.Player.set_audio_sink.html b/doc/clapper/method.Player.set_audio_sink.html index 224e90f5..517f3c1b 100644 --- a/doc/clapper/method.Player.set_audio_sink.html +++ b/doc/clapper/method.Player.set_audio_sink.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Player.set_mute.html b/doc/clapper/method.Player.set_mute.html index 021ca309..3fa2f570 100644 --- a/doc/clapper/method.Player.set_mute.html +++ b/doc/clapper/method.Player.set_mute.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Player.set_speed.html b/doc/clapper/method.Player.set_speed.html index 6fe410fc..836380b8 100644 --- a/doc/clapper/method.Player.set_speed.html +++ b/doc/clapper/method.Player.set_speed.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Player.set_video_filter.html b/doc/clapper/method.Player.set_video_filter.html index af7b31bb..45104c82 100644 --- a/doc/clapper/method.Player.set_video_filter.html +++ b/doc/clapper/method.Player.set_video_filter.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Player.set_video_sink.html b/doc/clapper/method.Player.set_video_sink.html index 3a002bf1..ec0f6ad9 100644 --- a/doc/clapper/method.Player.set_video_sink.html +++ b/doc/clapper/method.Player.set_video_sink.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,7 +184,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -234,7 +234,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Player.set_volume.html b/doc/clapper/method.Player.set_volume.html index 935ec542..90ba1676 100644 --- a/doc/clapper/method.Player.set_volume.html +++ b/doc/clapper/method.Player.set_volume.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -184,13 +184,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]

Set the volume of the player.

-

The value should be within 0 - 1.5 range, where 1.0 is 100% +

The value should be within 0 - 2.0 range, where 1.0 is 100% volume and anything above results with an overamplification.

diff --git a/doc/clapper/method.Player.stop.html b/doc/clapper/method.Player.stop.html index fb1679ef..21a27d66 100644 --- a/doc/clapper/method.Player.stop.html +++ b/doc/clapper/method.Player.stop.html @@ -141,7 +141,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -164,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -183,7 +183,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Queue.add_item.html b/doc/clapper/method.Queue.add_item.html index 0c6613de..709b946b 100644 --- a/doc/clapper/method.Queue.add_item.html +++ b/doc/clapper/method.Queue.add_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +180,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -204,7 +224,7 @@ so it is safe to call multiple times if unsure.

- The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Queue.clear.html b/doc/clapper/method.Queue.clear.html index e08c870d..b2efc650 100644 --- a/doc/clapper/method.Queue.clear.html +++ b/doc/clapper/method.Queue.clear.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,7 +179,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Queue.find_item.html b/doc/clapper/method.Queue.find_item.html index 3370dc3e..0bb14c6f 100644 --- a/doc/clapper/method.Queue.find_item.html +++ b/doc/clapper/method.Queue.find_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -161,7 +181,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -203,7 +223,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Queue.get_current_index.html b/doc/clapper/method.Queue.get_current_index.html new file mode 100644 index 00000000..9f2a06ed --- /dev/null +++ b/doc/clapper/method.Queue.get_current_index.html @@ -0,0 +1,254 @@ + + + + + + Clapper.Queue.get_current_index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueget_current_index

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
guint
+clapper_queue_get_current_index (
+  ClapperQueue* queue
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get index of the currently selected ClapperMediaItem.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Queue:current-index
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

Current item index or #CLAPPER_QUEUE_INVALID_POSITION + when nothing is selected.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.get_current_item.html b/doc/clapper/method.Queue.get_current_item.html index 64a99c60..719924a4 100644 --- a/doc/clapper/method.Queue.get_current_item.html +++ b/doc/clapper/method.Queue.get_current_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,7 +179,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -208,7 +228,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later The caller of the method takes ownership of the data, and is responsible for freeing it. - + The return value can be NULL. diff --git a/doc/clapper/method.Queue.get_gapless.html b/doc/clapper/method.Queue.get_gapless.html new file mode 100644 index 00000000..324b1a52 --- /dev/null +++ b/doc/clapper/method.Queue.get_gapless.html @@ -0,0 +1,253 @@ + + + + + + Clapper.Queue.get_gapless + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueget_gapless

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_queue_get_gapless (
+  ClapperQueue* queue
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get if ClapperQueue is set to use gapless progression.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Queue:gapless
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if enabled, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.get_instant.html b/doc/clapper/method.Queue.get_instant.html new file mode 100644 index 00000000..a9668d46 --- /dev/null +++ b/doc/clapper/method.Queue.get_instant.html @@ -0,0 +1,253 @@ + + + + + + Clapper.Queue.get_instant + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueget_instant

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_queue_get_instant (
+  ClapperQueue* queue
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

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

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Queue:instant
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if enabled, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.get_item.html b/doc/clapper/method.Queue.get_item.html index a40c6c9b..a0572eb5 100644 --- a/doc/clapper/method.Queue.get_item.html +++ b/doc/clapper/method.Queue.get_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +180,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Queue.get_n_items.html b/doc/clapper/method.Queue.get_n_items.html index bb42a4ac..534c3298 100644 --- a/doc/clapper/method.Queue.get_n_items.html +++ b/doc/clapper/method.Queue.get_n_items.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,13 +179,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]

Get the number of items in ClapperQueue.

-

This behave the same as g_list_model_get_n_items(), and is here +

This behaves the same as g_list_model_get_n_items(), and is here for code uniformity and convenience to avoid type casting by user.

This function is not available in bindings as they already inherit get_n_items() method from GListModel interface.

diff --git a/doc/clapper/method.Queue.get_progression_mode.html b/doc/clapper/method.Queue.get_progression_mode.html index 81f8d812..59dd2747 100644 --- a/doc/clapper/method.Queue.get_progression_mode.html +++ b/doc/clapper/method.Queue.get_progression_mode.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,7 +179,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Queue.insert_item.html b/doc/clapper/method.Queue.insert_item.html index c3ace8dc..d746bdc2 100644 --- a/doc/clapper/method.Queue.insert_item.html +++ b/doc/clapper/method.Queue.insert_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -161,7 +181,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -205,7 +225,7 @@ so it is safe to call multiple times if unsure.

- The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Queue.item_is_current.html b/doc/clapper/method.Queue.item_is_current.html new file mode 100644 index 00000000..9facedd5 --- /dev/null +++ b/doc/clapper/method.Queue.item_is_current.html @@ -0,0 +1,278 @@ + + + + + + Clapper.Queue.item_is_current + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueitem_is_current

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_queue_item_is_current (
+  ClapperQueue* queue,
+  ClapperMediaItem* item
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Checks if given ClapperMediaItem is currently selected.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
item
+
+

Type: ClapperMediaItem

+

A ClapperMediaItem to check.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if item is a current media item, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.remove_index.html b/doc/clapper/method.Queue.remove_index.html new file mode 100644 index 00000000..76ed8790 --- /dev/null +++ b/doc/clapper/method.Queue.remove_index.html @@ -0,0 +1,252 @@ + + + + + + Clapper.Queue.remove_index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueremove_index

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_queue_remove_index (
+  ClapperQueue* queue,
+  guint index
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Removes ClapperMediaItem at index from the queue.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

An item index.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.remove_item.html b/doc/clapper/method.Queue.remove_item.html index 471398c5..56aebf6f 100644 --- a/doc/clapper/method.Queue.remove_item.html +++ b/doc/clapper/method.Queue.remove_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +180,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -205,7 +225,7 @@ to call multiple times if unsure.

- The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Queue.reposition_item.html b/doc/clapper/method.Queue.reposition_item.html new file mode 100644 index 00000000..41bc35fe --- /dev/null +++ b/doc/clapper/method.Queue.reposition_item.html @@ -0,0 +1,273 @@ + + + + + + Clapper.Queue.reposition_item + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueuereposition_item

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_queue_reposition_item (
+  ClapperQueue* queue,
+  ClapperMediaItem* item,
+  gint index
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Change position of one ClapperMediaItem within the queue.

+

Note that the index is the new position you expect item to be +after whole reposition operation is finished.

+

If item is not in the queue, this function will do nothing.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
item
+
+

Type: ClapperMediaItem

+

A ClapperMediaItem.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ +
index
+
+

Type: gint

+

The index to place item in queue, -1 to place at the end.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.select_index.html b/doc/clapper/method.Queue.select_index.html new file mode 100644 index 00000000..9729d929 --- /dev/null +++ b/doc/clapper/method.Queue.select_index.html @@ -0,0 +1,280 @@ + + + + + + Clapper.Queue.select_index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueselect_index

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_queue_select_index (
+  ClapperQueue* queue,
+  guint index
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Selects ClapperMediaItem at index from queue as +current one and signals ClapperPlayer to play it.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

An item index.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if item could be selected, FALSE if it + was not in the queue.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.select_item.html b/doc/clapper/method.Queue.select_item.html index e12e858b..b75af484 100644 --- a/doc/clapper/method.Queue.select_item.html +++ b/doc/clapper/method.Queue.select_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,12 +180,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]
-

Selects ClapperMediaItem from playlist as current one and +

Selects ClapperMediaItem from queue as current one and signals ClapperPlayer to play it.

@@ -203,7 +223,7 @@ signals ClapperPlayer to play it.

- The data is owned by the caller of the function. + The data is owned by the caller of the method. diff --git a/doc/clapper/method.Queue.select_next_item.html b/doc/clapper/method.Queue.select_next_item.html index 84c8317f..41f14aa3 100644 --- a/doc/clapper/method.Queue.select_next_item.html +++ b/doc/clapper/method.Queue.select_next_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,12 +179,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]
-

Selects next ClapperMediaItem from playlist for playback.

+

Selects next ClapperMediaItem from queue for playback.

Note that this will try to select next item in the order of the queue, regardless of ClapperQueueProgressionMode set.

diff --git a/doc/clapper/method.Queue.select_previous_item.html b/doc/clapper/method.Queue.select_previous_item.html index 1c859dc1..820d4ca5 100644 --- a/doc/clapper/method.Queue.select_previous_item.html +++ b/doc/clapper/method.Queue.select_previous_item.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,12 +179,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]
-

Selects previous ClapperMediaItem from playlist for playback.

+

Selects previous ClapperMediaItem from queue for playback.

Note that this will try to select previous item in the order of the queue, regardless of ClapperQueueProgressionMode set.

diff --git a/doc/clapper/method.Queue.set_gapless.html b/doc/clapper/method.Queue.set_gapless.html new file mode 100644 index 00000000..e2724ea6 --- /dev/null +++ b/doc/clapper/method.Queue.set_gapless.html @@ -0,0 +1,265 @@ + + + + + + Clapper.Queue.set_gapless + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueset_gapless

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_queue_set_gapless (
+  ClapperQueue* queue,
+  gboolean gapless
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set ClapperQueue progression to be gapless.

+

Gapless playback will try to re-use as much as possible of underlying +GStreamer elements when ClapperQueue progresses, removing any +potential gap in the data.

+

NOTE: This feature within GStreamer is rather new and +might still cause playback issues. Disabled by default.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapper.Queue:gapless
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
gapless
+
+

Type: gboolean

+

TRUE to enable, FALSE otherwise.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.set_instant.html b/doc/clapper/method.Queue.set_instant.html new file mode 100644 index 00000000..ed52447e --- /dev/null +++ b/doc/clapper/method.Queue.set_instant.html @@ -0,0 +1,265 @@ + + + + + + Clapper.Queue.set_instant + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueueset_instant

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_queue_set_instant (
+  ClapperQueue* queue,
+  gboolean instant
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set ClapperQueue media item changes to be instant.

+

Instant will try to re-use as much as possible of underlying +GStreamer elements when ClapperMediaItem is selected, allowing +media item change requests to be faster.

+

NOTE: This feature within GStreamer is rather new and +might still cause playback issues. Disabled by default.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapper.Queue:instant
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
instant
+
+

Type: gboolean

+

TRUE to enable, FALSE otherwise.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Queue.set_progression_mode.html b/doc/clapper/method.Queue.set_progression_mode.html index bf934fdb..d5e634b3 100644 --- a/doc/clapper/method.Queue.set_progression_mode.html +++ b/doc/clapper/method.Queue.set_progression_mode.html @@ -93,8 +93,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later find_item + get_current_index + get_current_item + get_gapless + + get_instant + get_item get_n_items @@ -103,21 +109,35 @@ SPDX-License-Identifier: LGPL-2.1-or-later insert_item + item_is_current + + remove_index + remove_item + reposition_item + + select_index + select_item select_next_item select_previous_item + set_gapless + + set_instant + set_progression_mode + steal_index +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +160,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +180,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/method.Queue.steal_index.html b/doc/clapper/method.Queue.steal_index.html new file mode 100644 index 00000000..671a684f --- /dev/null +++ b/doc/clapper/method.Queue.steal_index.html @@ -0,0 +1,278 @@ + + + + + + Clapper.Queue.steal_index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperQueuesteal_index

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
ClapperMediaItem*
+clapper_queue_steal_index (
+  ClapperQueue* queue,
+  guint index
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Removes ClapperMediaItem at index from the queue.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

An item index.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperMediaItem

+

The removed ClapperMediaItem at index.

+
+
+ + + + + + + +
The caller of the method takes ownership of the data, and is responsible for freeing it.
The return value can be NULL.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.get_current_port.html b/doc/clapper/method.Server.get_current_port.html new file mode 100644 index 00000000..99b216e2 --- /dev/null +++ b/doc/clapper/method.Server.get_current_port.html @@ -0,0 +1,223 @@ + + + + + + Clapper.Server.get_current_port + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerget_current_port

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
guint
+clapper_server_get_current_port (
+  ClapperServer* server
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get port on which server is currently listening on.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Server:current-port
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

Current listening port or 0 if server is not listening.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.get_enabled.html b/doc/clapper/method.Server.get_enabled.html new file mode 100644 index 00000000..eb798a3a --- /dev/null +++ b/doc/clapper/method.Server.get_enabled.html @@ -0,0 +1,223 @@ + + + + + + Clapper.Server.get_enabled + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerget_enabled

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_server_get_enabled (
+  ClapperServer* server
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether ClapperServer is set to be running.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Server:enabled
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if enabled, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.get_port.html b/doc/clapper/method.Server.get_port.html new file mode 100644 index 00000000..b5dca173 --- /dev/null +++ b/doc/clapper/method.Server.get_port.html @@ -0,0 +1,223 @@ + + + + + + Clapper.Server.get_port + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerget_port

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
guint
+clapper_server_get_port (
+  ClapperServer* server
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get requested server listening port.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Server:port
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

Requested listening port or 0 using random port.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.get_queue_controllable.html b/doc/clapper/method.Server.get_queue_controllable.html new file mode 100644 index 00000000..cfef70fc --- /dev/null +++ b/doc/clapper/method.Server.get_queue_controllable.html @@ -0,0 +1,223 @@ + + + + + + Clapper.Server.get_queue_controllable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerget_queue_controllable

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_server_get_queue_controllable (
+  ClapperServer* server
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether remote server clients can control ClapperQueue.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Server:queue-controllable
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if control over ClapperQueue is allowed, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.get_running.html b/doc/clapper/method.Server.get_running.html new file mode 100644 index 00000000..98974baa --- /dev/null +++ b/doc/clapper/method.Server.get_running.html @@ -0,0 +1,223 @@ + + + + + + Clapper.Server.get_running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerget_running

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_server_get_running (
+  ClapperServer* server
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get whether ClapperServer is currently running.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Server:running
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if running, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.set_enabled.html b/doc/clapper/method.Server.set_enabled.html new file mode 100644 index 00000000..fcf759f3 --- /dev/null +++ b/doc/clapper/method.Server.set_enabled.html @@ -0,0 +1,235 @@ + + + + + + Clapper.Server.set_enabled + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerset_enabled

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_server_set_enabled (
+  ClapperServer* server,
+  gboolean enabled
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set whether ClapperServer should be running.

+

Note that server feature will run only after being added to the player. +It can be however set to enabled earlier. If server was already added, +changing this property allows to start/stop server at any time.

+

To be notified when server is actually running/stopped after being enabled/disabled, +you can listen for changes to ClapperServer:running property.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapper.Server:enabled
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
enabled
+
+

Type: gboolean

+

If ClapperServer should run.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.set_port.html b/doc/clapper/method.Server.set_port.html new file mode 100644 index 00000000..b6dabb1e --- /dev/null +++ b/doc/clapper/method.Server.set_port.html @@ -0,0 +1,230 @@ + + + + + + Clapper.Server.set_port + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerset_port

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_server_set_port (
+  ClapperServer* server,
+  guint port
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set server listening port.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapper.Server:port
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
port
+
+

Type: guint

+

A port number or 0 for random free port.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Server.set_queue_controllable.html b/doc/clapper/method.Server.set_queue_controllable.html new file mode 100644 index 00000000..675158a5 --- /dev/null +++ b/doc/clapper/method.Server.set_queue_controllable.html @@ -0,0 +1,235 @@ + + + + + + Clapper.Server.set_queue_controllable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperServerset_queue_controllable

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+clapper_server_set_queue_controllable (
+  ClapperServer* server,
+  gboolean controllable
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Set whether remote server clients can control ClapperQueue.

+

This includes ability to add/remove items from +the queue and selecting current item for playback +remotely using WebSocket messages.

+

You probably want to keep this disabled if your application +is supposed to manage what is played now and not WebSocket client.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Sets propertyClapper.Server:queue-controllable
+
+ +
+ + +
+

+ Parameters + +

+ +
+
+ +
controllable
+
+

Type: gboolean

+

If ClapperQueue should be controllable.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.Stream.get_caps.html b/doc/clapper/method.Stream.get_caps.html new file mode 100644 index 00000000..524fd1b0 --- /dev/null +++ b/doc/clapper/method.Stream.get_caps.html @@ -0,0 +1,209 @@ + + + + + + Clapper.Stream.get_caps + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamget_caps

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
GstCaps*
+clapper_stream_get_caps (
+  ClapperStream* stream
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get the caps of stream, if any.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.Stream:caps
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: GstCaps

+

GstCaps of stream.

+
+
+ + + + + + + +
The caller of the method takes ownership of the data, and is responsible for freeing it.
The return value can be NULL.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.StreamList.get_current_index.html b/doc/clapper/method.StreamList.get_current_index.html new file mode 100644 index 00000000..65336292 --- /dev/null +++ b/doc/clapper/method.StreamList.get_current_index.html @@ -0,0 +1,220 @@ + + + + + + Clapper.StreamList.get_current_index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamListget_current_index

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
guint
+clapper_stream_list_get_current_index (
+  ClapperStreamList* list
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get index of the currently selected ClapperStream.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.StreamList:current-index
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

Current stream index or #CLAPPER_STREAM_LIST_INVALID_POSITION + when nothing is selected.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.StreamList.get_current_stream.html b/doc/clapper/method.StreamList.get_current_stream.html new file mode 100644 index 00000000..4e1fca28 --- /dev/null +++ b/doc/clapper/method.StreamList.get_current_stream.html @@ -0,0 +1,219 @@ + + + + + + Clapper.StreamList.get_current_stream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamListget_current_stream

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
ClapperStream*
+clapper_stream_list_get_current_stream (
+  ClapperStreamList* list
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get the currently selected ClapperStream.

+
+ +
+ + + + + + +
+ + +
+ + + + +
Gets propertyClapper.StreamList:current-stream
+
+ +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperStream

+

The current ClapperStream.

+
+
+ + + + + + + +
The caller of the method takes ownership of the data, and is responsible for freeing it.
The return value can be NULL.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.StreamList.get_n_streams.html b/doc/clapper/method.StreamList.get_n_streams.html new file mode 100644 index 00000000..f8dba040 --- /dev/null +++ b/doc/clapper/method.StreamList.get_n_streams.html @@ -0,0 +1,213 @@ + + + + + + Clapper.StreamList.get_n_streams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamListget_n_streams

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
guint
+clapper_stream_list_get_n_streams (
+  ClapperStreamList* list
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get the number of streams in ClapperStreamList.

+

This behaves the same as g_list_model_get_n_items(), and is here +for code uniformity and convenience to avoid type casting by user.

+
+ +
+ + + + + + +
+ + +
+ + + + +
+

+ Return value + +

+ +
+
+
+

Type: guint

+

The number of streams in ClapperStreamList.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.StreamList.get_stream.html b/doc/clapper/method.StreamList.get_stream.html new file mode 100644 index 00000000..cc6a08c4 --- /dev/null +++ b/doc/clapper/method.StreamList.get_stream.html @@ -0,0 +1,246 @@ + + + + + + Clapper.StreamList.get_stream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamListget_stream

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
ClapperStream*
+clapper_stream_list_get_stream (
+  ClapperStreamList* list,
+  guint index
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Get the ClapperStream at index.

+

This behaves the same as g_list_model_get_item(), and is here +for code uniformity and convenience to avoid type casting by user.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

A stream index.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: ClapperStream

+

The ClapperStream at index.

+
+
+ + + + + + + +
The caller of the method takes ownership of the data, and is responsible for freeing it.
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.StreamList.select_index.html b/doc/clapper/method.StreamList.select_index.html new file mode 100644 index 00000000..6771a988 --- /dev/null +++ b/doc/clapper/method.StreamList.select_index.html @@ -0,0 +1,244 @@ + + + + + + Clapper.StreamList.select_index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamListselect_index

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_stream_list_select_index (
+  ClapperStreamList* list,
+  guint index
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Selects ClapperStream at index from list as current one.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
index
+
+

Type: guint

+

A stream index.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if stream could be selected, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.StreamList.select_stream.html b/doc/clapper/method.StreamList.select_stream.html new file mode 100644 index 00000000..67d7bd0d --- /dev/null +++ b/doc/clapper/method.StreamList.select_stream.html @@ -0,0 +1,244 @@ + + + + + + Clapper.StreamList.select_stream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Method

+

ClapperStreamListselect_stream

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
gboolean
+clapper_stream_list_select_stream (
+  ClapperStreamList* list,
+  ClapperStream* stream
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Selects ClapperStream from list to be activated.

+
+ +
+ + + + + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
stream
+
+

Type: ClapperStream

+

A ClapperStream.

+ + + + + + + + + + +
The data is owned by the caller of the method.
+
+ + + +
+
+
+ + + +
+

+ Return value + +

+ +
+
+
+

Type: gboolean

+

TRUE if stream was in the list, FALSE otherwise.

+
+
+ + + + + + + +
+
+
+
+
+ + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/method.ThreadedObject.get_context.html b/doc/clapper/method.ThreadedObject.get_context.html index 6d24d9b2..c5cd78bf 100644 --- a/doc/clapper/method.ThreadedObject.get_context.html +++ b/doc/clapper/method.ThreadedObject.get_context.html @@ -93,7 +93,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -116,7 +116,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] diff --git a/doc/clapper/property.Discoverer.discovery-mode.html b/doc/clapper/property.Discoverer.discovery-mode.html new file mode 100644 index 00000000..4c2b235c --- /dev/null +++ b/doc/clapper/property.Discoverer.discovery-mode.html @@ -0,0 +1,192 @@ + + + + + + Clapper.Discoverer:discovery-mode + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperDiscoverer:discovery-mode

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property discovery-mode: Clapper.DiscovererDiscoveryMode [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Discoverer discovery mode.

+
+ +
+ + + + + + + +
Type:ClapperDiscovererDiscoveryMode
+
+ + +
+ + + + + + + + +
Default valueCLAPPER_DISCOVERER_DISCOVERY_NONCURRENT
Getter methodclapper_discoverer_get_discovery_mode()
Setter methodclapper_discoverer_set_discovery_mode()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.MediaItem.audio-streams.html b/doc/clapper/property.MediaItem.audio-streams.html new file mode 100644 index 00000000..8e561ded --- /dev/null +++ b/doc/clapper/property.MediaItem.audio-streams.html @@ -0,0 +1,202 @@ + + + + + + Clapper.MediaItem:audio-streams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperMediaItem:audio-streams

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property audio-streams: Clapper.StreamList [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

List of available audio streams.

+
+ +
+ + + + + + + +
Type:ClapperStreamList
+
+ + +
+ + + + +
Getter methodclapper_media_item_get_audio_streams()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.MediaItem.container-format.html b/doc/clapper/property.MediaItem.container-format.html index 5ff74479..223345a5 100644 --- a/doc/clapper/property.MediaItem.container-format.html +++ b/doc/clapper/property.MediaItem.container-format.html @@ -87,21 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -134,7 +140,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -157,6 +163,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default valueNULL
Getter methodclapper_media_item_get_container_format()
diff --git a/doc/clapper/property.MediaItem.duration.html b/doc/clapper/property.MediaItem.duration.html index 63cd5b43..f54e6189 100644 --- a/doc/clapper/property.MediaItem.duration.html +++ b/doc/clapper/property.MediaItem.duration.html @@ -87,21 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -134,7 +140,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -157,6 +163,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default value0.000000
Getter methodclapper_media_item_get_duration()
diff --git a/doc/clapper/property.MediaItem.suburis.html b/doc/clapper/property.MediaItem.id.html similarity index 80% rename from doc/clapper/property.MediaItem.suburis.html rename to doc/clapper/property.MediaItem.id.html index 5a0625be..e518fc6a 100644 --- a/doc/clapper/property.MediaItem.suburis.html +++ b/doc/clapper/property.MediaItem.id.html @@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - Clapper.MediaItem:suburis + Clapper.MediaItem:id @@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later - - - - + + + + @@ -87,21 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -111,7 +117,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later

Property

-

ClapperMediaItem:suburis

+

ClapperMediaItem:id

@@ -125,7 +131,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-
property suburis: string[] [ read, write ]
+
property id: guint [ read ]
@@ -134,18 +140,18 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]
-

External Subtitle URIs.

+

Media Item ID.

- + @@ -157,9 +163,9 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Type:An array of char*guint
- + - +
Setter methodclapper_media_item_set_suburis()
Default value4294967295
Getter methodclapper_media_item_get_suburis()
Getter methodclapper_media_item_get_id()
@@ -175,7 +181,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
- +
Readableyes
Writableyes
Writableno
Constructno
Construct onlyno
diff --git a/doc/clapper/property.MediaItem.subtitle-streams.html b/doc/clapper/property.MediaItem.subtitle-streams.html new file mode 100644 index 00000000..66da1c72 --- /dev/null +++ b/doc/clapper/property.MediaItem.subtitle-streams.html @@ -0,0 +1,202 @@ + + + + + + Clapper.MediaItem:subtitle-streams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperMediaItem:subtitle-streams

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property subtitle-streams: Clapper.StreamList [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

List of available subtitle streams.

+
+ +
+ + + + + + + +
Type:ClapperStreamList
+
+ + + + +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.MediaItem.title.html b/doc/clapper/property.MediaItem.title.html index 70b40d1a..02c768d4 100644 --- a/doc/clapper/property.MediaItem.title.html +++ b/doc/clapper/property.MediaItem.title.html @@ -87,21 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -134,7 +140,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -157,6 +163,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default valueNULL
Getter methodclapper_media_item_get_title()
diff --git a/doc/clapper/property.MediaItem.uri.html b/doc/clapper/property.MediaItem.uri.html index f3ec4696..8b7fcb46 100644 --- a/doc/clapper/property.MediaItem.uri.html +++ b/doc/clapper/property.MediaItem.uri.html @@ -87,21 +87,27 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -134,7 +140,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -157,6 +163,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default valueNULL
Getter methodclapper_media_item_get_uri()
diff --git a/doc/clapper/property.MediaItem.video-streams.html b/doc/clapper/property.MediaItem.video-streams.html new file mode 100644 index 00000000..095dd4e8 --- /dev/null +++ b/doc/clapper/property.MediaItem.video-streams.html @@ -0,0 +1,202 @@ + + + + + + Clapper.MediaItem:video-streams + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperMediaItem:video-streams

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property video-streams: Clapper.StreamList [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

List of available video streams.

+
+ +
+ + + + + + + +
Type:ClapperStreamList
+
+ + +
+ + + + +
Getter methodclapper_media_item_get_video_streams()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Mpris.desktop-entry.html b/doc/clapper/property.Mpris.desktop-entry.html index 356a9cb0..c38e5793 100644 --- a/doc/clapper/property.Mpris.desktop-entry.html +++ b/doc/clapper/property.Mpris.desktop-entry.html @@ -95,11 +95,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later own-name + queue-controllable +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -132,7 +134,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -152,6 +154,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later +
+ + + + +
Default valueNULL
+
+
diff --git a/doc/clapper/property.Mpris.fallback-art-url.html b/doc/clapper/property.Mpris.fallback-art-url.html index 68165467..8beca8b6 100644 --- a/doc/clapper/property.Mpris.fallback-art-url.html +++ b/doc/clapper/property.Mpris.fallback-art-url.html @@ -95,11 +95,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later own-name + queue-controllable +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -132,7 +134,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -155,10 +157,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later diff --git a/doc/clapper/property.Mpris.identity.html b/doc/clapper/property.Mpris.identity.html index 83dc5cd2..d17d4b9a 100644 --- a/doc/clapper/property.Mpris.identity.html +++ b/doc/clapper/property.Mpris.identity.html @@ -95,11 +95,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later own-name + queue-controllable +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -132,7 +134,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -153,6 +155,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later +
+ + + + +
Default valueNULL
+
+
diff --git a/doc/clapper/property.Mpris.own-name.html b/doc/clapper/property.Mpris.own-name.html index 184707c0..b7795708 100644 --- a/doc/clapper/property.Mpris.own-name.html +++ b/doc/clapper/property.Mpris.own-name.html @@ -95,11 +95,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later own-name + queue-controllable +
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -132,7 +134,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -155,6 +157,14 @@ Each ClapperMpris instance running on the same system must have an& +
+ + + + +
Default valueNULL
+
+
diff --git a/doc/clapper/property.Mpris.queue-controllable.html b/doc/clapper/property.Mpris.queue-controllable.html new file mode 100644 index 00000000..83061f78 --- /dev/null +++ b/doc/clapper/property.Mpris.queue-controllable.html @@ -0,0 +1,200 @@ + + + + + + Clapper.Mpris:queue-controllable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperMpris:queue-controllable

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property queue-controllable: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Whether remote MPRIS clients can control ClapperQueue.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueFALSE
Getter methodclapper_mpris_get_queue_controllable()
Setter methodclapper_mpris_set_queue_controllable()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Player.audio-filter.html b/doc/clapper/property.Player.audio-filter.html index 3d320e9d..1fa3d500 100644 --- a/doc/clapper/property.Player.audio-filter.html +++ b/doc/clapper/property.Player.audio-filter.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,10 +171,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later diff --git a/doc/clapper/property.Player.audio-sink.html b/doc/clapper/property.Player.audio-sink.html index dfcacc86..6df6b2cf 100644 --- a/doc/clapper/property.Player.audio-sink.html +++ b/doc/clapper/property.Player.audio-sink.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,10 +171,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later diff --git a/doc/clapper/property.Player.current-audio-decoder.html b/doc/clapper/property.Player.current-audio-decoder.html index 9e68d28c..3338a8e9 100644 --- a/doc/clapper/property.Player.current-audio-decoder.html +++ b/doc/clapper/property.Player.current-audio-decoder.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/property.Player.current-video-decoder.html b/doc/clapper/property.Player.current-video-decoder.html index c029ae77..37c5c6c6 100644 --- a/doc/clapper/property.Player.current-video-decoder.html +++ b/doc/clapper/property.Player.current-video-decoder.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/property.Player.mute.html b/doc/clapper/property.Player.mute.html index 71ea3964..c030a93d 100644 --- a/doc/clapper/property.Player.mute.html +++ b/doc/clapper/property.Player.mute.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,10 +171,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
- + + +
Setter methodclapper_player_set_mute()
Default valueFALSE
Getter methodclapper_player_get_mute()
Setter methodclapper_player_set_mute()
diff --git a/doc/clapper/property.Player.position.html b/doc/clapper/property.Player.position.html index 88035ee4..490610cf 100644 --- a/doc/clapper/property.Player.position.html +++ b/doc/clapper/property.Player.position.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,6 +171,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default value0.000000
Getter methodclapper_player_get_position()
diff --git a/doc/clapper/property.Player.queue.html b/doc/clapper/property.Player.queue.html index 8da3a67d..00244544 100644 --- a/doc/clapper/property.Player.queue.html +++ b/doc/clapper/property.Player.queue.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/property.Player.speed.html b/doc/clapper/property.Player.speed.html index 0304c44d..be6bf6fd 100644 --- a/doc/clapper/property.Player.speed.html +++ b/doc/clapper/property.Player.speed.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,10 +171,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
- + + +
Setter methodclapper_player_set_speed()
Default value1.000000
Getter methodclapper_player_get_speed()
Setter methodclapper_player_set_speed()
diff --git a/doc/clapper/property.Player.state.html b/doc/clapper/property.Player.state.html index aab68bf2..048c9f16 100644 --- a/doc/clapper/property.Player.state.html +++ b/doc/clapper/property.Player.state.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,6 +171,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default valueCLAPPER_PLAYER_STATE_STOPPED
Getter methodclapper_player_get_state()
diff --git a/doc/clapper/property.Player.video-filter.html b/doc/clapper/property.Player.video-filter.html index b8cd2950..2fb19e29 100644 --- a/doc/clapper/property.Player.video-filter.html +++ b/doc/clapper/property.Player.video-filter.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,10 +171,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later diff --git a/doc/clapper/property.Player.video-sink.html b/doc/clapper/property.Player.video-sink.html index d8bf5cd6..bb31d2a9 100644 --- a/doc/clapper/property.Player.video-sink.html +++ b/doc/clapper/property.Player.video-sink.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -171,10 +171,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later diff --git a/doc/clapper/property.Player.volume.html b/doc/clapper/property.Player.volume.html index 29d092bc..8d65ffc8 100644 --- a/doc/clapper/property.Player.volume.html +++ b/doc/clapper/property.Player.volume.html @@ -115,7 +115,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -148,7 +148,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -174,10 +174,12 @@ be easily bound to volume sliders as-is.

- + + +
Setter methodclapper_player_set_volume()
Default value1.000000
Getter methodclapper_player_get_volume()
Setter methodclapper_player_set_volume()
diff --git a/doc/clapper/property.Queue.current-index.html b/doc/clapper/property.Queue.current-index.html new file mode 100644 index 00000000..2a2e9e1c --- /dev/null +++ b/doc/clapper/property.Queue.current-index.html @@ -0,0 +1,200 @@ + + + + + + Clapper.Queue:current-index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperQueue:current-index

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property current-index: guint [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Index of currently selected media item for playback.

+
+ +
+ + + + + + + +
Type:guint
+
+ + +
+ + + + + + +
Default value4294967295
Getter methodclapper_queue_get_current_index()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Queue.current-item.html b/doc/clapper/property.Queue.current-item.html index d4375e34..e2731dc0 100644 --- a/doc/clapper/property.Queue.current-item.html +++ b/doc/clapper/property.Queue.current-item.html @@ -87,8 +87,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -130,7 +136,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/property.Queue.gapless.html b/doc/clapper/property.Queue.gapless.html new file mode 100644 index 00000000..cf8d01ff --- /dev/null +++ b/doc/clapper/property.Queue.gapless.html @@ -0,0 +1,202 @@ + + + + + + Clapper.Queue:gapless + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperQueue:gapless

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property gapless: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Use gapless progression.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueFALSE
Getter methodclapper_queue_get_gapless()
Setter methodclapper_queue_set_gapless()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Queue.instant.html b/doc/clapper/property.Queue.instant.html new file mode 100644 index 00000000..24dd6c72 --- /dev/null +++ b/doc/clapper/property.Queue.instant.html @@ -0,0 +1,202 @@ + + + + + + Clapper.Queue:instant + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperQueue:instant

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property instant: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Use instant media item changes.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueFALSE
Getter methodclapper_queue_get_instant()
Setter methodclapper_queue_set_instant()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Queue.n-items.html b/doc/clapper/property.Queue.n-items.html index 4e60d169..bb2f581b 100644 --- a/doc/clapper/property.Queue.n-items.html +++ b/doc/clapper/property.Queue.n-items.html @@ -87,8 +87,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -130,7 +136,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -153,6 +159,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
+ +
Default value0
Getter methodclapper_queue_get_n_items()
diff --git a/doc/clapper/property.Queue.progression-mode.html b/doc/clapper/property.Queue.progression-mode.html index 1c4843bd..0f94a5d0 100644 --- a/doc/clapper/property.Queue.progression-mode.html +++ b/doc/clapper/property.Queue.progression-mode.html @@ -87,8 +87,14 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Properties
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -130,7 +136,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -153,10 +159,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later
- + + +
Setter methodclapper_queue_set_progression_mode()
Default valueCLAPPER_QUEUE_PROGRESSION_CONSECUTIVE
Getter methodclapper_queue_get_progression_mode()
Setter methodclapper_queue_set_progression_mode()
diff --git a/doc/clapper/property.Server.current-port.html b/doc/clapper/property.Server.current-port.html new file mode 100644 index 00000000..15906c25 --- /dev/null +++ b/doc/clapper/property.Server.current-port.html @@ -0,0 +1,198 @@ + + + + + + Clapper.Server:current-port + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperServer:current-port

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property current-port: guint [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Port on which server is currently listening on or 0 if not listening.

+
+ +
+ + + + + + + +
Type:guint
+
+ + +
+ + + + + + +
Default value0
Getter methodclapper_server_get_current_port()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Server.enabled.html b/doc/clapper/property.Server.enabled.html new file mode 100644 index 00000000..e193b89e --- /dev/null +++ b/doc/clapper/property.Server.enabled.html @@ -0,0 +1,200 @@ + + + + + + Clapper.Server:enabled + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperServer:enabled

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property enabled: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Whether server is enabled.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueFALSE
Getter methodclapper_server_get_enabled()
Setter methodclapper_server_set_enabled()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Server.port.html b/doc/clapper/property.Server.port.html new file mode 100644 index 00000000..bac67657 --- /dev/null +++ b/doc/clapper/property.Server.port.html @@ -0,0 +1,200 @@ + + + + + + Clapper.Server:port + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperServer:port

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property port: guint [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Port to listen on or 0 for using random unused port.

+
+ +
+ + + + + + + +
Type:guint
+
+ + +
+ + + + + + + + +
Default value0
Getter methodclapper_server_get_port()
Setter methodclapper_server_set_port()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Server.queue-controllable.html b/doc/clapper/property.Server.queue-controllable.html new file mode 100644 index 00000000..3ee0a2d3 --- /dev/null +++ b/doc/clapper/property.Server.queue-controllable.html @@ -0,0 +1,200 @@ + + + + + + Clapper.Server:queue-controllable + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperServer:queue-controllable

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property queue-controllable: gboolean [ read, write ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Whether remote server clients can control ClapperQueue.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + + + +
Default valueFALSE
Getter methodclapper_server_get_queue_controllable()
Setter methodclapper_server_set_queue_controllable()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableyes
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Server.running.html b/doc/clapper/property.Server.running.html new file mode 100644 index 00000000..03bb95a7 --- /dev/null +++ b/doc/clapper/property.Server.running.html @@ -0,0 +1,198 @@ + + + + + + Clapper.Server:running + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperServer:running

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property running: gboolean [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Whether server is currently running.

+
+ +
+ + + + + + + +
Type:gboolean
+
+ + +
+ + + + + + +
Default valueFALSE
Getter methodclapper_server_get_running()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.Stream.caps.html b/doc/clapper/property.Stream.caps.html new file mode 100644 index 00000000..2ec996cf --- /dev/null +++ b/doc/clapper/property.Stream.caps.html @@ -0,0 +1,188 @@ + + + + + + Clapper.Stream:caps + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperStream:caps

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property caps: Gst.Caps [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

The GstCaps of stream.

+
+ +
+ + + + + + + +
Type:GstCaps
+
+ + +
+ + + + +
Getter methodclapper_stream_get_caps()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.StreamList.current-index.html b/doc/clapper/property.StreamList.current-index.html new file mode 100644 index 00000000..8e820501 --- /dev/null +++ b/doc/clapper/property.StreamList.current-index.html @@ -0,0 +1,192 @@ + + + + + + Clapper.StreamList:current-index + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperStreamList:current-index

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property current-index: guint [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Index of currently selected stream.

+
+ +
+ + + + + + + +
Type:guint
+
+ + +
+ + + + + + +
Default value4294967295
Getter methodclapper_stream_list_get_current_index()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/property.StreamList.current-stream.html b/doc/clapper/property.StreamList.current-stream.html new file mode 100644 index 00000000..ecd091bc --- /dev/null +++ b/doc/clapper/property.StreamList.current-stream.html @@ -0,0 +1,190 @@ + + + + + + Clapper.StreamList:current-stream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Property

+

ClapperStreamList:current-stream

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
property current-stream: Clapper.Stream [ read ]
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Currently selected stream.

+
+ +
+ + + + + + + +
Type:ClapperStream
+
+ + +
+ + + + +
Getter methodclapper_stream_list_get_current_stream()
+
+ +
+ +
+

+ Flags + +

+ +
+ + + + + +
Readableyes
Writableno
Constructno
Construct onlyno
+
+
+ +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/search.js b/doc/clapper/search.js index f635df65..29c204f9 100644 --- a/doc/clapper/search.js +++ b/doc/clapper/search.js @@ -27,6 +27,49 @@ const QUERY_TYPES = [ ]; const QUERY_PATTERN = new RegExp("^(" + QUERY_TYPES.join('|') + ")\\s*:\\s*", 'i'); +const TYPE_NAMES = { + "alias": "alias", + "bitfield": "flags", + "callback": "callback", + "class": "class", + "constant": "constant", + "content": "content", + "ctor": "constructor", + "domain": "error", + "enum": "enum", + "function_macro": "macro", + "function": "function", + "interface": "interface", + "method": "method", + "property": "property", + "record": "struct", + "signal": "signal", + "type_func": "function", + "union": "union", + "vfunc": "vfunc", +}; + +const TYPE_CLASSES = { + "alias": "alias", + "bitfield": "flags", + "callback": "callback", + "class": "class", + "constant": "constant", + "content": "extra_content", + "ctor": "ctor", + "domain": "domain", + "enum": "enum", + "function_macro": "function_macro", + "function": "function", + "interface": "interface", + "method": "method", + "property": "property", + "record": "record", + "signal": "signal", + "type_func": "type_func", + "union": "union", + "vfunc": "vfunc", +}; const fzy = window.fzy; const searchParams = getSearchParams(); @@ -109,6 +152,7 @@ function searchQuery(query) { text: getLabelForDocument(doc, searchIndex.meta), href: getLinkForDocument(doc), summary: doc.summary, + deprecated: doc.deprecated, }; }); @@ -148,17 +192,18 @@ function renderResults(query, results) { html += "No results found."; } else { - html += "" + - ""; + html += "
"; results.forEach(function(item) { - html += "
" + - "" + - "" + - ""; + html += "
" + + "" + item.text + "" + + " " + TYPE_NAMES[item.type] + ""; + if (item.deprecated) { + html += " deprecated: " + item.deprecated + ""; + } + html += "
" + + "
" + item.summary + "
"; }); - html += "
NameDescription
" + - "" + item.text + "" + - "" + item.summary + "
"; + html += "
"; } html += ""; @@ -247,7 +292,7 @@ function getLabelForDocument(doc, meta) { // NOTE: meta.ns added for more consistent results, otherwise // searching for "Button" would return all signals, properties - // and vfuncs (eg "Button.clicked") before the actual object + // and vfuncs (eg "Button.clicked") before the actual object // (eg "GtkButton") because "Button" matches higher with starting // sequences. case "property": @@ -288,7 +333,7 @@ function getTextForDocument(doc, meta) { // NOTE: meta.ns added for more consistent results, otherwise // searching for "Button" would return all signals, properties - // and vfuncs (eg "Button.clicked") before the actual object + // and vfuncs (eg "Button.clicked") before the actual object // (eg "GtkButton") because "Button" matches higher with starting // sequences. case "property": diff --git a/doc/clapper/signal.Player.error.html b/doc/clapper/signal.Player.error.html index b7ab194a..a546e9ed 100644 --- a/doc/clapper/signal.Player.error.html +++ b/doc/clapper/signal.Player.error.html @@ -97,7 +97,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -138,7 +138,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -151,12 +151,12 @@ playback will stop due to the error.

- + - + diff --git a/doc/clapper/signal.Player.missing-plugin.html b/doc/clapper/signal.Player.missing-plugin.html index ae6bfd96..05faa951 100644 --- a/doc/clapper/signal.Player.missing-plugin.html +++ b/doc/clapper/signal.Player.missing-plugin.html @@ -97,7 +97,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -124,7 +124,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
void
 missing_plugin (
   ClapperPlayer* self,
-  gchar* description,
+  gchar* name,
   gchar* installer_detail,
   gpointer user_data
 )
@@ -138,7 +138,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
         Description
         
         
-        [src]
+        [src]
         
       
 
@@ -152,12 +152,12 @@ about what is missing and prompt him to install it with an external install
         
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Signal emission will restart instead of recursing
Hooks are disabled for this signal
Hooks are disabled for this signal
- + - + @@ -178,7 +178,7 @@ about what is missing and prompt him to install it with an external install
-
description
+
name

Type: gchar*

A localised string describing the missing feature, for use in diff --git a/doc/clapper/signal.Player.warning.html b/doc/clapper/signal.Player.warning.html index b2280619..f6958958 100644 --- a/doc/clapper/signal.Player.warning.html +++ b/doc/clapper/signal.Player.warning.html @@ -97,7 +97,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later

-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -138,7 +138,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -151,12 +151,12 @@ be treated like warnings. Should not generally prevent/stop playback.

Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Signal emission will restart instead of recursing
Hooks are disabled for this signal
Hooks are disabled for this signal
- + - + diff --git a/doc/clapper/signal.Server.error.html b/doc/clapper/signal.Server.error.html new file mode 100644 index 00000000..dfd9d9e1 --- /dev/null +++ b/doc/clapper/signal.Server.error.html @@ -0,0 +1,214 @@ + + + + + + Clapper.Server::error + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Signal

+

ClapperServer::error

+
+ +
+
+

+
+
+

+ Declaration + +

+ +
+
void
+error (
+  ClapperServer* self,
+  GError* error,
+  gpointer user_data
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

Error signal when server could not start. +This will be emitted from application main thread.

+
+ +
+
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Signal emission will restart instead of recursing
Hooks are disabled for this signal
Hooks are disabled for this signal
+ + + + + + + + + + + + +
Default handler:

The default handler is called after the handlers added via g_signal_connect().

Signal emission will restart instead of recursing
Hooks are disabled for this signal
+ + + + + + +
+

+ Parameters + +

+ +
+
+ +
error
+
+

Type: GError

+

A GError.

+ + + + + + + + + + +
The data is owned by the caller of the function.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+ + + \ No newline at end of file diff --git a/doc/clapper/style.css b/doc/clapper/style.css index 2b537f36..5d3ff742 100644 --- a/doc/clapper/style.css +++ b/doc/clapper/style.css @@ -70,6 +70,22 @@ --table-font-size: 0.92em; /* Tables often contain lots information. It's better to scale them down a big to get more sutff fitted inside */ + --admonition-color-bg: transparent; + --admonition-font-size: 0.9rem; + --admonition-color-title--note: #00b0ff; + --admonition-color-title-bg--note: rgba(0, 176, 255, 0.1); + --admonition-color-title--important: #00bfa5; + --admonition-color-title-bg--important: rgba(0, 191, 165, 0.1); + --admonition-color-title--tip: #00c852; + --admonition-color-title-bg--tip: rgba(0, 200, 82, 0.1); + --admonition-color-title--warning: #ff9100; + --admonition-color-title-bg--warning: rgba(255, 145, 0, 0.1); + + --admonition-icon--note: url('data:image/svg+xml;charset=utf-8,'); + --admonition-icon--important: url('data:image/svg+xml;charset=utf-8,'); + --admonition-icon--tip: url('data:image/svg+xml;charset=utf-8,'); + --admonition-icon--warning: url('data:image/svg+xml;charset=utf-8,'); + /* misc */ --preferred-content-width: 90ch; /* The preferred width for the readable content */ --anchor-sign: "#"; @@ -98,6 +114,7 @@ --error-fg-color: #ffffff; --accent-bg-color: #3584e4; --accent-fg-color: #ffffff; + color-scheme: dark; } } @@ -139,8 +156,6 @@ h1, h2, h3, h4, h5, h6 { font-family: var(--heading-font-family); font-weight: var(--heading-weight); margin: 1.75em 0 0.75em 0; - display: flex; - align-items: center; } h1 { @@ -764,58 +779,24 @@ kbd { padding-right: 0; } -table.enum-members, -table.results { - border-radius: var(--box-radius); - border: 1px solid var(--text-color-muted); - border-spacing: 0 0 !important; +dl.enum-members { font-size: 80%; } -table.enum-members tr th, -table.results tr th { - border-top-color: var(--body-bg); - background-color: var(--box-bg); - border-bottom: 1px solid var(--text-color-muted); +dl.enum-members dt { + padding-top: 1em; } -table.enum-members tr th:first-child, -table.enum-members tr td:first-child { - min-width: 25em; - padding-left: .5em; -} - -table.results tr th:first-child, -table.results tr td:first-child { - padding-left: .5em; -} - -table.enum-members tr th:last-child, -table.enum-members tr td:last-child, -table.results tr th:last-child, -table.results tr td:last-child { - max-width: 35em; - padding-right: .5em; -} - -table.results tr td code { - font-size: 100%; -} - -table.arguments tr td, -table.returns tr td { +table.arguments tr td { color: var(--text-color-muted); } -table.arguments tr td:first-child, -table.returns tr td:first-child { +table.arguments tr td:first-child { min-width: 12em; } table.arguments tr.arg-name td, -table.arguments tr.arg-description td, -table.returns tr.arg-name td, -table.returns tr.arg-description td { +table.arguments tr.arg-description td { color: var(--text-color); } @@ -890,6 +871,126 @@ table.returns tr.arg-description td { color: var(--accent-fg-color); } +dt.result { + padding: .5em 0; +} + +.result.emblem.alias, +.result.emblem.bitfield, +.result.emblem.callback, +.result.emblem.class, +.result.emblem.constant, +.result.emblem.extra_content, +.result.emblem.ctor, +.result.emblem.domain, +.result.emblem.enum, +.result.emblem.function_macro, +.result.emblem.function, +.result.emblem.interface, +.result.emblem.method, +.result.emblem.property, +.result.emblem.record, +.result.emblem.signal, +.result.emblem.type_func, +.result.emblem.union, +.result.emblem.vfunc { + background-color: var(--accent-bg-color); + color: var(--accent-fg-color); +} + +.admonition { + background: var(--admonition-color-bg); + border-left: .2rem solid #651fff; + border-radius: .2rem; + box-shadow: 0 .2rem .5rem rgba(0, 0, 0, .05), 0 0 .0625rem rgba(0, 0, 0, .1); + font-size: var(--admonition-font-size); + margin: 1rem auto; + overflow: hidden; + padding: 0 .5rem .5rem; + page-break-inside: avoid; +} + +.admonition > p.admonition-title { + font-weight: 500; + line-height: 1.3; + margin: 0 -.5rem .5rem; + padding: .4rem .5rem .4rem 2rem; + position: relative; +} + +p.admonition-title::before { + content: ""; + position: absolute; + left: .5rem; + height: 1rem; + width: 1rem; + -webkit-mask-repeat: no-repeat; + mask-repeat: no-repeat; +} + +.admonition.note > .admonition-title, +.admonition.seealso > .admonition-title { + background-color: var(--admonition-color-title-bg--note); +} + +.admonition.note > .admonition-title::before, +.admonition.seealso > .admonition-title::before { + background-color: var(--admonition-color-title--note); + -webkit-mask-image: var(--admonition-icon--note); + mask-image: var(--admonition-icon--note); + +} + +.admonition.note, +.admonition.seealso { + border-left-color: var(--admonition-color-title--note); +} + +.admonition.tip > .admonition-title, +.admonition.hint > .admonition-title { + background-color: var(--admonition-color-title-bg--tip); +} + +.admonition.tip > .admonition-title::before, +.admonition.hint > .admonition-title::before { + background-color: var(--admonition-color-title--tip); + -webkit-mask-image: var(--admonition-icon--tip); + mask-image: var(--admonition-icon--tip); +} + +.admonition.tip, +.admonition.hint { + border-left-color: var(--admonition-color-title--tip); +} + +.admonition.important > .admonition-title { + background-color: var(--admonition-color-title-bg--important); +} + +.admonition.important > .admonition-title::before { + background-color: var(--admonition-color-title--important); + -webkit-mask-image: var(--admonition-icon--important); + mask-image: var(--admonition-icon--important); +} + +.admonition.important { + border-left-color: var(--admonition-color-title--important); +} + +.admonition.warning > .admonition-title { + background-color: var(--admonition-color-title-bg--warning); +} + +.admonition.warning > .admonition-title::before { + background-color: var(--admonition-color-title--warning); + -webkit-mask-image: var(--admonition-icon--warning); + mask-image: var(--admonition-icon--warning); +} + +.admonition.warning { + border-left-color: var(--admonition-color-title--warning); +} + /************************************************************* SYMBOLS **************************************************************/ diff --git a/doc/clapper/urlmap.js b/doc/clapper/urlmap.js index 2000424d..42bc5b7c 100644 --- a/doc/clapper/urlmap.js +++ b/doc/clapper/urlmap.js @@ -1,11 +1,11 @@ -doc_base_urls = [ +baseURLs = [ ['GLib', 'https://docs.gtk.org/glib/'], ['GObject', 'https://docs.gtk.org/gobject/'], ['Gio', 'https://docs.gtk.org/gio/'], ['Gtk', 'https://docs.gtk.org/gtk4/'], - ['Gst', 'https://gstreamer.freedesktop.org/documentation/'], - ['GstBase', 'https://gstreamer.freedesktop.org/documentation/base/'], - ['GstAudio', 'https://gstreamer.freedesktop.org/documentation/audio/'], - ['GstTag', 'https://gstreamer.freedesktop.org/documentation/tag/'], - ['GstPbutils', 'https://gstreamer.freedesktop.org/documentation/pbutils/'], + ['Gst', 'https://gstreamer.freedesktop.org/documentation/gstreamer/gi-index.html?'], + ['GstBase', 'https://gstreamer.freedesktop.org/documentation/base/?'], + ['GstAudio', 'https://gstreamer.freedesktop.org/documentation/audio/?'], + ['GstTag', 'https://gstreamer.freedesktop.org/documentation/tag/?'], + ['GstPbutils', 'https://gstreamer.freedesktop.org/documentation/pbutils/?'], ] diff --git a/doc/clapper/vfunc.Feature.media_item_updated.html b/doc/clapper/vfunc.Feature.item_updated.html similarity index 87% rename from doc/clapper/vfunc.Feature.media_item_updated.html rename to doc/clapper/vfunc.Feature.item_updated.html index ad435703..4543b480 100644 --- a/doc/clapper/vfunc.Feature.media_item_updated.html +++ b/doc/clapper/vfunc.Feature.item_updated.html @@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - Clapper.Feature.media_item_updated + Clapper.Feature.item_updated @@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later - - - - + + + + @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -127,7 +131,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later

Virtual Method

-

ClapperFeaturemedia_item_updated

+

ClapperFeatureitem_updated

@@ -140,13 +144,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src]
void
-media_item_updated (
+item_updated (
   ClapperFeature* feature,
   ClapperMediaItem* item
 )
@@ -160,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
         Description
         
         
-        [src]
+        [src]
         
       
 
diff --git a/doc/clapper/vfunc.Feature.mute_changed.html b/doc/clapper/vfunc.Feature.mute_changed.html
index d6c21410..e2eaaa5d 100644
--- a/doc/clapper/vfunc.Feature.mute_changed.html
+++ b/doc/clapper/vfunc.Feature.mute_changed.html
@@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
   
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.current_media_item_changed.html b/doc/clapper/vfunc.Feature.played_item_changed.html similarity index 83% rename from doc/clapper/vfunc.Feature.current_media_item_changed.html rename to doc/clapper/vfunc.Feature.played_item_changed.html index ce111cb3..63f2e1c5 100644 --- a/doc/clapper/vfunc.Feature.current_media_item_changed.html +++ b/doc/clapper/vfunc.Feature.played_item_changed.html @@ -7,7 +7,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later - Clapper.Feature.current_media_item_changed + Clapper.Feature.played_item_changed @@ -23,10 +23,10 @@ SPDX-License-Identifier: LGPL-2.1-or-later - - - - + + + + @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -127,7 +131,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later

Virtual Method

-

ClapperFeaturecurrent_media_item_changed

+

ClapperFeatureplayed_item_changed

@@ -140,15 +144,15 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src]
void
-current_media_item_changed (
+played_item_changed (
   ClapperFeature* feature,
-  ClapperMediaItem* current_item
+  ClapperMediaItem* item
 )
 
@@ -160,13 +164,13 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]
-

Currently playing media item got changed. -Item will be NULL if no new item was selected.

+

New media item started playing. All following events (such as position changes) +will be related to this item from now on.

@@ -188,13 +192,13 @@ Item will be NULL if no new item was selected.

-
current_item
+
item

Type: ClapperMediaItem

-

A ClapperMediaItem that is now selected.

+

A ClapperMediaItem that is now playing.

- + diff --git a/doc/clapper/vfunc.Feature.position_changed.html b/doc/clapper/vfunc.Feature.position_changed.html index 976a16ee..c16c64c2 100644 --- a/doc/clapper/vfunc.Feature.position_changed.html +++ b/doc/clapper/vfunc.Feature.position_changed.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.prepare.html b/doc/clapper/vfunc.Feature.prepare.html index fba41bf4..75fecee0 100644 --- a/doc/clapper/vfunc.Feature.prepare.html +++ b/doc/clapper/vfunc.Feature.prepare.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,7 +163,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.property_changed.html b/doc/clapper/vfunc.Feature.property_changed.html new file mode 100644 index 00000000..5fc029ab --- /dev/null +++ b/doc/clapper/vfunc.Feature.property_changed.html @@ -0,0 +1,236 @@ + + + + + + Clapper.Feature.property_changed + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Virtual Method

+

ClapperFeatureproperty_changed

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+property_changed (
+  ClapperFeature* feature,
+  GParamSpec* pspec
+)
+
+
+
+
+ +
+

+ Description + + + [src] + +

+ +
+

A property of feature changed its value.

+

Useful for reconfiguring feature, since unlike “notify” signal +this is always called from the thread that feature works on and +only after feature was prepared.

+
+ +
+ + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
pspec
+
+

Type: GParamSpec

+

A GParamSpec.

+
The argument can be NULL.
+ + + + + + + + + +
The data is owned by the caller of the function.
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/vfunc.Feature.queue_cleared.html b/doc/clapper/vfunc.Feature.queue_cleared.html index 36202231..c9d8b8a6 100644 --- a/doc/clapper/vfunc.Feature.queue_cleared.html +++ b/doc/clapper/vfunc.Feature.queue_cleared.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,7 +163,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.queue_item_added.html b/doc/clapper/vfunc.Feature.queue_item_added.html index 2dd7b12f..f468499e 100644 --- a/doc/clapper/vfunc.Feature.queue_item_added.html +++ b/doc/clapper/vfunc.Feature.queue_item_added.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -161,7 +165,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.queue_item_removed.html b/doc/clapper/vfunc.Feature.queue_item_removed.html index 48743d97..09a7af6c 100644 --- a/doc/clapper/vfunc.Feature.queue_item_removed.html +++ b/doc/clapper/vfunc.Feature.queue_item_removed.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -148,7 +152,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
void
 queue_item_removed (
   ClapperFeature* feature,
-  ClapperMediaItem* item
+  ClapperMediaItem* item,
+  guint index
 )
 
@@ -160,7 +165,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] @@ -201,6 +206,23 @@ SPDX-License-Identifier: LGPL-2.1-or-later The data is owned by the caller of the function. + + + +
index
+
+

Type: guint

+

Position from which item was removed in queue.

+ + + + + + + + + +
diff --git a/doc/clapper/vfunc.Feature.queue_item_repositioned.html b/doc/clapper/vfunc.Feature.queue_item_repositioned.html new file mode 100644 index 00000000..0e1c22c1 --- /dev/null +++ b/doc/clapper/vfunc.Feature.queue_item_repositioned.html @@ -0,0 +1,249 @@ + + + + + + Clapper.Feature.queue_item_repositioned + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+
+

Virtual Method

+

ClapperFeaturequeue_item_repositioned

+
+ +
+
+

+
+ +
+

+ Declaration + + + [src] + +

+ +
+
void
+queue_item_repositioned (
+  ClapperFeature* feature,
+  guint before,
+  guint after
+)
+
+
+
+
+ +
+

+ Description + + +

+ +
+ No description available. +
+ +
+ + + +
+ + +
+ + +
+

+ Parameters + +

+ +
+
+ +
before
+
+

Type: guint

+

No description available.

+ + + + + + + + + + +
+
+ +
after
+
+

Type: guint

+

No description available.

+ + + + + + + + + + +
+
+ + + +
+
+
+ + + + +
+
+ + + + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/vfunc.Feature.queue_progression_changed.html b/doc/clapper/vfunc.Feature.queue_progression_changed.html index fb7694c9..7c0a295a 100644 --- a/doc/clapper/vfunc.Feature.queue_progression_changed.html +++ b/doc/clapper/vfunc.Feature.queue_progression_changed.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,12 +164,12 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]
-

ClapperQueueProgressionMode of the queue was changed.

+

Progression mode of the queue was changed.

diff --git a/doc/clapper/vfunc.Feature.speed_changed.html b/doc/clapper/vfunc.Feature.speed_changed.html index 557678f0..807794a9 100644 --- a/doc/clapper/vfunc.Feature.speed_changed.html +++ b/doc/clapper/vfunc.Feature.speed_changed.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.state_changed.html b/doc/clapper/vfunc.Feature.state_changed.html index 37aefe7f..84bed61e 100644 --- a/doc/clapper/vfunc.Feature.state_changed.html +++ b/doc/clapper/vfunc.Feature.state_changed.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.unprepare.html b/doc/clapper/vfunc.Feature.unprepare.html index dcc0874e..2a6ee401 100644 --- a/doc/clapper/vfunc.Feature.unprepare.html +++ b/doc/clapper/vfunc.Feature.unprepare.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -159,7 +163,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.Feature.volume_changed.html b/doc/clapper/vfunc.Feature.volume_changed.html index 784d4c78..13035344 100644 --- a/doc/clapper/vfunc.Feature.volume_changed.html +++ b/doc/clapper/vfunc.Feature.volume_changed.html @@ -87,22 +87,26 @@ SPDX-License-Identifier: LGPL-2.1-or-later
Virtual methods
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -140,7 +144,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -160,7 +164,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.ThreadedObject.thread_start.html b/doc/clapper/vfunc.ThreadedObject.thread_start.html index 6a73b362..8ecc24b6 100644 --- a/doc/clapper/vfunc.ThreadedObject.thread_start.html +++ b/doc/clapper/vfunc.ThreadedObject.thread_start.html @@ -95,7 +95,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -118,7 +118,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -137,7 +137,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src] diff --git a/doc/clapper/vfunc.ThreadedObject.thread_stop.html b/doc/clapper/vfunc.ThreadedObject.thread_stop.html index cc679001..34be2da8 100644 --- a/doc/clapper/vfunc.ThreadedObject.thread_stop.html +++ b/doc/clapper/vfunc.ThreadedObject.thread_stop.html @@ -95,7 +95,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later
-

Generated by gi-docgen 2023.1

+

Generated by gi-docgen 2023.3

@@ -118,7 +118,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Declaration - [src] + [src] @@ -137,7 +137,7 @@ SPDX-License-Identifier: LGPL-2.1-or-later Description - [src] + [src]