From f0aad34e5bf7d3e9b29d7ca0b236fa25c225f405 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 8 Aug 2025 17:14:02 +0000 Subject: [PATCH] doc: Update --- doc/clapper-gtk/clapper-gtk.devhelp2 | 2 +- doc/clapper-gtk/clapper-gtk.toml | 1 + doc/clapper-gtk/index.html | 2 + doc/clapper-gtk/index.json | 2 +- doc/clapper-gtk/migrating-to-010.html | 148 ++++++++++++++++++++++++++ doc/clapper/migrating-to-010.html | 4 +- 6 files changed, 155 insertions(+), 4 deletions(-) create mode 100644 doc/clapper-gtk/migrating-to-010.html diff --git a/doc/clapper-gtk/clapper-gtk.devhelp2 b/doc/clapper-gtk/clapper-gtk.devhelp2 index 5affd0ed..521a4b77 100644 --- a/doc/clapper-gtk/clapper-gtk.devhelp2 +++ b/doc/clapper-gtk/clapper-gtk.devhelp2 @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/doc/clapper-gtk/clapper-gtk.toml b/doc/clapper-gtk/clapper-gtk.toml index 220f7a04..bfe97c7a 100644 --- a/doc/clapper-gtk/clapper-gtk.toml +++ b/doc/clapper-gtk/clapper-gtk.toml @@ -56,6 +56,7 @@ base_url = "https://github.com/Rafostar/clapper/tree/master/" [extra] # The same order will be used when generating the index content_files = [ + "migrating-to-010.md", ] content_images = [ "images/clapper-logo.svg", diff --git a/doc/clapper-gtk/index.html b/doc/clapper-gtk/index.html index d5a20a75..cf745b10 100644 --- a/doc/clapper-gtk/index.html +++ b/doc/clapper-gtk/index.html @@ -349,6 +349,8 @@ SPDX-License-Identifier: LGPL-2.1-or-later
diff --git a/doc/clapper-gtk/index.json b/doc/clapper-gtk/index.json index 14c8def9..a6e3021d 100644 --- a/doc/clapper-gtk/index.json +++ b/doc/clapper-gtk/index.json @@ -1 +1 @@ -{"meta":{"ns":"ClapperGtk","version":"0.0","generator":"gi-docgen","generator-version":"2025.4"},"symbols":[{"type":"bitfield","name":"VideoActionMask","ctype":"ClapperGtkVideoActionMask","summary":"No description available.","deprecated":null},{"type":"class","name":"Audio","ctype":"ClapperGtkAudio","summary":"A GTK widget for audio playback with Clapper API. #ClapperGtkAudio is a widget meant for integrating audio playback ...","deprecated":null},{"type":"class","name":"Av","ctype":"ClapperGtkAv","summary":"A base class for GTK audio and video widgets. See its descendants: [class@ClapperGtk.Audio] and [class@ClapperGtk.Video]. # Actions ...","deprecated":null},{"type":"class","name":"Billboard","ctype":"ClapperGtkBillboard","summary":"A layer where various messages can be displayed. #ClapperGtkBillboard widget is meant to be overlaid on top of ...","deprecated":null},{"type":"class","name":"Container","ctype":"ClapperGtkContainer","summary":"A simple container widget that holds just one child. It is designed to work well with OSD overlay, ...","deprecated":null},{"type":"class","name":"ExtraMenuButton","ctype":"ClapperGtkExtraMenuButton","summary":"A menu button with extra options.","deprecated":null},{"type":"class","name":"LeadContainer","ctype":"ClapperGtkLeadContainer","summary":"A #ClapperGtkContainer that can take priority in user interactions with the #ClapperGtkVideo. #ClapperGtkLeadContainer is a special type of ...","deprecated":null},{"type":"class","name":"NextItemButton","ctype":"ClapperGtkNextItemButton","summary":"A #GtkButton for selecting next queue item.","deprecated":null},{"type":"class","name":"PreviousItemButton","ctype":"ClapperGtkPreviousItemButton","summary":"A #GtkButton for selecting previous queue item.","deprecated":null},{"type":"class","name":"SeekBar","ctype":"ClapperGtkSeekBar","summary":"A bar for seeking and displaying playback position.","deprecated":null},{"type":"class","name":"SimpleControls","ctype":"ClapperGtkSimpleControls","summary":"A minimalistic playback controls panel widget. #ClapperGtkSimpleControls is a simple, ready to be used playback controls widget. It ...","deprecated":null},{"type":"class","name":"TitleHeader","ctype":"ClapperGtkTitleHeader","summary":"A header panel widget that displays current media title. #ClapperGtkTitleHeader is a simple, ready to be used header ...","deprecated":null},{"type":"class","name":"TitleLabel","ctype":"ClapperGtkTitleLabel","summary":"A label showing an up to date title of media item. By default #ClapperGtkTitleLabel will automatically show title ...","deprecated":null},{"type":"class","name":"ToggleFullscreenButton","ctype":"ClapperGtkToggleFullscreenButton","summary":"A #GtkButton for toggling fullscreen state.","deprecated":null},{"type":"class","name":"TogglePlayButton","ctype":"ClapperGtkTogglePlayButton","summary":"A #GtkButton for toggling play/pause of playback.","deprecated":null},{"type":"class","name":"Video","ctype":"ClapperGtkVideo","summary":"A ready to be used GTK video widget implementing Clapper API. #ClapperGtkVideo is the main widget exposed by ...","deprecated":null},{"type":"constant","name":"MAJOR_VERSION","ident":"CLAPPER_GTK_MAJOR_VERSION","summary":"ClapperGtk major version component","deprecated":null},{"type":"constant","name":"MICRO_VERSION","ident":"CLAPPER_GTK_MICRO_VERSION","summary":"ClapperGtk micro version component","deprecated":null},{"type":"constant","name":"MINOR_VERSION","ident":"CLAPPER_GTK_MINOR_VERSION","summary":"ClapperGtk minor version component","deprecated":null},{"type":"constant","name":"VERSION_S","ident":"CLAPPER_GTK_VERSION_S","summary":"ClapperGtk version, encoded as a string","deprecated":null},{"type":"ctor","name":"new","type_name":"Audio","ident":"clapper_gtk_audio_new","summary":"Creates a new #ClapperGtkAudio instance. Newly created audio widget will also have set \"scaletempo\" GStreamer element as default ...","deprecated":null},{"type":"ctor","name":"new","type_name":"Billboard","ident":"clapper_gtk_billboard_new","summary":"Creates a new #ClapperGtkBillboard instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"Container","ident":"clapper_gtk_container_new","summary":"Creates a new #ClapperGtkContainer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_new","summary":"Creates a new #ClapperGtkExtraMenuButton instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_new","summary":"Creates a new #ClapperGtkLeadContainer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"NextItemButton","ident":"clapper_gtk_next_item_button_new","summary":"Creates a new #ClapperGtkNextItemButton to play next #ClapperMediaItem.","deprecated":null},{"type":"ctor","name":"new","type_name":"PreviousItemButton","ident":"clapper_gtk_previous_item_button_new","summary":"Creates a new #ClapperGtkPreviousItemButton to play previous #ClapperMediaItem.","deprecated":null},{"type":"ctor","name":"new","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_new","summary":"Creates a new #ClapperGtkSeekBar instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_new","summary":"Creates a new #ClapperGtkSimpleControls instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"TitleHeader","ident":"clapper_gtk_title_header_new","summary":"Creates a new #ClapperGtkTitleHeader instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"TitleLabel","ident":"clapper_gtk_title_label_new","summary":"Creates a new #ClapperGtkTitleLabel instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"ToggleFullscreenButton","ident":"clapper_gtk_toggle_fullscreen_button_new","summary":"Creates a new #ClapperGtkToggleFullscreenButton instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"TogglePlayButton","ident":"clapper_gtk_toggle_play_button_new","summary":"Creates a new #ClapperGtkTogglePlayButton instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"Video","ident":"clapper_gtk_video_new","summary":"Creates a new #ClapperGtkVideo instance. Newly created video widget will also have set some default GStreamer elements on ...","deprecated":null},{"type":"function","name":"get_major_version","ident":"clapper_gtk_get_major_version","summary":"ClapperGtk runtime major version component This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.MAJOR_VERSION] ...","deprecated":null},{"type":"function","name":"get_micro_version","ident":"clapper_gtk_get_micro_version","summary":"ClapperGtk runtime micro version component This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.MICRO_VERSION] ...","deprecated":null},{"type":"function","name":"get_minor_version","ident":"clapper_gtk_get_minor_version","summary":"ClapperGtk runtime minor version component This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.MINOR_VERSION] ...","deprecated":null},{"type":"function","name":"get_player_from_ancestor","ident":"clapper_gtk_get_player_from_ancestor","summary":"Get [class@Clapper.Player] used by [class@ClapperGtk.Av] ancestor of @widget. This utility is a convenience wrapper for calling [method@Gtk.Widget.get_ancestor] of ...","deprecated":null},{"type":"function","name":"get_resource","ident":"clapper_gtk_get_resource","summary":"No description available.","deprecated":null},{"type":"function","name":"get_version_s","ident":"clapper_gtk_get_version_s","summary":"ClapperGtk runtime version as string This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.VERSION_S] ...","deprecated":null},{"type":"function_macro","name":"AUDIO_CAST","ident":"CLAPPER_GTK_AUDIO_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"AV_CAST","ident":"CLAPPER_GTK_AV_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"BILLBOARD_CAST","ident":"CLAPPER_GTK_BILLBOARD_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"CHECK_VERSION","ident":"CLAPPER_GTK_CHECK_VERSION","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"CONTAINER_CAST","ident":"CLAPPER_GTK_CONTAINER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"DEPRECATED_FOR","ident":"CLAPPER_GTK_DEPRECATED_FOR","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"ENCODE_VERSION","ident":"CLAPPER_GTK_ENCODE_VERSION","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"EXTRA_MENU_BUTTON_CAST","ident":"CLAPPER_GTK_EXTRA_MENU_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"LEAD_CONTAINER_CAST","ident":"CLAPPER_GTK_LEAD_CONTAINER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"NEXT_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_NEXT_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"PREVIOUS_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_PREVIOUS_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"SEEK_BAR_CAST","ident":"CLAPPER_GTK_SEEK_BAR_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"SIMPLE_CONTROLS_CAST","ident":"CLAPPER_GTK_SIMPLE_CONTROLS_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TITLE_HEADER_CAST","ident":"CLAPPER_GTK_TITLE_HEADER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TITLE_LABEL_CAST","ident":"CLAPPER_GTK_TITLE_LABEL_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TOGGLE_FULLSCREEN_BUTTON_CAST","ident":"CLAPPER_GTK_TOGGLE_FULLSCREEN_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TOGGLE_PLAY_BUTTON_CAST","ident":"CLAPPER_GTK_TOGGLE_PLAY_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"VIDEO_CAST","ident":"CLAPPER_GTK_VIDEO_CAST","summary":"No description available.","deprecated":null},{"type":"method","name":"add_fading_overlay","type_name":"Video","ident":"clapper_gtk_video_add_fading_overlay","summary":"Similiar as clapper_gtk_video_add_overlay() but will also automatically add fading functionality to overlaid #GtkWidget for convenience. This will make widget ...","deprecated":null},{"type":"method","name":"add_overlay","type_name":"Video","ident":"clapper_gtk_video_add_overlay","summary":"Add another #GtkWidget to be overlaid on top of video. The position at which @widget is placed is ...","deprecated":null},{"type":"method","name":"announce_speed","type_name":"Billboard","ident":"clapper_gtk_billboard_announce_speed","summary":"Temporarily displays current speed value on the side of @billboard. Use this if you want to present current ...","deprecated":null},{"type":"method","name":"announce_volume","type_name":"Billboard","ident":"clapper_gtk_billboard_announce_volume","summary":"Temporarily displays current volume level on the side of @billboard. Use this if you want to present current ...","deprecated":null},{"type":"method","name":"get_adaptive_height","type_name":"Container","ident":"clapper_gtk_container_get_adaptive_height","summary":"Get a @container adaptive height threshold.","deprecated":null},{"type":"method","name":"get_adaptive_width","type_name":"Container","ident":"clapper_gtk_container_get_adaptive_width","summary":"Get a @container adaptive width threshold.","deprecated":null},{"type":"method","name":"get_auto_inhibit","type_name":"Av","ident":"clapper_gtk_av_get_auto_inhibit","summary":"Get whether automatic session inhibit is enabled.","deprecated":null},{"type":"method","name":"get_auto_inhibit","type_name":"Video","ident":"clapper_gtk_video_get_auto_inhibit","summary":"Get whether automatic session inhibit is enabled.","deprecated":"0.10"},{"type":"method","name":"get_blocked_actions","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_get_blocked_actions","summary":"Get @actions that were set for this @lead_container to block.","deprecated":null},{"type":"method","name":"get_can_open_subtitles","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_get_can_open_subtitles","summary":"Get whether an option to open external subtitle stream inside popover is visible.","deprecated":null},{"type":"method","name":"get_child","type_name":"Audio","ident":"clapper_gtk_audio_get_child","summary":"Get a child #GtkWidget of @audio.","deprecated":null},{"type":"method","name":"get_child","type_name":"Container","ident":"clapper_gtk_container_get_child","summary":"Get a child #GtkWidget of @container.","deprecated":null},{"type":"method","name":"get_current_title","type_name":"TitleHeader","ident":"clapper_gtk_title_header_get_current_title","summary":"Get currently displayed title by @header.","deprecated":null},{"type":"method","name":"get_current_title","type_name":"TitleLabel","ident":"clapper_gtk_title_label_get_current_title","summary":"Get currently displayed title by @label.","deprecated":null},{"type":"method","name":"get_extra_menu_button","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_extra_menu_button","summary":"Get [class@ClapperGtk.ExtraMenuButton] that resides within @controls.","deprecated":null},{"type":"method","name":"get_fade_delay","type_name":"Video","ident":"clapper_gtk_video_get_fade_delay","summary":"Get time in milliseconds after which fading overlays should fade.","deprecated":null},{"type":"method","name":"get_fallback_to_uri","type_name":"TitleHeader","ident":"clapper_gtk_title_header_get_fallback_to_uri","summary":"Get whether a [property@Clapper.MediaItem:uri] property is going be displayed as a header text when no other title could be determined.","deprecated":null},{"type":"method","name":"get_fallback_to_uri","type_name":"TitleLabel","ident":"clapper_gtk_title_label_get_fallback_to_uri","summary":"Get whether a [property@Clapper.MediaItem:uri] property is going be displayed as a label text when no other title could be determined.","deprecated":null},{"type":"method","name":"get_fullscreenable","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_fullscreenable","summary":"Get whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls is set to be visible.","deprecated":null},{"type":"method","name":"get_height_target","type_name":"Container","ident":"clapper_gtk_container_get_height_target","summary":"Get a @container height target.","deprecated":null},{"type":"method","name":"get_inhibited","type_name":"Av","ident":"clapper_gtk_av_get_inhibited","summary":"Get whether session is currently inhibited by [property@ClapperGtk.Av:auto-inhibit].","deprecated":null},{"type":"method","name":"get_inhibited","type_name":"Video","ident":"clapper_gtk_video_get_inhibited","summary":"Get whether session is currently inhibited by [property@ClapperGtk.Av:auto-inhibit].","deprecated":"0.10"},{"type":"method","name":"get_leading","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_get_leading","summary":"Get a whenever @lead_container has leadership set.","deprecated":null},{"type":"method","name":"get_media_item","type_name":"TitleLabel","ident":"clapper_gtk_title_label_get_media_item","summary":"Get currently set media item to display title of.","deprecated":null},{"type":"method","name":"get_player","type_name":"Av","ident":"clapper_gtk_av_get_player","summary":"Get #ClapperPlayer used by this #ClapperGtkAv instance.","deprecated":null},{"type":"method","name":"get_player","type_name":"Video","ident":"clapper_gtk_video_get_player","summary":"Get #ClapperPlayer used by this #ClapperGtkVideo instance.","deprecated":"0.10"},{"type":"method","name":"get_reveal_labels","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_get_reveal_labels","summary":"Get whether the position and duration labels are going to be revealed.","deprecated":null},{"type":"method","name":"get_seek_method","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_get_seek_method","summary":"Get [enum@Clapper.PlayerSeekMethod] used when seeking with seek bar.","deprecated":null},{"type":"method","name":"get_seek_method","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_seek_method","summary":"Get [enum@Clapper.PlayerSeekMethod] used when seeking with progress bar.","deprecated":null},{"type":"method","name":"get_speed_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_get_speed_visible","summary":"Get whether speed control inside popover is visible.","deprecated":null},{"type":"method","name":"get_touch_fade_delay","type_name":"Video","ident":"clapper_gtk_video_get_touch_fade_delay","summary":"Get time in milliseconds after which fading overlays should fade when revealed using touch device.","deprecated":null},{"type":"method","name":"get_volume_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_get_volume_visible","summary":"Get whether volume control inside popover is visible.","deprecated":null},{"type":"method","name":"get_width_target","type_name":"Container","ident":"clapper_gtk_container_get_width_target","summary":"Get a @container width target.","deprecated":null},{"type":"method","name":"pin_message","type_name":"Billboard","ident":"clapper_gtk_billboard_pin_message","summary":"Pins a permanent message on the @billboard. The message will stay on the @billboard until a [method@ClapperGtk.Billboard.unpin_pinned_message] is called.","deprecated":null},{"type":"method","name":"post_message","type_name":"Billboard","ident":"clapper_gtk_billboard_post_message","summary":"Posts a temporary message on the @billboard. Duration how long a message will stay is automatically calculated based ...","deprecated":null},{"type":"method","name":"set_adaptive_height","type_name":"Container","ident":"clapper_gtk_container_set_adaptive_height","summary":"Set an adaptive height threshold. When widget is resized to value or lower, an [signal@ClapperGtk.Container::adapt] signal will be emitted ...","deprecated":null},{"type":"method","name":"set_adaptive_width","type_name":"Container","ident":"clapper_gtk_container_set_adaptive_width","summary":"Set an adaptive width threshold. When widget is resized to value or lower, an [signal@ClapperGtk.Container::adapt] signal will be emitted ...","deprecated":null},{"type":"method","name":"set_auto_inhibit","type_name":"Av","ident":"clapper_gtk_av_set_auto_inhibit","summary":"Set whether widget should try to automatically inhibit session from idling (and possibly screen going black) when media is playing.","deprecated":null},{"type":"method","name":"set_auto_inhibit","type_name":"Video","ident":"clapper_gtk_video_set_auto_inhibit","summary":"Set whether video should try to automatically inhibit session from idling (and possibly screen going black) when video is playing.","deprecated":"0.10"},{"type":"method","name":"set_blocked_actions","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_set_blocked_actions","summary":"Set @actions that #ClapperGtkVideo should skip when #GdkEvent which would normally trigger them happens inside @lead_container.","deprecated":null},{"type":"method","name":"set_can_open_subtitles","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_set_can_open_subtitles","summary":"Set whether an option to open external subtitle stream should be allowed. Note that this [class@Gtk.Widget] can only ...","deprecated":null},{"type":"method","name":"set_child","type_name":"Audio","ident":"clapper_gtk_audio_set_child","summary":"Set a child #GtkWidget of @audio.","deprecated":null},{"type":"method","name":"set_child","type_name":"Container","ident":"clapper_gtk_container_set_child","summary":"Set a child #GtkWidget of @container.","deprecated":null},{"type":"method","name":"set_fade_delay","type_name":"Video","ident":"clapper_gtk_video_set_fade_delay","summary":"Set time in milliseconds after which fading overlays should fade.","deprecated":null},{"type":"method","name":"set_fallback_to_uri","type_name":"TitleHeader","ident":"clapper_gtk_title_header_set_fallback_to_uri","summary":"Set whether a [property@Clapper.MediaItem:uri] property should be displayed as a header text when no other title could be determined.","deprecated":null},{"type":"method","name":"set_fallback_to_uri","type_name":"TitleLabel","ident":"clapper_gtk_title_label_set_fallback_to_uri","summary":"Set whether a [property@Clapper.MediaItem:uri] property should be displayed as a label text when no other title could be determined.","deprecated":null},{"type":"method","name":"set_fullscreenable","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_set_fullscreenable","summary":"Set whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls should be visible. You might want to consider setting this to ...","deprecated":null},{"type":"method","name":"set_height_target","type_name":"Container","ident":"clapper_gtk_container_set_height_target","summary":"Same as clapper_gtk_container_set_width_target() but for widget height.","deprecated":null},{"type":"method","name":"set_leading","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_set_leading","summary":"Set if @lead_container leadership should be enabled. When enabled, interactions with @lead_container will not trigger their default behavior, ...","deprecated":null},{"type":"method","name":"set_media_item","type_name":"TitleLabel","ident":"clapper_gtk_title_label_set_media_item","summary":"Set a media item to display title of as label. When set to %NULL, @label will use default behavior ...","deprecated":null},{"type":"method","name":"set_reveal_labels","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_set_reveal_labels","summary":"Set whether the position and duration labels should be revealed.","deprecated":null},{"type":"method","name":"set_seek_method","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_set_seek_method","summary":"Set [enum@Clapper.PlayerSeekMethod] to use when seeking with seek bar.","deprecated":null},{"type":"method","name":"set_seek_method","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_set_seek_method","summary":"Set [enum@Clapper.PlayerSeekMethod] to use when seeking with progress bar.","deprecated":null},{"type":"method","name":"set_speed_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_set_speed_visible","summary":"Set whether speed control inside popover should be visible.","deprecated":null},{"type":"method","name":"set_touch_fade_delay","type_name":"Video","ident":"clapper_gtk_video_set_touch_fade_delay","summary":"Set time in milliseconds after which fading overlays should fade when using touchscreen. It is often useful to ...","deprecated":null},{"type":"method","name":"set_volume_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_set_volume_visible","summary":"Set whether volume control inside popover should be visible.","deprecated":null},{"type":"method","name":"set_width_target","type_name":"Container","ident":"clapper_gtk_container_set_width_target","summary":"Set a width that @container should target. When set container will not stretch beyond set @width while still expanding ...","deprecated":null},{"type":"method","name":"unpin_pinned_message","type_name":"Billboard","ident":"clapper_gtk_billboard_unpin_pinned_message","summary":"Unpins previously pinned message on the @billboard. If no message was pinned this function will do nothing, so ...","deprecated":null},{"type":"property","name":"adaptive-height","type_name":"Container","summary":"Adaptive height threshold that triggers [signal@ClapperGtk.Container::adapt] signal.","deprecated":null},{"type":"property","name":"adaptive-width","type_name":"Container","summary":"Adaptive width threshold that triggers [signal@ClapperGtk.Container::adapt] signal.","deprecated":null},{"type":"property","name":"auto-inhibit","type_name":"Av","summary":"Try to automatically inhibit session when media is playing.","deprecated":null},{"type":"property","name":"blocked-actions","type_name":"LeadContainer","summary":"Mask of actions that container blocks from being triggered on video.","deprecated":null},{"type":"property","name":"can-open-subtitles","type_name":"ExtraMenuButton","summary":"Visibility of open subtitles option inside popover.","deprecated":null},{"type":"property","name":"child","type_name":"Audio","summary":"The child widget of `ClapperGtkAudio`.","deprecated":null},{"type":"property","name":"current-title","type_name":"TitleHeader","summary":"Currently displayed title.","deprecated":null},{"type":"property","name":"current-title","type_name":"TitleLabel","summary":"Currently displayed title.","deprecated":null},{"type":"property","name":"extra-menu-button","type_name":"SimpleControls","summary":"Access to extra menu button within controls.","deprecated":null},{"type":"property","name":"fade-delay","type_name":"Video","summary":"A delay in milliseconds before trying to fade all fading overlays.","deprecated":null},{"type":"property","name":"fallback-to-uri","type_name":"TitleHeader","summary":"When title cannot be determined, show URI instead.","deprecated":null},{"type":"property","name":"fallback-to-uri","type_name":"TitleLabel","summary":"When title cannot be determined, show URI instead.","deprecated":null},{"type":"property","name":"fullscreenable","type_name":"SimpleControls","summary":"Whether toggle fullscreen button should be visible.","deprecated":null},{"type":"property","name":"height-target","type_name":"Container","summary":"Height that container should target.","deprecated":null},{"type":"property","name":"inhibited","type_name":"Av","summary":"Get whether session is currently inhibited by playback.","deprecated":null},{"type":"property","name":"leading","type_name":"LeadContainer","summary":"Width that container should target.","deprecated":null},{"type":"property","name":"media-item","type_name":"TitleLabel","summary":"Currently set media item to display title of.","deprecated":null},{"type":"property","name":"player","type_name":"Av","summary":"A #ClapperPlayer used by widget.","deprecated":null},{"type":"property","name":"reveal-labels","type_name":"SeekBar","summary":"Reveal state of the position and duration labels.","deprecated":null},{"type":"property","name":"seek-method","type_name":"SeekBar","summary":"Method used for seeking.","deprecated":null},{"type":"property","name":"seek-method","type_name":"SimpleControls","summary":"Method used for seeking.","deprecated":null},{"type":"property","name":"speed-visible","type_name":"ExtraMenuButton","summary":"Visibility of speed control inside popover.","deprecated":null},{"type":"property","name":"touch-fade-delay","type_name":"Video","summary":"A delay in milliseconds before trying to fade all fading overlays after revealed using touchscreen.","deprecated":null},{"type":"property","name":"volume-visible","type_name":"ExtraMenuButton","summary":"Visibility of volume control inside popover.","deprecated":null},{"type":"property","name":"width-target","type_name":"Container","summary":"Width that container should target.","deprecated":null},{"type":"signal","name":"adapt","type_name":"Container","summary":"A helper signal for implementing mobile/narrow adaptive behavior on descendants.","deprecated":null},{"type":"signal","name":"open-subtitles","type_name":"ExtraMenuButton","summary":"A signal that user wants to open subtitles file. Implementation should add a way for user to select ...","deprecated":null},{"type":"signal","name":"seek-request","type_name":"Video","summary":"A helper signal for implementing common seeking by double tap on screen side for touchscreen devices. Note that ...","deprecated":null},{"type":"signal","name":"toggle-fullscreen","type_name":"Video","summary":"A signal that user requested a change in fullscreen state of the video. Note that when going fullscreen ...","deprecated":null}],"terms":{}} \ No newline at end of file +{"meta":{"ns":"ClapperGtk","version":"0.0","generator":"gi-docgen","generator-version":"2025.4"},"symbols":[{"type":"bitfield","name":"VideoActionMask","ctype":"ClapperGtkVideoActionMask","summary":"No description available.","deprecated":null},{"type":"class","name":"Audio","ctype":"ClapperGtkAudio","summary":"A GTK widget for audio playback with Clapper API. #ClapperGtkAudio is a widget meant for integrating audio playback ...","deprecated":null},{"type":"class","name":"Av","ctype":"ClapperGtkAv","summary":"A base class for GTK audio and video widgets. See its descendants: [class@ClapperGtk.Audio] and [class@ClapperGtk.Video]. # Actions ...","deprecated":null},{"type":"class","name":"Billboard","ctype":"ClapperGtkBillboard","summary":"A layer where various messages can be displayed. #ClapperGtkBillboard widget is meant to be overlaid on top of ...","deprecated":null},{"type":"class","name":"Container","ctype":"ClapperGtkContainer","summary":"A simple container widget that holds just one child. It is designed to work well with OSD overlay, ...","deprecated":null},{"type":"class","name":"ExtraMenuButton","ctype":"ClapperGtkExtraMenuButton","summary":"A menu button with extra options.","deprecated":null},{"type":"class","name":"LeadContainer","ctype":"ClapperGtkLeadContainer","summary":"A #ClapperGtkContainer that can take priority in user interactions with the #ClapperGtkVideo. #ClapperGtkLeadContainer is a special type of ...","deprecated":null},{"type":"class","name":"NextItemButton","ctype":"ClapperGtkNextItemButton","summary":"A #GtkButton for selecting next queue item.","deprecated":null},{"type":"class","name":"PreviousItemButton","ctype":"ClapperGtkPreviousItemButton","summary":"A #GtkButton for selecting previous queue item.","deprecated":null},{"type":"class","name":"SeekBar","ctype":"ClapperGtkSeekBar","summary":"A bar for seeking and displaying playback position.","deprecated":null},{"type":"class","name":"SimpleControls","ctype":"ClapperGtkSimpleControls","summary":"A minimalistic playback controls panel widget. #ClapperGtkSimpleControls is a simple, ready to be used playback controls widget. It ...","deprecated":null},{"type":"class","name":"TitleHeader","ctype":"ClapperGtkTitleHeader","summary":"A header panel widget that displays current media title. #ClapperGtkTitleHeader is a simple, ready to be used header ...","deprecated":null},{"type":"class","name":"TitleLabel","ctype":"ClapperGtkTitleLabel","summary":"A label showing an up to date title of media item. By default #ClapperGtkTitleLabel will automatically show title ...","deprecated":null},{"type":"class","name":"ToggleFullscreenButton","ctype":"ClapperGtkToggleFullscreenButton","summary":"A #GtkButton for toggling fullscreen state.","deprecated":null},{"type":"class","name":"TogglePlayButton","ctype":"ClapperGtkTogglePlayButton","summary":"A #GtkButton for toggling play/pause of playback.","deprecated":null},{"type":"class","name":"Video","ctype":"ClapperGtkVideo","summary":"A ready to be used GTK video widget implementing Clapper API. #ClapperGtkVideo is the main widget exposed by ...","deprecated":null},{"type":"constant","name":"MAJOR_VERSION","ident":"CLAPPER_GTK_MAJOR_VERSION","summary":"ClapperGtk major version component","deprecated":null},{"type":"constant","name":"MICRO_VERSION","ident":"CLAPPER_GTK_MICRO_VERSION","summary":"ClapperGtk micro version component","deprecated":null},{"type":"constant","name":"MINOR_VERSION","ident":"CLAPPER_GTK_MINOR_VERSION","summary":"ClapperGtk minor version component","deprecated":null},{"type":"constant","name":"VERSION_S","ident":"CLAPPER_GTK_VERSION_S","summary":"ClapperGtk version, encoded as a string","deprecated":null},{"type":"content","name":"Migrating to ClapperGtk 0.10","href":"migrating-to-010.html","summary":" ### AV widget Code of [class@ClapperGtk.Video] was split into a base class [class@ClapperGtk.Av] from which [class@ClapperGtk.Video] and ..."},{"type":"ctor","name":"new","type_name":"Audio","ident":"clapper_gtk_audio_new","summary":"Creates a new #ClapperGtkAudio instance. Newly created audio widget will also have set \"scaletempo\" GStreamer element as default ...","deprecated":null},{"type":"ctor","name":"new","type_name":"Billboard","ident":"clapper_gtk_billboard_new","summary":"Creates a new #ClapperGtkBillboard instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"Container","ident":"clapper_gtk_container_new","summary":"Creates a new #ClapperGtkContainer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_new","summary":"Creates a new #ClapperGtkExtraMenuButton instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_new","summary":"Creates a new #ClapperGtkLeadContainer instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"NextItemButton","ident":"clapper_gtk_next_item_button_new","summary":"Creates a new #ClapperGtkNextItemButton to play next #ClapperMediaItem.","deprecated":null},{"type":"ctor","name":"new","type_name":"PreviousItemButton","ident":"clapper_gtk_previous_item_button_new","summary":"Creates a new #ClapperGtkPreviousItemButton to play previous #ClapperMediaItem.","deprecated":null},{"type":"ctor","name":"new","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_new","summary":"Creates a new #ClapperGtkSeekBar instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_new","summary":"Creates a new #ClapperGtkSimpleControls instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"TitleHeader","ident":"clapper_gtk_title_header_new","summary":"Creates a new #ClapperGtkTitleHeader instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"TitleLabel","ident":"clapper_gtk_title_label_new","summary":"Creates a new #ClapperGtkTitleLabel instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"ToggleFullscreenButton","ident":"clapper_gtk_toggle_fullscreen_button_new","summary":"Creates a new #ClapperGtkToggleFullscreenButton instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"TogglePlayButton","ident":"clapper_gtk_toggle_play_button_new","summary":"Creates a new #ClapperGtkTogglePlayButton instance.","deprecated":null},{"type":"ctor","name":"new","type_name":"Video","ident":"clapper_gtk_video_new","summary":"Creates a new #ClapperGtkVideo instance. Newly created video widget will also have set some default GStreamer elements on ...","deprecated":null},{"type":"function","name":"get_major_version","ident":"clapper_gtk_get_major_version","summary":"ClapperGtk runtime major version component This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.MAJOR_VERSION] ...","deprecated":null},{"type":"function","name":"get_micro_version","ident":"clapper_gtk_get_micro_version","summary":"ClapperGtk runtime micro version component This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.MICRO_VERSION] ...","deprecated":null},{"type":"function","name":"get_minor_version","ident":"clapper_gtk_get_minor_version","summary":"ClapperGtk runtime minor version component This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.MINOR_VERSION] ...","deprecated":null},{"type":"function","name":"get_player_from_ancestor","ident":"clapper_gtk_get_player_from_ancestor","summary":"Get [class@Clapper.Player] used by [class@ClapperGtk.Av] ancestor of @widget. This utility is a convenience wrapper for calling [method@Gtk.Widget.get_ancestor] of ...","deprecated":null},{"type":"function","name":"get_resource","ident":"clapper_gtk_get_resource","summary":"No description available.","deprecated":null},{"type":"function","name":"get_version_s","ident":"clapper_gtk_get_version_s","summary":"ClapperGtk runtime version as string This returns the ClapperGtk library version your code is running against unlike [const@ClapperGtk.VERSION_S] ...","deprecated":null},{"type":"function_macro","name":"AUDIO_CAST","ident":"CLAPPER_GTK_AUDIO_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"AV_CAST","ident":"CLAPPER_GTK_AV_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"BILLBOARD_CAST","ident":"CLAPPER_GTK_BILLBOARD_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"CHECK_VERSION","ident":"CLAPPER_GTK_CHECK_VERSION","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"CONTAINER_CAST","ident":"CLAPPER_GTK_CONTAINER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"DEPRECATED_FOR","ident":"CLAPPER_GTK_DEPRECATED_FOR","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"ENCODE_VERSION","ident":"CLAPPER_GTK_ENCODE_VERSION","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"EXTRA_MENU_BUTTON_CAST","ident":"CLAPPER_GTK_EXTRA_MENU_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"LEAD_CONTAINER_CAST","ident":"CLAPPER_GTK_LEAD_CONTAINER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"NEXT_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_NEXT_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"PREVIOUS_ITEM_BUTTON_CAST","ident":"CLAPPER_GTK_PREVIOUS_ITEM_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"SEEK_BAR_CAST","ident":"CLAPPER_GTK_SEEK_BAR_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"SIMPLE_CONTROLS_CAST","ident":"CLAPPER_GTK_SIMPLE_CONTROLS_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TITLE_HEADER_CAST","ident":"CLAPPER_GTK_TITLE_HEADER_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TITLE_LABEL_CAST","ident":"CLAPPER_GTK_TITLE_LABEL_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TOGGLE_FULLSCREEN_BUTTON_CAST","ident":"CLAPPER_GTK_TOGGLE_FULLSCREEN_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"TOGGLE_PLAY_BUTTON_CAST","ident":"CLAPPER_GTK_TOGGLE_PLAY_BUTTON_CAST","summary":"No description available.","deprecated":null},{"type":"function_macro","name":"VIDEO_CAST","ident":"CLAPPER_GTK_VIDEO_CAST","summary":"No description available.","deprecated":null},{"type":"method","name":"add_fading_overlay","type_name":"Video","ident":"clapper_gtk_video_add_fading_overlay","summary":"Similiar as clapper_gtk_video_add_overlay() but will also automatically add fading functionality to overlaid #GtkWidget for convenience. This will make widget ...","deprecated":null},{"type":"method","name":"add_overlay","type_name":"Video","ident":"clapper_gtk_video_add_overlay","summary":"Add another #GtkWidget to be overlaid on top of video. The position at which @widget is placed is ...","deprecated":null},{"type":"method","name":"announce_speed","type_name":"Billboard","ident":"clapper_gtk_billboard_announce_speed","summary":"Temporarily displays current speed value on the side of @billboard. Use this if you want to present current ...","deprecated":null},{"type":"method","name":"announce_volume","type_name":"Billboard","ident":"clapper_gtk_billboard_announce_volume","summary":"Temporarily displays current volume level on the side of @billboard. Use this if you want to present current ...","deprecated":null},{"type":"method","name":"get_adaptive_height","type_name":"Container","ident":"clapper_gtk_container_get_adaptive_height","summary":"Get a @container adaptive height threshold.","deprecated":null},{"type":"method","name":"get_adaptive_width","type_name":"Container","ident":"clapper_gtk_container_get_adaptive_width","summary":"Get a @container adaptive width threshold.","deprecated":null},{"type":"method","name":"get_auto_inhibit","type_name":"Av","ident":"clapper_gtk_av_get_auto_inhibit","summary":"Get whether automatic session inhibit is enabled.","deprecated":null},{"type":"method","name":"get_auto_inhibit","type_name":"Video","ident":"clapper_gtk_video_get_auto_inhibit","summary":"Get whether automatic session inhibit is enabled.","deprecated":"0.10"},{"type":"method","name":"get_blocked_actions","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_get_blocked_actions","summary":"Get @actions that were set for this @lead_container to block.","deprecated":null},{"type":"method","name":"get_can_open_subtitles","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_get_can_open_subtitles","summary":"Get whether an option to open external subtitle stream inside popover is visible.","deprecated":null},{"type":"method","name":"get_child","type_name":"Audio","ident":"clapper_gtk_audio_get_child","summary":"Get a child #GtkWidget of @audio.","deprecated":null},{"type":"method","name":"get_child","type_name":"Container","ident":"clapper_gtk_container_get_child","summary":"Get a child #GtkWidget of @container.","deprecated":null},{"type":"method","name":"get_current_title","type_name":"TitleHeader","ident":"clapper_gtk_title_header_get_current_title","summary":"Get currently displayed title by @header.","deprecated":null},{"type":"method","name":"get_current_title","type_name":"TitleLabel","ident":"clapper_gtk_title_label_get_current_title","summary":"Get currently displayed title by @label.","deprecated":null},{"type":"method","name":"get_extra_menu_button","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_extra_menu_button","summary":"Get [class@ClapperGtk.ExtraMenuButton] that resides within @controls.","deprecated":null},{"type":"method","name":"get_fade_delay","type_name":"Video","ident":"clapper_gtk_video_get_fade_delay","summary":"Get time in milliseconds after which fading overlays should fade.","deprecated":null},{"type":"method","name":"get_fallback_to_uri","type_name":"TitleHeader","ident":"clapper_gtk_title_header_get_fallback_to_uri","summary":"Get whether a [property@Clapper.MediaItem:uri] property is going be displayed as a header text when no other title could be determined.","deprecated":null},{"type":"method","name":"get_fallback_to_uri","type_name":"TitleLabel","ident":"clapper_gtk_title_label_get_fallback_to_uri","summary":"Get whether a [property@Clapper.MediaItem:uri] property is going be displayed as a label text when no other title could be determined.","deprecated":null},{"type":"method","name":"get_fullscreenable","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_fullscreenable","summary":"Get whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls is set to be visible.","deprecated":null},{"type":"method","name":"get_height_target","type_name":"Container","ident":"clapper_gtk_container_get_height_target","summary":"Get a @container height target.","deprecated":null},{"type":"method","name":"get_inhibited","type_name":"Av","ident":"clapper_gtk_av_get_inhibited","summary":"Get whether session is currently inhibited by [property@ClapperGtk.Av:auto-inhibit].","deprecated":null},{"type":"method","name":"get_inhibited","type_name":"Video","ident":"clapper_gtk_video_get_inhibited","summary":"Get whether session is currently inhibited by [property@ClapperGtk.Av:auto-inhibit].","deprecated":"0.10"},{"type":"method","name":"get_leading","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_get_leading","summary":"Get a whenever @lead_container has leadership set.","deprecated":null},{"type":"method","name":"get_media_item","type_name":"TitleLabel","ident":"clapper_gtk_title_label_get_media_item","summary":"Get currently set media item to display title of.","deprecated":null},{"type":"method","name":"get_player","type_name":"Av","ident":"clapper_gtk_av_get_player","summary":"Get #ClapperPlayer used by this #ClapperGtkAv instance.","deprecated":null},{"type":"method","name":"get_player","type_name":"Video","ident":"clapper_gtk_video_get_player","summary":"Get #ClapperPlayer used by this #ClapperGtkVideo instance.","deprecated":"0.10"},{"type":"method","name":"get_reveal_labels","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_get_reveal_labels","summary":"Get whether the position and duration labels are going to be revealed.","deprecated":null},{"type":"method","name":"get_seek_method","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_get_seek_method","summary":"Get [enum@Clapper.PlayerSeekMethod] used when seeking with seek bar.","deprecated":null},{"type":"method","name":"get_seek_method","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_get_seek_method","summary":"Get [enum@Clapper.PlayerSeekMethod] used when seeking with progress bar.","deprecated":null},{"type":"method","name":"get_speed_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_get_speed_visible","summary":"Get whether speed control inside popover is visible.","deprecated":null},{"type":"method","name":"get_touch_fade_delay","type_name":"Video","ident":"clapper_gtk_video_get_touch_fade_delay","summary":"Get time in milliseconds after which fading overlays should fade when revealed using touch device.","deprecated":null},{"type":"method","name":"get_volume_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_get_volume_visible","summary":"Get whether volume control inside popover is visible.","deprecated":null},{"type":"method","name":"get_width_target","type_name":"Container","ident":"clapper_gtk_container_get_width_target","summary":"Get a @container width target.","deprecated":null},{"type":"method","name":"pin_message","type_name":"Billboard","ident":"clapper_gtk_billboard_pin_message","summary":"Pins a permanent message on the @billboard. The message will stay on the @billboard until a [method@ClapperGtk.Billboard.unpin_pinned_message] is called.","deprecated":null},{"type":"method","name":"post_message","type_name":"Billboard","ident":"clapper_gtk_billboard_post_message","summary":"Posts a temporary message on the @billboard. Duration how long a message will stay is automatically calculated based ...","deprecated":null},{"type":"method","name":"set_adaptive_height","type_name":"Container","ident":"clapper_gtk_container_set_adaptive_height","summary":"Set an adaptive height threshold. When widget is resized to value or lower, an [signal@ClapperGtk.Container::adapt] signal will be emitted ...","deprecated":null},{"type":"method","name":"set_adaptive_width","type_name":"Container","ident":"clapper_gtk_container_set_adaptive_width","summary":"Set an adaptive width threshold. When widget is resized to value or lower, an [signal@ClapperGtk.Container::adapt] signal will be emitted ...","deprecated":null},{"type":"method","name":"set_auto_inhibit","type_name":"Av","ident":"clapper_gtk_av_set_auto_inhibit","summary":"Set whether widget should try to automatically inhibit session from idling (and possibly screen going black) when media is playing.","deprecated":null},{"type":"method","name":"set_auto_inhibit","type_name":"Video","ident":"clapper_gtk_video_set_auto_inhibit","summary":"Set whether video should try to automatically inhibit session from idling (and possibly screen going black) when video is playing.","deprecated":"0.10"},{"type":"method","name":"set_blocked_actions","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_set_blocked_actions","summary":"Set @actions that #ClapperGtkVideo should skip when #GdkEvent which would normally trigger them happens inside @lead_container.","deprecated":null},{"type":"method","name":"set_can_open_subtitles","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_set_can_open_subtitles","summary":"Set whether an option to open external subtitle stream should be allowed. Note that this [class@Gtk.Widget] can only ...","deprecated":null},{"type":"method","name":"set_child","type_name":"Audio","ident":"clapper_gtk_audio_set_child","summary":"Set a child #GtkWidget of @audio.","deprecated":null},{"type":"method","name":"set_child","type_name":"Container","ident":"clapper_gtk_container_set_child","summary":"Set a child #GtkWidget of @container.","deprecated":null},{"type":"method","name":"set_fade_delay","type_name":"Video","ident":"clapper_gtk_video_set_fade_delay","summary":"Set time in milliseconds after which fading overlays should fade.","deprecated":null},{"type":"method","name":"set_fallback_to_uri","type_name":"TitleHeader","ident":"clapper_gtk_title_header_set_fallback_to_uri","summary":"Set whether a [property@Clapper.MediaItem:uri] property should be displayed as a header text when no other title could be determined.","deprecated":null},{"type":"method","name":"set_fallback_to_uri","type_name":"TitleLabel","ident":"clapper_gtk_title_label_set_fallback_to_uri","summary":"Set whether a [property@Clapper.MediaItem:uri] property should be displayed as a label text when no other title could be determined.","deprecated":null},{"type":"method","name":"set_fullscreenable","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_set_fullscreenable","summary":"Set whether [class@ClapperGtk.ToggleFullscreenButton] button in the @controls should be visible. You might want to consider setting this to ...","deprecated":null},{"type":"method","name":"set_height_target","type_name":"Container","ident":"clapper_gtk_container_set_height_target","summary":"Same as clapper_gtk_container_set_width_target() but for widget height.","deprecated":null},{"type":"method","name":"set_leading","type_name":"LeadContainer","ident":"clapper_gtk_lead_container_set_leading","summary":"Set if @lead_container leadership should be enabled. When enabled, interactions with @lead_container will not trigger their default behavior, ...","deprecated":null},{"type":"method","name":"set_media_item","type_name":"TitleLabel","ident":"clapper_gtk_title_label_set_media_item","summary":"Set a media item to display title of as label. When set to %NULL, @label will use default behavior ...","deprecated":null},{"type":"method","name":"set_reveal_labels","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_set_reveal_labels","summary":"Set whether the position and duration labels should be revealed.","deprecated":null},{"type":"method","name":"set_seek_method","type_name":"SeekBar","ident":"clapper_gtk_seek_bar_set_seek_method","summary":"Set [enum@Clapper.PlayerSeekMethod] to use when seeking with seek bar.","deprecated":null},{"type":"method","name":"set_seek_method","type_name":"SimpleControls","ident":"clapper_gtk_simple_controls_set_seek_method","summary":"Set [enum@Clapper.PlayerSeekMethod] to use when seeking with progress bar.","deprecated":null},{"type":"method","name":"set_speed_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_set_speed_visible","summary":"Set whether speed control inside popover should be visible.","deprecated":null},{"type":"method","name":"set_touch_fade_delay","type_name":"Video","ident":"clapper_gtk_video_set_touch_fade_delay","summary":"Set time in milliseconds after which fading overlays should fade when using touchscreen. It is often useful to ...","deprecated":null},{"type":"method","name":"set_volume_visible","type_name":"ExtraMenuButton","ident":"clapper_gtk_extra_menu_button_set_volume_visible","summary":"Set whether volume control inside popover should be visible.","deprecated":null},{"type":"method","name":"set_width_target","type_name":"Container","ident":"clapper_gtk_container_set_width_target","summary":"Set a width that @container should target. When set container will not stretch beyond set @width while still expanding ...","deprecated":null},{"type":"method","name":"unpin_pinned_message","type_name":"Billboard","ident":"clapper_gtk_billboard_unpin_pinned_message","summary":"Unpins previously pinned message on the @billboard. If no message was pinned this function will do nothing, so ...","deprecated":null},{"type":"property","name":"adaptive-height","type_name":"Container","summary":"Adaptive height threshold that triggers [signal@ClapperGtk.Container::adapt] signal.","deprecated":null},{"type":"property","name":"adaptive-width","type_name":"Container","summary":"Adaptive width threshold that triggers [signal@ClapperGtk.Container::adapt] signal.","deprecated":null},{"type":"property","name":"auto-inhibit","type_name":"Av","summary":"Try to automatically inhibit session when media is playing.","deprecated":null},{"type":"property","name":"blocked-actions","type_name":"LeadContainer","summary":"Mask of actions that container blocks from being triggered on video.","deprecated":null},{"type":"property","name":"can-open-subtitles","type_name":"ExtraMenuButton","summary":"Visibility of open subtitles option inside popover.","deprecated":null},{"type":"property","name":"child","type_name":"Audio","summary":"The child widget of `ClapperGtkAudio`.","deprecated":null},{"type":"property","name":"current-title","type_name":"TitleHeader","summary":"Currently displayed title.","deprecated":null},{"type":"property","name":"current-title","type_name":"TitleLabel","summary":"Currently displayed title.","deprecated":null},{"type":"property","name":"extra-menu-button","type_name":"SimpleControls","summary":"Access to extra menu button within controls.","deprecated":null},{"type":"property","name":"fade-delay","type_name":"Video","summary":"A delay in milliseconds before trying to fade all fading overlays.","deprecated":null},{"type":"property","name":"fallback-to-uri","type_name":"TitleHeader","summary":"When title cannot be determined, show URI instead.","deprecated":null},{"type":"property","name":"fallback-to-uri","type_name":"TitleLabel","summary":"When title cannot be determined, show URI instead.","deprecated":null},{"type":"property","name":"fullscreenable","type_name":"SimpleControls","summary":"Whether toggle fullscreen button should be visible.","deprecated":null},{"type":"property","name":"height-target","type_name":"Container","summary":"Height that container should target.","deprecated":null},{"type":"property","name":"inhibited","type_name":"Av","summary":"Get whether session is currently inhibited by playback.","deprecated":null},{"type":"property","name":"leading","type_name":"LeadContainer","summary":"Width that container should target.","deprecated":null},{"type":"property","name":"media-item","type_name":"TitleLabel","summary":"Currently set media item to display title of.","deprecated":null},{"type":"property","name":"player","type_name":"Av","summary":"A #ClapperPlayer used by widget.","deprecated":null},{"type":"property","name":"reveal-labels","type_name":"SeekBar","summary":"Reveal state of the position and duration labels.","deprecated":null},{"type":"property","name":"seek-method","type_name":"SeekBar","summary":"Method used for seeking.","deprecated":null},{"type":"property","name":"seek-method","type_name":"SimpleControls","summary":"Method used for seeking.","deprecated":null},{"type":"property","name":"speed-visible","type_name":"ExtraMenuButton","summary":"Visibility of speed control inside popover.","deprecated":null},{"type":"property","name":"touch-fade-delay","type_name":"Video","summary":"A delay in milliseconds before trying to fade all fading overlays after revealed using touchscreen.","deprecated":null},{"type":"property","name":"volume-visible","type_name":"ExtraMenuButton","summary":"Visibility of volume control inside popover.","deprecated":null},{"type":"property","name":"width-target","type_name":"Container","summary":"Width that container should target.","deprecated":null},{"type":"signal","name":"adapt","type_name":"Container","summary":"A helper signal for implementing mobile/narrow adaptive behavior on descendants.","deprecated":null},{"type":"signal","name":"open-subtitles","type_name":"ExtraMenuButton","summary":"A signal that user wants to open subtitles file. Implementation should add a way for user to select ...","deprecated":null},{"type":"signal","name":"seek-request","type_name":"Video","summary":"A helper signal for implementing common seeking by double tap on screen side for touchscreen devices. Note that ...","deprecated":null},{"type":"signal","name":"toggle-fullscreen","type_name":"Video","summary":"A signal that user requested a change in fullscreen state of the video. Note that when going fullscreen ...","deprecated":null}],"terms":{}} \ No newline at end of file diff --git a/doc/clapper-gtk/migrating-to-010.html b/doc/clapper-gtk/migrating-to-010.html new file mode 100644 index 00000000..7ebdf265 --- /dev/null +++ b/doc/clapper-gtk/migrating-to-010.html @@ -0,0 +1,148 @@ + + + + + + ClapperGtk – 0.0: Migrating to ClapperGtk 0.10 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + +
+ +

+ Migrating to ClapperGtk 0.10 + + +

+ +
+
+

AV widget

+

Code of ClapperGtkVideo was split into a base class ClapperGtkAv from which +ClapperGtkVideo and newly added ClapperGtkAudio widgets are made.

+

This code split implies following changes:

+
    +
  • Properties auto-inhibit, inhibited and player were moved into AV base class, since these +are usually used without explicit need to specify object class they belong to, this change should +not affect most use-cases.
  • +
  • Methods to get above properties are now in AV, but also left in video widget for compatibility purposes.
  • +
  • Built-in widget actions starting with video. prefix are deprecated (also left for compatibility). +Implementations that used them are encouraged to use av. actions now. All actions from video widget were +ported to AV widget as they were, so updating your app should be as easy as changing this action prefix.
  • +
+

Other Info

+

Above describes changes to GTK integration library, for the playback library +check out other migration guide.

+
+
+
+ + + +
+ +
+ + + + +
+ +
+
+ + \ No newline at end of file diff --git a/doc/clapper/migrating-to-010.html b/doc/clapper/migrating-to-010.html index 7a2582de..26f636fd 100644 --- a/doc/clapper/migrating-to-010.html +++ b/doc/clapper/migrating-to-010.html @@ -104,8 +104,8 @@ used via ClapperEnhancerProxyOld ClapperFeature objects (including mpris, discoverer and server) are left for compatibility reasons, but all apps using them are advised to migrate to enhancer plugins which already surpassed former ones in what can be achieved with them.

-

Since these are now in the form of plugins scanned during init, one of the differences is that you now check -their availablity at runtime instead of compile time like before.

+

Since these are in the form of plugins scanned during init, one of the differences is that you now check +their availability at runtime instead of compile time like before.

Something like this:

#if CLAPPER_HAVE_MPRIS
   ClapperFeature *feature = CLAPPER_FEATURE (clapper_mpris_new (