GESTestClip

## GESTestClip GESTestClip — Render video and audio test patterns in a GESLayer |

## Synopsis

    #include <ges/ges.h>

                        GESTestClip;
                        GESTestClipClass;
    GESTestClip *       ges_test_clip_new                   (void);
    GESTestClip *       ges_test_clip_new_for_nick          (gchar *nick);
    GESVideoTestPattern ges_test_clip_get_vpattern          (GESTestClip *self);
    gdouble             ges_test_clip_get_frequency         (GESTestClip *self);
    gdouble             ges_test_clip_get_volume            (GESTestClip *self);
    gboolean            ges_test_clip_is_muted              (GESTestClip *self);
    void                ges_test_clip_set_vpattern          (GESTestClip *self,
                                                             GESVideoTestPattern vpattern);
    void                ges_test_clip_set_frequency         (GESTestClip *self,
                                                             gdouble freq);
    void                ges_test_clip_set_mute              (GESTestClip *self,
                                                             gboolean mute);
    void                ges_test_clip_set_volume            (GESTestClip *self,
                                                             gdouble volume);

## Object Hierarchy

      GObject
       +----GInitiallyUnowned
             +----GESTimelineElement
                   +----GESContainer
                         +----GESClip
                               +----GESSourceClip
                                     +----GESTestClip

## Implemented Interfaces

GESTestClip implements GESExtractable and GESMetaContainer.

## Properties

      "freq"                     gdouble               : Read / Write / Construct
      "mute"                     gboolean              : Read / Write / Construct
      "volume"                   gdouble               : Read / Write / Construct
      "vpattern"                 GESVideoTestPattern   : Read / Write / Construct

## Description

Useful for testing purposes.

You can use the ges_asset_request_simple API to create an Asset capable of extracting GESTestClip-s

## Details

### GESTestClip

    typedef struct _GESTestClip GESTestClip;

### GESTestClipClass

    typedef struct {
    } GESTestClipClass;

### ges_test_clip_new ()

    GESTestClip *       ges_test_clip_new                   (void);

Creates a new GESTestClip.

Returns : | The newly created GESTestClip, or NULL if there was an error.

### ges_test_clip_new_for_nick ()

    GESTestClip *       ges_test_clip_new_for_nick          (gchar *nick);

Creates a new GESTestClip for the provided `nick`.

`nick` : | the nickname for which to create the GESTestClip
Returns : | The newly created GESTestClip, or NULL if there was an error.

### ges_test_clip_get_vpattern ()

    GESVideoTestPattern ges_test_clip_get_vpattern          (GESTestClip *self);

Get the GESVideoTestPattern which is applied on `self`.

`self` : | a GESTestClip
Returns : | The GESVideoTestPattern which is applied on `self`.

### ges_test_clip_get_frequency ()

    gdouble             ges_test_clip_get_frequency         (GESTestClip *self);

Get the frequency `self` generates.

`self` : | a GESTestClip
Returns : | The frequency `self` generates. See audiotestsrc element.

### ges_test_clip_get_volume ()

    gdouble             ges_test_clip_get_volume            (GESTestClip *self);

Get the volume of the test audio signal applied on `self`.

`self` : | a GESTestClip
Returns : | The volume of the test audio signal applied on `self`.

### ges_test_clip_is_muted ()

    gboolean            ges_test_clip_is_muted              (GESTestClip *self);

Let you know if the audio track of `self` is muted or not.

`self` : | a GESTestClip
Returns : | Whether the audio track of `self` is muted or not.

### ges_test_clip_set_vpattern ()

    void                ges_test_clip_set_vpattern          (GESTestClip *self,
                                                             GESVideoTestPattern vpattern);

Sets which video pattern to display on `self`.

`self` : | the GESTestClip to set the pattern on
`vpattern` : | the GESVideoTestPattern to use on `self`

### ges_test_clip_set_frequency ()

    void                ges_test_clip_set_frequency         (GESTestClip *self,
                                                             gdouble freq);

Sets the frequency to generate. See audiotestsrc element.

`self` : | the GESTestClip to set the frequency on
`freq` : | the frequency you want to use on `self`

### ges_test_clip_set_mute ()

    void                ges_test_clip_set_mute              (GESTestClip *self,
                                                             gboolean mute);

Sets whether the audio track of this clip is muted or not.

`self` : | the GESTestClip on which to mute or unmute the audio track
`mute` : | `TRUE` to mute the audio track, `FALSE` to unmute it

### ges_test_clip_set_volume ()

    void                ges_test_clip_set_volume            (GESTestClip *self,
                                                             gdouble volume);

Sets the volume of the test audio signal.

`self` : | the GESTestClip to set the volume on
`volume` : | the volume of the audio signal you want to use on `self`

## Property Details

### The `"freq"` property

      "freq"                     gdouble               : Read / Write / Construct

The frequency to generate for audio track elements.

Allowed values: [0,20000]

Default value: 440

### The `"mute"` property

      "mute"                     gboolean              : Read / Write / Construct

Whether the sound will be played or not.

Default value: FALSE

### The `"volume"` property

      "volume"                   gdouble               : Read / Write / Construct

The volume for the audio track elements.

Allowed values: [0,1]

Default value: 1

### The `"vpattern"` property

      "vpattern"                 GESVideoTestPattern   : Read / Write / Construct

Video pattern to display in video track elements.

Default value: SMPTE 100% color bars