# fpsdisplaysink

Can display the current and average framerate as a testoverlay or on stdout.

## Example launch lines

     gst-launch-1.0 videotestsrc ! fpsdisplaysink
     gst-launch-1.0 videotestsrc ! fpsdisplaysink text-overlay=false
     gst-launch-1.0 filesrc location=video.avi ! decodebin name=d ! queue ! fpsdisplaysink d. ! queue ! fakesink sync=true
     gst-launch-1.0 playbin uri=file:///path/to/video.avi video-sink="fpsdisplaysink" audio-sink=fakesink

## Hierarchy

    GObject
        ╰──GInitiallyUnowned
            ╰──GstObject
                ╰──GstElement
                    ╰──GstBin
                        ╰──fpsdisplaysink

## Implemented interfaces

    GstChildProxy

## Factory details

Authors: – Zeeshan Ali <zeeshan.ali>, Stefan Kost <stefan.kost></stefan.kost></zeeshan.ali>

Classification: – `Sink/Video`

Rank – none

Plugin – debugutilsbad

Package – GStreamer Bad Plug-ins

## Pad Templates

### `sink`

    ANY

Presence – always

Direction – sink

Object type – GstPad

## Signals

### fps-measurements

    fps_measurements_callback (GstElement * fpsdisplaysink,
                               gdouble fps,
                               gdouble droprate,
                               gdouble avgfps,
                               gpointer udata)

    def fps_measurements_callback (fpsdisplaysink, fps, droprate, avgfps, udata):
        #python callback for the 'fps-measurements' signal

    function fps_measurements_callback(fpsdisplaysink: GstElement * fpsdisplaysink, fps: gdouble fps, droprate: gdouble droprate, avgfps: gdouble avgfps, udata: gpointer udata): {
        // javascript callback for the 'fps-measurements' signal
    }

Signals the application about the measured fps

Parameters:

`fpsdisplaysink` –

a fpsdisplaysink

`fps` –

The current measured fps

`droprate` –

The rate at which buffers are being dropped

`avgfps` –

The average fps

`udata` –
No description available

Flags: Run Last

## Properties

### fps-update-interval

    “fps-update-interval” gint

Time between consecutive frames per second measures and update (in ms). Should be set on NULL state

Flags : Read / Write

Default value : 500

### frames-dropped

    “frames-dropped” guint

Number of frames dropped by the sink

Flags : Read

Default value : 0

### frames-rendered

    “frames-rendered” guint

Number of frames rendered

Flags : Read

Default value : 0

### last-message

    “last-message” gchararray

The message describing current status

Flags : Read

Default value : NULL

### max-fps

    “max-fps” gdouble

Maximum fps rate measured. Reset when going from NULL to READY.-1 means no measurement has yet been done

Flags : Read

Default value : -1

### min-fps

    “min-fps” gdouble

Minimum fps rate measured. Reset when going from NULL to READY.-1 means no measurement has yet been done

Flags : Read

Default value : -1

### signal-fps-measurements

    “signal-fps-measurements” gboolean

If the fps-measurements signal should be emitted.

Flags : Read / Write

Default value : false

### silent

    “silent” gboolean

Don't produce last_message events

Flags : Read / Write

Default value : false

### sync

    “sync” gboolean

Sync on the clock (if the internally used sink doesn't have this property it will be ignored

Flags : Read / Write

Default value : true

### text-overlay

    “text-overlay” gboolean

Whether to use text-overlay

Flags : Read / Write

Default value : true

### video-sink

    “video-sink” GstElement *

Video sink to use (Must only be called on NULL state)

Flags : Read / Write

The results of the search are