Interface

GstVideo-1.0 ▶ GstVideo ▶ VideoOverlay ▶ Interface

Interface for implementing VideoOverlay. Contains only the virtual methods that need to be implemented.

interface Interface {
    vfunc_expose(): void;
    vfunc_handle_events(handle_events: boolean): void;
    vfunc_set_render_rectangle(
        x: number,
        y: number,
        width: number,
        height: number,
    ): void;
    vfunc_set_window_handle(handle: never): void;
}

Hierarchy (View Summary)

Index

Methods

vfunc_expose vfunc_handle_events vfunc_set_render_rectangle vfunc_set_window_handle

Methods

  • Tell an overlay that it has been exposed. This will redraw the current frame in the drawable even if the pipeline is PAUSED.

    Returns void

  • Tell an overlay that it should handle events from the window system. These events are forwarded upstream as navigation events. In some window system, events are not propagated in the window hierarchy if a client is listening for them. This method allows you to disable events handling completely from the GstVideo.VideoOverlay.

    Parameters

    • handle_events: boolean

      a gboolean indicating if events should be handled or not.

    Returns void

  • virtual method to set the render rectangle

    Parameters

    • x: number
    • y: number
    • width: number
    • height: number

    Returns void

  • This will call the video overlay's set_window_handle method. You should use this method to tell to an overlay to display video output to a specific window (e.g. an XWindow on X11). Passing 0 as the handle will tell the overlay to stop using that window and create an internal one.

    Parameters

    • handle: never

      a handle referencing the window.

    Returns void