as-screenshot.h

/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
 *
 * Copyright (C) 2012-2022 Matthias Klumpp <matthias@tenstral.net>
 * Copyright (C) 2014 Richard Hughes <richard@hughsie.com>
 *
 * Licensed under the GNU Lesser General Public License Version 2.1
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 2.1 of the license, or
 * (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined (__APPSTREAM_H) && !defined (AS_COMPILATION)
#error "Only <appstream.h> can be included directly."
#endif

#ifndef __AS_SCREENSHOT_H
#define __AS_SCREENSHOT_H

#include <glib-object.h>

#include "as-image.h"
#include "as-video.h"

G_BEGIN_DECLS

#define AS_TYPE_SCREENSHOT (as_screenshot_get_type ())
G_DECLARE_DERIVABLE_TYPE (AsScreenshot, as_screenshot, AS, SCREENSHOT, GObject)

struct _AsScreenshotClass
{
	GObjectClass		parent_class;
	/*< private >*/
	void (*_as_reserved1)	(void);
	void (*_as_reserved2)	(void);
	void (*_as_reserved3)	(void);
	void (*_as_reserved4)	(void);
	void (*_as_reserved5)	(void);
	void (*_as_reserved6)	(void);
};

/**
 * AsScreenshotKind:
 * @AS_SCREENSHOT_KIND_UNKNOWN:		Type invalid or not known
 * @AS_SCREENSHOT_KIND_DEFAULT:		The primary screenshot to show by default
 * @AS_SCREENSHOT_KIND_EXTRA:		Optional screenshot
 *
 * The screenshot type.
 **/
typedef enum {
	AS_SCREENSHOT_KIND_UNKNOWN,
	AS_SCREENSHOT_KIND_DEFAULT,
	AS_SCREENSHOT_KIND_EXTRA,
	/*< private >*/
	AS_SCREENSHOT_KIND_LAST
} AsScreenshotKind;

/**
 * AsScreenshotMediaKind:
 * @AS_SCREENSHOT_MEDIA_KIND_UNKNOWN:		Media kind is unknown
 * @AS_SCREENSHOT_MEDIA_KIND_IMAGE:		The screenshot contains images
 * @AS_SCREENSHOT_MEDIA_KIND_VIDEO:		The screenshot contains videos
 *
 * The media kind contained in this screenshot.
 **/
typedef enum {
	AS_SCREENSHOT_MEDIA_KIND_UNKNOWN,
	AS_SCREENSHOT_MEDIA_KIND_IMAGE,
	AS_SCREENSHOT_MEDIA_KIND_VIDEO,
	/*< private >*/
	AS_SCREENSHOT_MEDIA_KIND_LAST
} AsScreenshotMediaKind;

AsScreenshotKind		as_screenshot_kind_from_string (const gchar *kind);
const gchar			*as_screenshot_kind_to_string (AsScreenshotKind kind);
gboolean			as_screenshot_is_valid (AsScreenshot *screenshot);

AsScreenshot			*as_screenshot_new (void);

AsScreenshotKind		as_screenshot_get_kind (AsScreenshot *screenshot);
void		 		as_screenshot_set_kind (AsScreenshot *screenshot,
							AsScreenshotKind kind);

AsScreenshotMediaKind		as_screenshot_get_media_kind (AsScreenshot *screenshot);

const gchar			*as_screenshot_get_caption (AsScreenshot *screenshot);
void				as_screenshot_set_caption (AsScreenshot *screenshot,
								const gchar *caption,
								const gchar *locale);

GPtrArray			*as_screenshot_get_images_all (AsScreenshot *screenshot);
GPtrArray			*as_screenshot_get_images (AsScreenshot *screenshot);
AsImage				*as_screenshot_get_image (AsScreenshot *screenshot,
							  guint width,
							  guint height);
void				as_screenshot_add_image (AsScreenshot *screenshot,
							 AsImage *image);
void				as_screenshot_clear_images (AsScreenshot *screenshot);

GPtrArray			*as_screenshot_get_videos_all (AsScreenshot *screenshot);
GPtrArray			*as_screenshot_get_videos (AsScreenshot *screenshot);
void				as_screenshot_add_video (AsScreenshot *screenshot,
							 AsVideo *video);

const gchar			*as_screenshot_get_active_locale (AsScreenshot *screenshot);
void				as_screenshot_set_active_locale (AsScreenshot *screenshot,
									const gchar *locale);

G_END_DECLS

#endif /* __AS_SCREENSHOT_H */