GstVaapiSubpicture

GstVaapiSubpicture — VA subpicture abstraction

Synopsis

struct              GstVaapiSubpicture;
struct              GstVaapiSubpictureClass;
GstVaapiSubpicture * gst_vaapi_subpicture_new           (GstVaapiImage *image,
                                                         guint flags);
GstVaapiID          gst_vaapi_subpicture_get_id         (GstVaapiSubpicture *subpicture);
GstVaapiImage *     gst_vaapi_subpicture_get_image      (GstVaapiSubpicture *subpicture);
void                gst_vaapi_subpicture_set_image      (GstVaapiSubpicture *subpicture,
                                                         GstVaapiImage *image);

Object Hierarchy

  GObject
   +----GstVaapiObject
         +----GstVaapiSubpicture

Properties

  "flags"                    guint                 : Read / Write / Construct Only
  "global-alpha"             gfloat                : Read / Write
  "image"                    GstVaapiImage*        : Read / Write

Description

Details

struct GstVaapiSubpicture

struct GstVaapiSubpicture;

A VA subpicture wrapper


struct GstVaapiSubpictureClass

struct GstVaapiSubpictureClass {
};

A VA subpicture wrapper class


gst_vaapi_subpicture_new ()

GstVaapiSubpicture * gst_vaapi_subpicture_new           (GstVaapiImage *image,
                                                         guint flags);

Creates a new GstVaapiSubpicture with image as source pixels. The newly created object holds a reference on image.

image :

a GstVaapiImage

flags :

GstVaapiSubpictureFlags, or zero

Returns :

the newly allocated GstVaapiSubpicture object

gst_vaapi_subpicture_get_id ()

GstVaapiID          gst_vaapi_subpicture_get_id         (GstVaapiSubpicture *subpicture);

Returns the underlying VASubpictureID of the subpicture.

subpicture :

a GstVaapiSubpicture

Returns :

the underlying VA subpicture id

gst_vaapi_subpicture_get_image ()

GstVaapiImage *     gst_vaapi_subpicture_get_image      (GstVaapiSubpicture *subpicture);

Returns the GstVaapiImage this subpicture is bound to.

subpicture :

a GstVaapiSubpicture

Returns :

the GstVaapiImage this subpicture is bound to

gst_vaapi_subpicture_set_image ()

void                gst_vaapi_subpicture_set_image      (GstVaapiSubpicture *subpicture,
                                                         GstVaapiImage *image);

Binds a new GstVaapiImage to the subpicture. The reference to the previous image is released and a new one is acquired on image.

subpicture :

a GstVaapiSubpicture

image :

a GstVaapiImage

Property Details

The "flags" property

  "flags"                    guint                 : Read / Write / Construct Only

The GstVaapiSubpictureFlags this subpicture requires.

Default value: 0


The "global-alpha" property

  "global-alpha"             gfloat                : Read / Write

The global-alpha value associated with this subpicture.

Allowed values: [0,1]

Default value: 1


The "image" property

  "image"                    GstVaapiImage*        : Read / Write

The GstVaapiImage this subpicture is bound to.