Struct gstreamer_player::PlayerVideoOverlayVideoRenderer

[+] Show declaration

pub struct PlayerVideoOverlayVideoRenderer(_, _);

[−] Expand description

Implements

glib::object::ObjectExt, PlayerVideoRendererExt

Methods

impl PlayerVideoOverlayVideoRenderer[−]

pub fn expose(&self)[−]

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

pub fn get_render_rectangle(&self) -> (i32, i32, i32, i32)[−]

Return the currently configured render rectangle. See PlayerVideoOverlayVideoRenderer::set_render_rectangle for details.

x

the horizontal offset of the render area inside the window

y

the vertical offset of the render area inside the window

width

the width of the render area inside the window

height

the height of the render area inside the window

pub fn set_render_rectangle(&self, x: i32, y: i32, width: i32, height: i32)[−]

Configure a subregion as a video target within the window set by PlayerVideoOverlayVideoRenderer::set_window_handle. If this is not used or not supported the video will fill the area of the window set as the overlay to 100%. By specifying the rectangle, the video can be overlaid to a specific region of that window only. After setting the new rectangle one should call PlayerVideoOverlayVideoRenderer::expose to force a redraw. To unset the region pass -1 for the width and height parameters.

This method is needed for non fullscreen video overlay in UI toolkits that do not support subwindows.

x

the horizontal offset of the render area inside the window

y

the vertical offset of the render area inside the window

width

the width of the render area inside the window

height

the height of the render area inside the window

pub fn get_property_video_sink(&self) -> Option<Element>

pub fn set_property_video_sink<P: IsA<Element> + SetValueOptional>(
    &self,
    video_sink: Option<&P>
)

pub fn connect_property_video_sink_notify<F: Fn(&PlayerVideoOverlayVideoRenderer) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId

pub fn connect_property_window_handle_notify<F: Fn(&PlayerVideoOverlayVideoRenderer) + Send + Sync + 'static>(
    &self,
    f: F
) -> SignalHandlerId

impl PlayerVideoOverlayVideoRenderer[−]

pub unsafe fn new(window_handle: uintptr_t) -> PlayerVideoOverlayVideoRenderer[−]

window_handle

Window handle to use or None

pub unsafe fn new_with_handle_and_sink<P: IsA<Element>>(
    window_handle: uintptr_t,
    video_sink: &P
) -> PlayerVideoOverlayVideoRenderer

pub fn new_with_sink<P: IsA<Element>>(
    video_sink: &P
) -> PlayerVideoOverlayVideoRenderer[−]

window_handle

Window handle to use or None

video_sink

the custom video_sink element to be set for the video renderer

pub unsafe fn get_window_handle(&self) -> uintptr_t[−]

Returns

The currently set, platform specific window handle

pub unsafe fn set_window_handle(&self, window_handle: uintptr_t)[−]

Sets the platform specific window handle into which the video should be rendered

window_handle

handle referencing to the platform specific window

Trait Implementations

impl Clone for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn clone(&self) -> PlayerVideoOverlayVideoRenderer[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for PlayerVideoOverlayVideoRenderer

impl Hash for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn hash<__H: Hasher>(&self, state: &mut __H)[−]

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, [−]

Feeds a slice of this type into the given [Hasher].

impl IsA<PlayerVideoRenderer> for PlayerVideoOverlayVideoRenderer

impl Ord for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn cmp(&self, other: &PlayerVideoOverlayVideoRenderer) -> Ordering[−]

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use] fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: ObjectType> PartialEq<T> for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn eq(&self, other: &T) -> bool[−]

This method tests for self and other values to be equal, and is used by ==.

[+] Expand attributes

#[must_use] fn ne(&self, other: &Rhs) -> bool[−]

This method tests for !=.

impl<T: ObjectType> PartialOrd<T> for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn partial_cmp(&self, other: &T) -> Option<Ordering>[−]

This method returns an ordering between self and other values if one exists.

[+] Expand attributes

#[must_use] fn lt(&self, other: &Rhs) -> bool[−]

This method tests less than (for self and other) and is used by the < operator.

[+] Expand attributes

#[must_use] fn le(&self, other: &Rhs) -> bool[−]

This method tests less than or equal to (for self and other) and is used by the <= operator.

[+] Expand attributes

#[must_use] fn gt(&self, other: &Rhs) -> bool[−]

This method tests greater than (for self and other) and is used by the > operator.

[+] Expand attributes

#[must_use] fn ge(&self, other: &Rhs) -> bool[−]

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for PlayerVideoOverlayVideoRenderer

impl StaticType for PlayerVideoOverlayVideoRenderer[+]

[+] Show hidden undocumented items

fn static_type() -> Type[−]

Returns the type identifier of Self.

impl Sync for PlayerVideoOverlayVideoRenderer