blob: 835675809894159b5d43213d00b8a360c9f1ca3c [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GstInterpolationControlSource: GStreamer 1.0 Library Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="GStreamer 1.0 Library Reference Manual">
<link rel="up" href="gstreamer-control.html" title="GStreamer Dynamic Parameter Control">
<link rel="prev" href="GstTimedValueControlSource.html" title="GstTimedValueControlSource">
<link rel="next" href="GstLFOControlSource.html" title="GstLFOControlSource">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
<a href="#GstInterpolationControlSource.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
<a href="#GstInterpolationControlSource.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
<a href="#GstInterpolationControlSource.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="gstreamer-control.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GstTimedValueControlSource.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GstLFOControlSource.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GstInterpolationControlSource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GstInterpolationControlSource.top_of_page"></a>GstInterpolationControlSource</span></h2>
<p>GstInterpolationControlSource — interpolation control source</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GstInterpolationControlSource.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a href="../html/GstControlSource.html#GstControlSource-struct"><span class="returnvalue">GstControlSource</span></a> *
</td>
<td class="function_name">
<a class="link" href="GstInterpolationControlSource.html#gst-interpolation-control-source-new" title="gst_interpolation_control_source_new ()">gst_interpolation_control_source_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody><tr>
<td class="property_type"><a class="link" href="GstInterpolationControlSource.html#GstInterpolationMode" title="enum GstInterpolationMode"><span class="type">GstInterpolationMode</span></a></td>
<td class="property_name"><a class="link" href="GstInterpolationControlSource.html#GstInterpolationControlSource--mode" title="The “mode” property">mode</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="GstInterpolationControlSource.html#GstInterpolationControlSource-struct" title="struct GstInterpolationControlSource">GstInterpolationControlSource</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="GstInterpolationControlSource.html#GstInterpolationMode" title="enum GstInterpolationMode">GstInterpolationMode</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
<span class="lineart">╰──</span> <a href="../html/GstObject.html#GstObject-struct">GstObject</a>
<span class="lineart">╰──</span> <a href="../html/GstControlSource.html#GstControlSource-struct">GstControlSource</a>
<span class="lineart">╰──</span> <a class="link" href="GstTimedValueControlSource.html" title="GstTimedValueControlSource">GstTimedValueControlSource</a>
<span class="lineart">╰──</span> GstInterpolationControlSource
</pre>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libs/controller/gstinterpolationcontrolsource.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.description"></a><h2>Description</h2>
<p><a class="link" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource"><span class="type">GstInterpolationControlSource</span></a> is a <a href="../html/GstControlSource.html#GstControlSource-struct"><span class="type">GstControlSource</span></a>, that interpolates values between user-given
control points. It supports several interpolation modes and property types.</p>
<p>To use <a class="link" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource"><span class="type">GstInterpolationControlSource</span></a> get a new instance by calling
<a class="link" href="GstInterpolationControlSource.html#gst-interpolation-control-source-new" title="gst_interpolation_control_source_new ()"><code class="function">gst_interpolation_control_source_new()</code></a>, bind it to a <a href="/usr/share/gtk-doc/html/gobjectgobject-GParamSpec.html#GParamSpec"><span class="type">GParamSpec</span></a> and set some
control points by calling <a class="link" href="GstTimedValueControlSource.html#gst-timed-value-control-source-set" title="gst_timed_value_control_source_set ()"><code class="function">gst_timed_value_control_source_set()</code></a>.</p>
<p>All functions are MT-safe.</p>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gst-interpolation-control-source-new"></a><h3>gst_interpolation_control_source_new ()</h3>
<pre class="programlisting"><a href="../html/GstControlSource.html#GstControlSource-struct"><span class="returnvalue">GstControlSource</span></a> *
gst_interpolation_control_source_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>This returns a new, unbound <a class="link" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource"><span class="type">GstInterpolationControlSource</span></a>.</p>
<div class="refsect3">
<a name="gst-interpolation-control-source-new.returns"></a><h4>Returns</h4>
<p> a new, unbound <a class="link" href="GstInterpolationControlSource.html" title="GstInterpolationControlSource"><span class="type">GstInterpolationControlSource</span></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GstInterpolationControlSource-struct"></a><h3>struct GstInterpolationControlSource</h3>
<pre class="programlisting">struct GstInterpolationControlSource;</pre>
<p>The instance structure of <a href="../html/GstControlSource.html#GstControlSource-struct"><span class="type">GstControlSource</span></a>.</p>
</div>
<hr>
<div class="refsect2">
<a name="GstInterpolationMode"></a><h3>enum GstInterpolationMode</h3>
<p>The various interpolation modes available.</p>
<div class="refsect3">
<a name="GstInterpolationMode.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="GST-INTERPOLATION-MODE-NONE:CAPS"></a>GST_INTERPOLATION_MODE_NONE</p></td>
<td class="enum_member_description">
<p>steps-like interpolation, default</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-INTERPOLATION-MODE-LINEAR:CAPS"></a>GST_INTERPOLATION_MODE_LINEAR</p></td>
<td class="enum_member_description">
<p>linear interpolation</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-INTERPOLATION-MODE-CUBIC:CAPS"></a>GST_INTERPOLATION_MODE_CUBIC</p></td>
<td class="enum_member_description">
<p>cubic interpolation (natural), may overshoot
the min or max values set by the control point, but is more 'curvy'</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="GST-INTERPOLATION-MODE-CUBIC-MONOTONIC:CAPS"></a>GST_INTERPOLATION_MODE_CUBIC_MONOTONIC</p></td>
<td class="enum_member_description">
<p>monotonic cubic interpolation, will not
produce any values outside of the min-max range set by the control points
(Since 1.8)</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="GstInterpolationControlSource.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GstInterpolationControlSource--mode"></a><h3>The <code class="literal">“mode”</code> property</h3>
<pre class="programlisting"> “mode” <a class="link" href="GstInterpolationControlSource.html#GstInterpolationMode" title="enum GstInterpolationMode"><span class="type">GstInterpolationMode</span></a></pre>
<p>Interpolation mode.</p>
<p>Flags: Read / Write</p>
<p>Default value: GST_INTERPOLATION_MODE_NONE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>