File: clutter-gst-video-texture.xml

package info (click to toggle)
clutter-gst 0.8.0-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,012 kB
  • ctags: 337
  • sloc: sh: 8,845; ansic: 2,313; xml: 440; makefile: 91
file content (124 lines) | stat: -rw-r--r-- 5,564 bytes parent folder | download
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
123
124
<?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="ClutterGstVideoTexture">
<refmeta>
<refentrytitle role="top_of_page" id="ClutterGstVideoTexture.top_of_page">ClutterGstVideoTexture</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>CLUTTER-GST Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ClutterGstVideoTexture</refname>
<refpurpose>Actor for playback of video files.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="ClutterGstVideoTexture.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="ClutterGstVideoTexture-struct">ClutterGstVideoTexture</link>;
                    <link linkend="ClutterGstVideoTextureClass">ClutterGstVideoTextureClass</link>;
<link linkend="ClutterActor">ClutterActor</link>*       <link linkend="clutter-gst-video-texture-new">clutter_gst_video_texture_new</link>       (void);
<link linkend="GstElement">GstElement</link>*         <link linkend="clutter-gst-video-texture-get-playbin">clutter_gst_video_texture_get_playbin</link>
                                                        (<link linkend="ClutterGstVideoTexture">ClutterGstVideoTexture</link> *texture);
</synopsis>
</refsynopsisdiv>

<refsect1 id="ClutterGstVideoTexture.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="ClutterActor">ClutterActor</link>
               +----<link linkend="ClutterTexture">ClutterTexture</link>
                     +----ClutterGstVideoTexture
</synopsis>

</refsect1>



<refsect1 id="ClutterGstVideoTexture.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
ClutterGstVideoTexture implements
 <link linkend="ClutterScriptable">ClutterScriptable</link> and  <link linkend="ClutterMedia">ClutterMedia</link>.</para>

</refsect1>





<refsect1 id="ClutterGstVideoTexture.description" role="desc">
<title role="desc.title">Description</title>
<para>
<link linkend="ClutterGstVideoTexture"><type>ClutterGstVideoTexture</type></link> is a <link linkend="ClutterTexture"><type>ClutterTexture</type></link> that plays video files.</para>
<para>

</para>
</refsect1>

<refsect1 id="ClutterGstVideoTexture.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="ClutterGstVideoTexture-struct" role="struct">
<title>ClutterGstVideoTexture</title>
<indexterm zone="ClutterGstVideoTexture-struct"><primary>ClutterGstVideoTexture</primary></indexterm><programlisting>typedef struct _ClutterGstVideoTexture ClutterGstVideoTexture;</programlisting>
<para>
Subclass of <link linkend="ClutterTexture"><type>ClutterTexture</type></link> that displays videos using GStreamer.
</para>
<para>
The <link linkend="ClutterGstVideoTexture"><type>ClutterGstVideoTexture</type></link> structure contains only private data and
should not be accessed directly.</para>
<para>

</para></refsect2>
<refsect2 id="ClutterGstVideoTextureClass" role="struct">
<title>ClutterGstVideoTextureClass</title>
<indexterm zone="ClutterGstVideoTextureClass"><primary>ClutterGstVideoTextureClass</primary></indexterm><programlisting>typedef struct {
} ClutterGstVideoTextureClass;
</programlisting>
<para>
Base class for <link linkend="ClutterGstVideoTexture"><type>ClutterGstVideoTexture</type></link>.</para>
<para>

</para></refsect2>
<refsect2 id="clutter-gst-video-texture-new" role="function">
<title>clutter_gst_video_texture_new ()</title>
<indexterm zone="clutter-gst-video-texture-new"><primary>clutter_gst_video_texture_new</primary></indexterm><programlisting><link linkend="ClutterActor">ClutterActor</link>*       clutter_gst_video_texture_new       (void);</programlisting>
<para>
Creates a video texture.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="ClutterActor"><type>ClutterActor</type></link> implementing a displaying a video texture.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="clutter-gst-video-texture-get-playbin" role="function">
<title>clutter_gst_video_texture_get_playbin ()</title>
<indexterm zone="clutter-gst-video-texture-get-playbin"><primary>clutter_gst_video_texture_get_playbin</primary></indexterm><programlisting><link linkend="GstElement">GstElement</link>*         clutter_gst_video_texture_get_playbin
                                                        (<link linkend="ClutterGstVideoTexture">ClutterGstVideoTexture</link> *texture);</programlisting>
<para>
Retrieves the <link linkend="GstElement"><type>GstElement</type></link> used by the <parameter>texture</parameter>, for direct use with
GStreamer API.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>texture</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="ClutterGstVideoTexture"><type>ClutterGstVideoTexture</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the playbin element used by the video texture
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>