AppStream.Screenshot – appstream Reference Manual
Packages
appstream
AppStream
Screenshot
Screenshot
add_image
add_video
clear_images
get_caption
get_context
get_environment
get_image
get_images
get_images_all
get_kind
get_media_kind
get_videos
get_videos_all
is_valid
set_caption
set_context
set_environment
set_kind
Screenshot
Object Hierarchy:
Description:
[
CCode
( type_id =
"as_screenshot_get_type ()"
) ]
public
class
Screenshot
:
Object
Namespace:
AppStream
Package:
appstream
Content:
Creation methods:
public
Screenshot
()
Creates a new
Screenshot
.
Methods:
public
void
add_image
(
Image
image)
Adds an image to the screenshot.
public
void
add_video
(
Video
video)
Adds a video to the screenshot.
public
void
clear_images
()
Remove all images associated with this screenshot.
public
unowned
string
get_caption
()
Gets the image caption for a specific locale.
public
unowned
Context
?
get_context
()
Returns the
Context
associated with this screenshot.
public
unowned
string
?
get_environment
()
Get the GUI environment ID of this screenshot, if any is associated with it.
public
unowned
Image
?
get_image
(
uint
width,
uint
height,
uint
scale)
Gets the AsImage closest to the target size.
public
unowned
GenericArray
<
Image
>
get_images
()
Gets the images included in the screenshot of all sizes and locales.
public
unowned
GenericArray
<
Image
>
get_images_all
()
Returns an array of all images we have, regardless of their size and language.
public
ScreenshotKind
get_kind
()
Gets the screenshot kind.
public
ScreenshotMediaKind
get_media_kind
()
Gets the screenshot media kind.
public
unowned
GenericArray
<
Video
>
get_videos
()
Gets the videos for this screenshots.
public
unowned
GenericArray
<
Video
>
get_videos_all
()
Returns an array of all screencast videos we have, regardless of their size and locale.
public
bool
is_valid
()
Performs a quick validation on this screenshot
public
void
set_caption
(
string
caption,
string
locale)
Sets a caption on the screenshot for a specific locale.
public
void
set_context
(
Context
context)
Sets the document context this screenshot is associated with.
public
void
set_environment
(
string
? env_id)
Sets the GUI environment ID of this screenshot.
public
void
set_kind
(
ScreenshotKind
kind)
Sets the screenshot kind.
Inherited Members:
All known members inherited from class GLib.Object
@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data
get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer
replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref