X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=docs%2Fplugins%2Fhtml%2Fgst-plugins-base-plugins-xvimagesink.html;h=a17c8be42d64a5c3be9ee513eb12311424460556;hb=refs%2Fheads%2Fmaster;hp=ee13e99208cffda6d48ce850dfdce976533a796b;hpb=5368e843d0f50770b7959782e360243dff90eb8d;p=framework%2Fmultimedia%2Fgst-plugins-base0.10.git diff --git a/docs/plugins/html/gst-plugins-base-plugins-xvimagesink.html b/docs/plugins/html/gst-plugins-base-plugins-xvimagesink.html index ee13e99..a17c8be 100644 --- a/docs/plugins/html/gst-plugins-base-plugins-xvimagesink.html +++ b/docs/plugins/html/gst-plugins-base-plugins-xvimagesink.html @@ -3,12 +3,12 @@ xvimagesink - + - + @@ -82,154 +82,16 @@ GstXvImageSink implements "autopaint-colorkey" gboolean : Read / Write "colorkey" gint : Read / Write "draw-borders" gboolean : Read / Write - "window-height" guint64 : Read - "window-width" guint64 : Read + "window-height" guint64 : Read + "window-width" guint64 : Read

Description

-

-XvImageSink renders video frames to a drawable (XWindow) on a local display -using the XVideo extension. Rendering to a remote display is theorically -possible but i doubt that the XVideo extension is actually available when -connecting to a remote display. This element can receive a Window ID from the -application through the XOverlay interface and will then render video frames -in this drawable. If no Window ID was provided by the application, the -element will create its own internal window and render into it. -

-

-

-
-

Scaling

-

-The XVideo extension, when it's available, handles hardware accelerated -scaling of video frames. This means that the element will just accept -incoming video frames no matter their geometry and will then put them to the -drawable scaling them on the fly. Using the "force-aspect-ratio" -property it is possible to enforce scaling with a constant aspect ratio, -which means drawing black borders around the video frame. -

-
-

-

-
-
-

Events

-

-XvImageSink creates a thread to handle events coming from the drawable. There -are several kind of events that can be grouped in 2 big categories: input -events and window state related events. Input events will be translated to -navigation events and pushed upstream for other elements to react on them. -This includes events such as pointer moves, key press/release, clicks etc... -Other events are used to handle the drawable appearance even when the data -is not flowing (GST_STATE_PAUSED). That means that even when the element is -paused, it will receive expose events from the drawable and draw the latest -frame with correct borders/aspect-ratio. -

-
-

-

-
-
-

Pixel aspect ratio

-

-When changing state to GST_STATE_READY, XvImageSink will open a connection to -the display specified in the "display" property or the -default display if nothing specified. Once this connection is open it will -inspect the display configuration including the physical display geometry and -then calculate the pixel aspect ratio. When receiving video frames with a -different pixel aspect ratio, XvImageSink will use hardware scaling to -display the video frames correctly on display's pixel aspect ratio. -Sometimes the calculated pixel aspect ratio can be wrong, it is -then possible to enforce a specific pixel aspect ratio using the -"pixel-aspect-ratio" property. -

-
-

-

-
-
-

Examples

-
- - - - - - - - 
1
gst-launch -v videotestsrc ! xvimagesink
-
- A pipeline to test hardware scaling. -When the test video signal appears you can resize the window and see that -video frames are scaled through hardware (no extra CPU cost). -
- - - - - - - - 
1
gst-launch -v videotestsrc ! xvimagesink force-aspect-ratio=true
-
- Same pipeline with "force-aspect-ratio" property set to true -You can observe the borders drawn around the scaled image respecting aspect -ratio. -
- - - - - - - - 
1
gst-launch -v videotestsrc ! navigationtest ! xvimagesink
-
- A pipeline to test navigation events. -While moving the mouse pointer over the test signal you will see a black box -following the mouse pointer. If you press the mouse button somewhere on the -video and release it somewhere else a green box will appear where you pressed -the button and a red one where you released it. (The navigationtest element -is part of gst-plugins-good.) You can observe here that even if the images -are scaled through hardware the pointer coordinates are converted back to the -original video frame geometry so that the box can be drawn to the correct -position. This also handles borders correctly, limiting coordinates to the -image area -
- - - - - - - - 
1
gst-launch -v videotestsrc ! video/x-raw-yuv, pixel-aspect-ratio=(fraction)4/3 ! xvimagesink
-
- This is faking a 4/3 pixel aspect ratio caps on video frames produced by -videotestsrc, in most cases the pixel aspect ratio of the display will be -1/1. This means that XvImageSink will have to do the scaling to convert -incoming frames to a size that will match the display pixel aspect ratio -(from 320x240 to 320x180 in this case). Note that you might have to escape -some characters for your shell like '\(fraction\)'. -
- - - - - - - - 
1
gst-launch -v videotestsrc ! xvimagesink hue=100 saturation=-100 brightness=100
-
- Demonstrates how to use the colorbalance interface. -
-

-

Synopsis

-

Element Information

+

Element Information

@@ -252,7 +114,7 @@ some characters for your shell like '\(fraction\)'.
-

Element Pads

+

Element Pads

@@ -289,12 +151,7 @@ some characters for your shell like '\(fraction\)'.

struct GstXvImageSink

struct GstXvImageSink;

-The GstXvImageSink data structure.

-
-- -
@@ -348,7 +205,7 @@ The

The "synchronous" property

  "synchronous"              gboolean              : Read / Write
-

When enabled, runs the X display in synchronous mode. (used only for debugging).

+

When enabled, runs the X display in synchronous mode. (unrelated to A/V sync, used only for debugging).

Default value: FALSE

@@ -383,78 +240,55 @@ The

The "double-buffer" property

  "double-buffer"            gboolean              : Read / Write
-

-Whether to double-buffer the output. -

+

Whether to double-buffer the output.

Default value: TRUE

-

Since 0.10.14

The "handle-expose" property

  "handle-expose"            gboolean              : Read / Write
-

-When enabled, the current frame will always be drawn in response to X -Expose. -

+

When enabled, the current frame will always be drawn in response to X Expose events.

Default value: TRUE

-

Since 0.10.14

The "autopaint-colorkey" property

  "autopaint-colorkey"       gboolean              : Read / Write
-

-Whether to autofill overlay with colorkey -

+

Whether to autofill overlay with colorkey.

Default value: TRUE

-

Since 0.10.21

The "colorkey" property

  "colorkey"                 gint                  : Read / Write
-

-Color to use for the overlay mask. -

+

Color to use for the overlay mask.

Default value: 0

-

Since 0.10.21

The "draw-borders" property

  "draw-borders"             gboolean              : Read / Write
-

-Draw black borders when using GstXvImageSink:force-aspect-ratio to fill -unused parts of the video area. -

+

Draw black borders to fill unused area in force-aspect-ratio mode.

Default value: TRUE

-

Since 0.10.21

The "window-height" property

-
  "window-height"            guint64               : Read
-

-Actual height of the video window. -

+
  "window-height"            guint64               : Read
+

Height of the window.

Default value: 0

-

Since 0.10.32

The "window-width" property

-
  "window-width"             guint64               : Read
-

-Actual width of the video window. -

+
  "window-width"             guint64               : Read
+

Width of the window.

Default value: 0

-

Since 0.10.32

- Generated by GTK-Doc V1.17
+ Generated by GTK-Doc V1.18 \ No newline at end of file