gstreamer/ges/ges-layer.h
Henry Wilkes 142456d8ba errors: added edit errors
Added more errors to GES_ERROR for when edits fail (other than
programming or usage errors). Also promoted some GST messages if they
related to a usage error.

Also added explanation of timeline overlap rules in user docs.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-editing-services/-/merge_requests/177>
2020-05-22 19:15:57 +01:00

146 lines
4.8 KiB
C

/* GStreamer Editing Services
* Copyright (C) 2009 Edward Hervey <edward.hervey@collabora.co.uk>
* 2009 Nokia Corporation
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#pragma once
#include <glib-object.h>
#include <ges/ges-types.h>
G_BEGIN_DECLS
#define GES_TYPE_LAYER ges_layer_get_type()
GES_DECLARE_TYPE(Layer, layer, LAYER);
/**
* GESLayer:
* @timeline: the #GESTimeline where this layer is being used.
*/
struct _GESLayer {
GInitiallyUnowned parent;
/*< public >*/
GESTimeline *timeline;
/*< protected >*/
guint32 min_nle_priority, max_nle_priority;
GESLayerPrivate *priv;
/* Padding for API extension */
gpointer _ges_reserved[GES_PADDING];
};
/**
* GESLayerClass:
* @get_objects: method to get the objects contained in the layer
*
* Subclasses can override the @get_objects if they can provide a more
* efficient way of providing the list of contained #GESClip-s.
*/
struct _GESLayerClass {
/*< private >*/
GInitiallyUnownedClass parent_class;
/*< public >*/
/* virtual methods for subclasses */
GList *(*get_objects) (GESLayer * layer);
/*< private >*/
/* Signals */
void (*object_added) (GESLayer * layer, GESClip * object);
void (*object_removed) (GESLayer * layer, GESClip * object);
/* Padding for API extension */
gpointer _ges_reserved[GES_PADDING];
};
GES_API
GESLayer* ges_layer_new (void);
GES_API
void ges_layer_set_timeline (GESLayer * layer,
GESTimeline * timeline);
GES_API
GESTimeline * ges_layer_get_timeline (GESLayer * layer);
GES_API
gboolean ges_layer_add_clip (GESLayer * layer,
GESClip * clip);
GES_API
gboolean ges_layer_add_clip_full (GESLayer * layer,
GESClip * clip,
GError ** error);
GES_API
GESClip * ges_layer_add_asset (GESLayer *layer,
GESAsset *asset,
GstClockTime start,
GstClockTime inpoint,
GstClockTime duration,
GESTrackType track_types);
GES_API
GESClip * ges_layer_add_asset_full (GESLayer *layer,
GESAsset *asset,
GstClockTime start,
GstClockTime inpoint,
GstClockTime duration,
GESTrackType track_types,
GError ** error);
GES_API
gboolean ges_layer_remove_clip (GESLayer * layer,
GESClip * clip);
GES_DEPRECATED_FOR(ges_timeline_move_layer)
void ges_layer_set_priority (GESLayer * layer,
guint priority);
GES_API
gboolean ges_layer_is_empty (GESLayer * layer);
GES_API
GList* ges_layer_get_clips_in_interval (GESLayer * layer,
GstClockTime start,
GstClockTime end);
GES_API
guint ges_layer_get_priority (GESLayer * layer);
GES_API
gboolean ges_layer_get_auto_transition (GESLayer * layer);
GES_API
void ges_layer_set_auto_transition (GESLayer * layer,
gboolean auto_transition);
GES_API
GList* ges_layer_get_clips (GESLayer * layer);
GES_API
GstClockTime ges_layer_get_duration (GESLayer *layer);
GES_API
gboolean ges_layer_set_active_for_tracks (GESLayer *layer,
gboolean active,
GList *tracks);
GES_API
gboolean ges_layer_get_active_for_track (GESLayer *layer,
GESTrack *track);
G_END_DECLS