<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>gstreamermm: Gst::AlsaSink Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.1 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespaceGst.html">Gst</a>::<a class="el" href="classGst_1_1AlsaSink.html">AlsaSink</a> </div> </div> <div class="contents"> <h1>Gst::AlsaSink Class Reference<br/> <small> [<a class="el" href="group__GstPlugins.html">gstreamermm Plugins</a>]</small> </h1><!-- doxytag: class="Gst::AlsaSink" --><!-- doxytag: inherits="Gst::AudioSink,Gst::PropertyProbe" --> <p><a class="el" href="classGst_1_1AlsaSink.html" title="Gst::AlsaSink - alsasink plugin.">Gst::AlsaSink</a> - alsasink plugin. <a href="#_details">More...</a></p> <p>Inherits <a class="el" href="classGst_1_1AudioSink.html">Gst::AudioSink</a>, and <a class="el" href="classGst_1_1PropertyProbe.html">Gst::PropertyProbe</a>.</p> <div class="dynheader"> Collaboration diagram for Gst::AlsaSink:</div> <div class="dynsection"> <div class="center"><img src="classGst_1_1AlsaSink__coll__graph.png" border="0" usemap="#Gst_1_1AlsaSink_coll__map" alt="Collaboration graph"/></div> <map name="Gst_1_1AlsaSink_coll__map" id="Gst_1_1AlsaSink_coll__map"> <area shape="rect" href="classGst_1_1AudioSink.html" title="Gst::AudioSink - Simple base class for audio sinks." alt="" coords="33,547,143,576"/><area shape="rect" href="classGst_1_1BaseAudioSink.html" title="Gst::BaseAudioSink - Base class for audio sinks." alt="" coords="9,469,148,499"/><area shape="rect" href="classGst_1_1BaseSink.html" title="Gst::BaseSink - Base class for sink elements." alt="" coords="17,392,124,421"/><area shape="rect" href="classGst_1_1Element.html" title="Gst::Element - Abstract base class for all pipeline elements." alt="" coords="5,315,104,344"/><area shape="rect" href="classGst_1_1Object.html" title="Gst::Object - Base class for the GStreamer object hierarchy." alt="" coords="13,237,101,267"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,112,189"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="67,83,187,112"/><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Interface.html" title="Glib::Interface" alt="" coords="136,160,240,189"/><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="73,5,180,35"/><area shape="rect" href="classGst_1_1PropertyProbe.html" title="Gst::PropertyProbe - Interface for probing possible property values." alt="" coords="128,315,261,344"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classGst_1_1AlsaSink-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a54a8700deccd7c0755bfba61a0ee6e87">~AlsaSink</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstAlsaSink* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a5723622a9a1aad5c3595d29cdf698bf2">gobj</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a5723622a9a1aad5c3595d29cdf698bf2"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">const GstAlsaSink* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a3ab7558e7956fd629492f795bf9af7be">gobj</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#a3ab7558e7956fd629492f795bf9af7be"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">GstAlsaSink* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#af5ebdb6aae6177de54df37bf45f3649c">gobj_copy</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#af5ebdb6aae6177de54df37bf45f3649c"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><br class="typebreak"/> < <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#ad0fb756404690840bc841fb08af26ace">property_device</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">ALSA device. <a href="#ad0fb756404690840bc841fb08af26ace"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/> < <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#aa5266609076e78cbe1535d5e8fbf81d5">property_device</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">ALSA device. <a href="#aa5266609076e78cbe1535d5e8fbf81d5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><br class="typebreak"/> < <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a49fb6db2f5cc83ca4fc4e4fa3c904ba2">property_device_name</a> () const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Human-readable name of the sound device. <a href="#a49fb6db2f5cc83ca4fc4e4fa3c904ba2"></a><br/></td></tr> <tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1AlsaSink.html">AlsaSink</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#ad3a74c2940c0b0433e1ba793336ac318">create</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new alsasink plugin with a unique name. <a href="#ad3a74c2940c0b0433e1ba793336ac318"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1AlsaSink.html">AlsaSink</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#aa0116c2212ef64a0f9d42c6262b09f31">create</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new alsasink plugin with the given name. <a href="#aa0116c2212ef64a0f9d42c6262b09f31"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a64421535f560810d249c23f233ab3d69">AlsaSink</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a63ce08ccbd4130e57d768b84c04b433d">AlsaSink</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& name)</td></tr> <tr><td colspan="2"><h2>Related Functions</h2></td></tr> <tr><td colspan="2"><p>(Note that these are not member functions.) </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1AlsaSink.html">Gst::AlsaSink</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGst_1_1AlsaSink.html#a31b6c89e9bbc55ff6e482fcefe69e5ac">wrap</a> (GstAlsaSink* object, bool take_copy=false)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a31b6c89e9bbc55ff6e482fcefe69e5ac"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p><a class="el" href="classGst_1_1AlsaSink.html" title="Gst::AlsaSink - alsasink plugin.">Gst::AlsaSink</a> - alsasink plugin. </p> <p>Please note that, though using the underlying GObject is fine, using its C <b>type</b> is not guaranteed to be API stable across releases because it is not guaranteed to always remain the same. Also, not all plug-ins are available on all systems so care must be taken that they exist before they are used, otherwise there will be errors and possibly a crash. </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a54a8700deccd7c0755bfba61a0ee6e87"></a><!-- doxytag: member="Gst::AlsaSink::~AlsaSink" ref="a54a8700deccd7c0755bfba61a0ee6e87" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual Gst::AlsaSink::~AlsaSink </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a64421535f560810d249c23f233ab3d69"></a><!-- doxytag: member="Gst::AlsaSink::AlsaSink" ref="a64421535f560810d249c23f233ab3d69" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::AlsaSink::AlsaSink </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a63ce08ccbd4130e57d768b84c04b433d"></a><!-- doxytag: member="Gst::AlsaSink::AlsaSink" ref="a63ce08ccbd4130e57d768b84c04b433d" args="(const Glib::ustring &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">Gst::AlsaSink::AlsaSink </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa0116c2212ef64a0f9d42c6262b09f31"></a><!-- doxytag: member="Gst::AlsaSink::create" ref="aa0116c2212ef64a0f9d42c6262b09f31" args="(const Glib::ustring &name)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1AlsaSink.html">AlsaSink</a>> Gst::AlsaSink::create </td> <td>(</td> <td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td> <td class="paramname"> <em>name</em></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a new alsasink plugin with the given name. </p> </div> </div> <a class="anchor" id="ad3a74c2940c0b0433e1ba793336ac318"></a><!-- doxytag: member="Gst::AlsaSink::create" ref="ad3a74c2940c0b0433e1ba793336ac318" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGst_1_1AlsaSink.html">AlsaSink</a>> Gst::AlsaSink::create </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Creates a new alsasink plugin with a unique name. </p> </div> </div> <a class="anchor" id="a3ab7558e7956fd629492f795bf9af7be"></a><!-- doxytag: member="Gst::AlsaSink::gobj" ref="a3ab7558e7956fd629492f795bf9af7be" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const GstAlsaSink* Gst::AlsaSink::gobj </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classGst_1_1AudioSink.html#ab0ca2a5b28077c54a1bc0574dc36afc3">Gst::AudioSink</a>.</p> </div> </div> <a class="anchor" id="a5723622a9a1aad5c3595d29cdf698bf2"></a><!-- doxytag: member="Gst::AlsaSink::gobj" ref="a5723622a9a1aad5c3595d29cdf698bf2" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstAlsaSink* Gst::AlsaSink::gobj </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C GObject. </p> <p>Reimplemented from <a class="el" href="classGst_1_1AudioSink.html#afe1a079581089501006066edc9ba31de">Gst::AudioSink</a>.</p> </div> </div> <a class="anchor" id="af5ebdb6aae6177de54df37bf45f3649c"></a><!-- doxytag: member="Gst::AlsaSink::gobj_copy" ref="af5ebdb6aae6177de54df37bf45f3649c" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">GstAlsaSink* Gst::AlsaSink::gobj_copy </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. </p> <p>Reimplemented from <a class="el" href="classGst_1_1AudioSink.html#a7a5fd2477b8ff46e63f53405fb5dd6c2">Gst::AudioSink</a>.</p> </div> </div> <a class="anchor" id="aa5266609076e78cbe1535d5e8fbf81d5"></a><!-- doxytag: member="Gst::AlsaSink::property_device" ref="aa5266609076e78cbe1535d5e8fbf81d5" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gst::AlsaSink::property_device </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>ALSA device. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="ad0fb756404690840bc841fb08af26ace"></a><!-- doxytag: member="Gst::AlsaSink::property_device" ref="ad0fb756404690840bc841fb08af26ace" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gst::AlsaSink::property_device </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>ALSA device. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <a class="anchor" id="a49fb6db2f5cc83ca4fc4e4fa3c904ba2"></a><!-- doxytag: member="Gst::AlsaSink::property_device_name" ref="a49fb6db2f5cc83ca4fc4e4fa3c904ba2" args="() const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><<a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>> Gst::AlsaSink::property_device_name </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td> const</td> </tr> </table> </div> <div class="memdoc"> <p>Human-readable name of the sound device. </p> <p>You rarely need to use properties because there are get_ and set_ methods for almost all of them. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="a31b6c89e9bbc55ff6e482fcefe69e5ac"></a><!-- doxytag: member="Gst::AlsaSink::wrap" ref="a31b6c89e9bbc55ff6e482fcefe69e5ac" args="(GstAlsaSink *object, bool take_copy=false)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGst_1_1AlsaSink.html">Gst::AlsaSink</a> > wrap </td> <td>(</td> <td class="paramtype">GstAlsaSink * </td> <td class="paramname"> <em>object</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">bool </td> <td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [related]</code></td> </tr> </table> </div> <div class="memdoc"> <p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p> <dl><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr> <tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>gstreamermm/alsasink.h</li> </ul> </div> <hr size="1"/><address style="text-align: right;"><small>Generated on Mon Sep 21 22:33:03 2009 for gstreamermm by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.1 </small></address> </body> </html>