1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="ClutterGstVideoSink">
<refmeta>
<refentrytitle role="top_of_page" id="ClutterGstVideoSink.top_of_page">ClutterGstVideoSink</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER-GST Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ClutterGstVideoSink</refname>
<refpurpose>GStreamer video sink</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="ClutterGstVideoSink.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="ClutterGstVideoSink-struct">ClutterGstVideoSink</link>;
<link linkend="ClutterGstVideoSinkClass">ClutterGstVideoSinkClass</link>;
<link linkend="GstElement">GstElement</link>* <link linkend="clutter-gst-video-sink-new">clutter_gst_video_sink_new</link> (<link linkend="ClutterTexture">ClutterTexture</link> *texture);
</synopsis>
</refsynopsisdiv>
<refsect1 id="ClutterGstVideoSink.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----<link linkend="GstObject">GstObject</link>
+----<link linkend="GstElement">GstElement</link>
+----<link linkend="GstBaseSink">GstBaseSink</link>
+----ClutterGstVideoSink
</synopsis>
</refsect1>
<refsect1 id="ClutterGstVideoSink.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="ClutterGstVideoSink--texture">texture</link>" <link linkend="ClutterTexture">ClutterTexture</link>* : Read / Write
"<link linkend="ClutterGstVideoSink--use-shaders">use-shaders</link>" <link linkend="gboolean">gboolean</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 id="ClutterGstVideoSink.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="ClutterGstVideoSink"><type>ClutterGstVideoSink</type></link> is a GStreamer sink element that sends
data to a <link linkend="ClutterTexture"><type>ClutterTexture</type></link>.</para>
<para>
</para>
</refsect1>
<refsect1 id="ClutterGstVideoSink.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ClutterGstVideoSink-struct" role="struct">
<title>ClutterGstVideoSink</title>
<indexterm zone="ClutterGstVideoSink-struct"><primary>ClutterGstVideoSink</primary></indexterm><programlisting>typedef struct _ClutterGstVideoSink ClutterGstVideoSink;</programlisting>
<para>
Class implementing a GStreamer sink element for <link linkend="ClutterTexture"><type>ClutterTexture</type></link><!-- -->s.
</para>
<para>
The <link linkend="ClutterGstVideoSink"><type>ClutterGstVideoSink</type></link> structure contains only private data and should
not be accessed directly.</para>
<para>
</para></refsect2>
<refsect2 id="ClutterGstVideoSinkClass" role="struct">
<title>ClutterGstVideoSinkClass</title>
<indexterm zone="ClutterGstVideoSinkClass"><primary>ClutterGstVideoSinkClass</primary></indexterm><programlisting>typedef struct {
} ClutterGstVideoSinkClass;
</programlisting>
<para>
Base class for <link linkend="ClutterGstVideoSink"><type>ClutterGstVideoSink</type></link>.</para>
<para>
</para></refsect2>
<refsect2 id="clutter-gst-video-sink-new" role="function">
<title>clutter_gst_video_sink_new ()</title>
<indexterm zone="clutter-gst-video-sink-new"><primary>clutter_gst_video_sink_new</primary></indexterm><programlisting><link linkend="GstElement">GstElement</link>* clutter_gst_video_sink_new (<link linkend="ClutterTexture">ClutterTexture</link> *texture);</programlisting>
<para>
Creates a new GStreamer video sink which uses <parameter>texture</parameter> as the target
for sinking a video stream from GStreamer.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>texture</parameter> :</term>
<listitem><simpara> a <link linkend="ClutterTexture"><type>ClutterTexture</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a <link linkend="GstElement"><type>GstElement</type></link> for the newly created video sink
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="ClutterGstVideoSink.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="ClutterGstVideoSink--texture"><title>The <literal>"texture"</literal> property</title>
<indexterm zone="ClutterGstVideoSink--texture"><primary>ClutterGstVideoSink:texture</primary></indexterm><programlisting> "texture" <link linkend="ClutterTexture">ClutterTexture</link>* : Read / Write</programlisting>
<para>Target ClutterTexture object.</para></refsect2>
<refsect2 id="ClutterGstVideoSink--use-shaders"><title>The <literal>"use-shaders"</literal> property</title>
<indexterm zone="ClutterGstVideoSink--use-shaders"><primary>ClutterGstVideoSink:use-shaders</primary></indexterm><programlisting> "use-shaders" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Use a fragment shader to accelerate colour-space conversion.</para><para>Default value: FALSE</para>
</refsect2>
</refsect1>
</refentry>
|