GnlObject

GnlObject —

Synopsis




struct      GnlObject;
enum        GnlObjectRateControl;
enum        GnlCoverType;
enum        GnlDirection;
void        gnl_object_set_media_start_stop (GnlObject *object,
                                             GstClockTime start,
                                             GstClockTime stop);
void        gnl_object_get_media_start_stop (GnlObject *object,
                                             GstClockTime *start,
                                             GstClockTime *stop);
void        gnl_object_set_start_stop       (GnlObject *object,
                                             GstClockTime start,
                                             GstClockTime stop);
void        gnl_object_get_start_stop       (GnlObject *object,
                                             GstClockTime *start,
                                             GstClockTime *stop);
void        gnl_object_set_priority         (GnlObject *object,
                                             gint priority);
gint        gnl_object_get_priority         (GnlObject *object);
GnlObjectRateControl gnl_object_get_rate_control
                                            (GnlObject *object);
void        gnl_object_set_rate_control     (GnlObject *object,
                                             GnlObjectRateControl control);
gboolean    gnl_object_is_active            (GnlObject *object);
void        gnl_object_set_active           (GnlObject *object,
                                             gboolean active);
gboolean    gnl_object_covers               (GnlObject *object,
                                             GstClockTime start,
                                             GstClockTime stop,
                                             GnlCoverType type);
GstClockTime gnl_object_nearest_change      (GnlObject *object,
                                             GstClockTime time,
                                             GnlDirection direction);


Object Hierarchy


  GObject
   +----GstObject
         +----GstElement
               +----GstBin
                     +----GnlObject
                           +----GnlSource
                           +----GnlOperation
                           +----GnlComposition

Properties


  "active"               gboolean             : Read / Write
  "media-start"          guint64              : Read / Write
  "media-stop"           guint64              : Read / Write
  "priority"             gint                 : Read / Write
  "rate-control"         GnlObjectRateControlType : Read / Write
  "start"                guint64              : Read / Write
  "stop"                 guint64              : Read / Write

Description

Details

struct GnlObject

struct GnlObject;


enum GnlObjectRateControl

typedef enum {
  GNL_OBJECT_INVALID_RATE_CONTROL = 0,
  GNL_OBJECT_FIX_MEDIA_STOP = 1,
  GNL_OBJECT_USE_MEDIA_STOP = 2,
} GnlObjectRateControl;


enum GnlCoverType

typedef enum
{
  GNL_COVER_ALL,
  GNL_COVER_SOME,
  GNL_COVER_START,
  GNL_COVER_STOP,
} GnlCoverType;


enum GnlDirection

typedef enum
{
  GNL_DIRECTION_FORWARD,
  GNL_DIRECTION_BACKWARD,
} GnlDirection;


gnl_object_set_media_start_stop ()

void        gnl_object_set_media_start_stop (GnlObject *object,
                                             GstClockTime start,
                                             GstClockTime stop);

Set the specified media start and stop times on the object.

object : The object element to modify
start : The media start time to configure
stop : The media stop time to configure

gnl_object_get_media_start_stop ()

void        gnl_object_get_media_start_stop (GnlObject *object,
                                             GstClockTime *start,
                                             GstClockTime *stop);

Get the currently configured media start and stop times on this object. You can optionally pass a NULL pointer to stop or start when you are not interested in its value.

object : The object element to query
start : A pointer to a GstClockTime to hold the result media start time
stop : A pointer to a GstClockTime to hold the result media stop time

gnl_object_set_start_stop ()

void        gnl_object_set_start_stop       (GnlObject *object,
                                             GstClockTime start,
                                             GstClockTime stop);

Sets the specified start and stop times on the object.

object : The object element to modify
start : The start time of this object relative to the parent
stop : The stop time of this object relative to the parent

gnl_object_get_start_stop ()

void        gnl_object_get_start_stop       (GnlObject *object,
                                             GstClockTime *start,
                                             GstClockTime *stop);

Get the currently configured start and stop times on this object. You can optionally pass a NULL pointer to stop or start when you are not interested in its value.

object : The object element to query
start : A pointer to a GstClockTime to hold the result start time
stop : A pointer to a GstClockTime to hold the result stop time

gnl_object_set_priority ()

void        gnl_object_set_priority         (GnlObject *object,
                                             gint priority);

Set the priority on the given object

object : The object element to modify
priority : The new priority of the object

gnl_object_get_priority ()

gint        gnl_object_get_priority         (GnlObject *object);

Get the priority of the object

object : The object element to query
Returns : The priority of the object

gnl_object_get_rate_control ()

GnlObjectRateControl gnl_object_get_rate_control
                                            (GnlObject *object);

Get the currently configured method for handling the relation between the media times and the start/stop position.

object : The object element to query
Returns : The RateControl method used.

gnl_object_set_rate_control ()

void        gnl_object_set_rate_control     (GnlObject *object,
                                             GnlObjectRateControl control);

Set the method for handling differences in media and normal start/stop times.

object : The object element to modify
control : The method to use for rate control

gnl_object_is_active ()

gboolean    gnl_object_is_active            (GnlObject *object);

Check if the object is active.

object : The object element to query
Returns : The state of the object

gnl_object_set_active ()

void        gnl_object_set_active           (GnlObject *object,
                                             gboolean active);

Activate or dectivate the given object based on the active argument.

object : The object element to activate
active : the new state of the object

gnl_object_covers ()

gboolean    gnl_object_covers               (GnlObject *object,
                                             GstClockTime start,
                                             GstClockTime stop,
                                             GnlCoverType type);

object :
start :
stop :
type :
Returns :

gnl_object_nearest_change ()

GstClockTime gnl_object_nearest_change      (GnlObject *object,
                                             GstClockTime time,
                                             GnlDirection direction);

object :
time :
direction :
Returns :

Properties

"active" (gboolean : Read / Write)

The state of the object.

"media-start" (guint64 : Read / Write)

The media start position.

"media-stop" (guint64 : Read / Write)

The media stop position.

"priority" (gint : Read / Write)

The priority of the object.

"rate-control" (GnlObjectRateControlType : Read / Write)

Specify the rate control method.

"start" (guint64 : Read / Write)

The start position relative to the parent.

"stop" (guint64 : Read / Write)

The stop position relative to the parent.