docs/plugins/html/gst-plugins-good-plugins-directsoundsink.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>directsoundsink</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
   7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
   9 <link rel="prev" href="gst-plugins-good-plugins-dicetv.html" title="dicetv">
  10 <link rel="next" href="gst-plugins-good-plugins-dv1394src.html" title="dv1394src">
  11 <meta name="generator" content="GTK-Doc V1.17 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-good-plugins-dicetv.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Good Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-good-plugins-dv1394src.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-good-plugins-directsoundsink.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-good-plugins-directsoundsink.description" class="shortcut">Description</a>
  27 </td></tr>
  28 </table>
  29 <div class="refentry">
  30 <a name="gst-plugins-good-plugins-directsoundsink"></a><div class="titlepage"></div>
  31 <div class="refnamediv"><table width="100%"><tr>
  32 <td valign="top">
  33 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-directsoundsink.top_of_page"></a>directsoundsink</span></h2>
  34 <p>directsoundsink — DirectSound audio sink</p>
  35 </td>
  36 <td valign="top" align="right"></td>
  37 </tr></table></div>
  38 <div class="refsynopsisdiv">
  39 <a name="gst-plugins-good-plugins-directsoundsink.synopsis"></a><h2>Synopsis</h2>
  40 <pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-directsoundsink.html#GstDirectSoundSink" title="struct GstDirectSoundSink">GstDirectSoundSink</a>;
  41 </pre>
  42 </div>
  43 <div class="refsect1">
  44 <a name="gst-plugins-good-plugins-directsoundsink.description"></a><h2>Description</h2>
  45 <p>
  46 This element lets you output sound using the DirectSound API.
  47 </p>
  48 <p>
  49 Note that you should almost always use generic audio conversion elements
  50 like audioconvert and audioresample in front of an audiosink to make sure
  51 your pipeline works under all circumstances (those conversion elements will
  52 act in passthrough-mode if no conversion is necessary).
  53 </p>
  54 <p>
  55 </p>
  56 <div class="refsect2">
  57 <a name="idp5618272"></a><h3>Example pipelines</h3>
  58 <div class="informalexample">
  59   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  60     <tbody>
  61       <tr>
  62         <td class="listing_lines" align="right"><pre>1</pre></td>
  63         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v audiotestsrc <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> volume volume<span class="gtkdoc opt">=</span><span class="number">0.1</span> <span class="gtkdoc opt">!</span> directsoundsink</pre></td>
  64       </tr>
  65     </tbody>
  66   </table>
  67 </div>
  68  will output a sine wave (continuous beep sound) to your sound card (with
  69 a very low volume as precaution).
  70 <div class="informalexample">
  71   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  72     <tbody>
  73       <tr>
  74         <td class="listing_lines" align="right"><pre>1</pre></td>
  75         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>music<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> decodebin <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> audioresample <span class="gtkdoc opt">!</span> directsoundsink</pre></td>
  76       </tr>
  77     </tbody>
  78   </table>
  79 </div>
  80  will play an Ogg/Vorbis audio file and output it.
  81 </div>
  82 <p>
  83 </p>
  84 <div class="refsynopsisdiv">
  85 <h2>Synopsis</h2>
  86 <div class="refsect2">
  87 <a name="idp7789488"></a><h3>Element Information</h3>
  88 <div class="variablelist"><table border="0">
  89 <col align="left" valign="top">
  90 <tbody>
  91 <tr>
  92 <td><p><span class="term">plugin</span></p></td>
  93 <td>
  94             <a class="link" href="gst-plugins-good-plugins-plugin-directsound.html#plugin-directsound">directsound</a>
  95           </td>
  96 </tr>
  97 <tr>
  98 <td><p><span class="term">author</span></p></td>
  99 <td>Sebastien Moutte &lt;sebastien@moutte.net&gt;</td>
 100 </tr>
 101 <tr>
 102 <td><p><span class="term">class</span></p></td>
 103 <td>Sink/Audio</td>
 104 </tr>
 105 </tbody>
 106 </table></div>
 107 </div>
 108 <hr>
 109 <div class="refsect2">
 110 <a name="idp13588464"></a><h3>Element Pads</h3>
 111 </div>
 112 </div>
 113 <p>
 114 </p>
 115 </div>
 116 <div class="refsect1">
 117 <a name="gst-plugins-good-plugins-directsoundsink.details"></a><h2>Details</h2>
 118 <div class="refsect2">
 119 <a name="GstDirectSoundSink"></a><h3>struct GstDirectSoundSink</h3>
 120 <pre class="programlisting">struct GstDirectSoundSink {
 121   GstAudioSink sink;
 122
 123   /* directsound object interface pointer */
 124   LPDIRECTSOUND pDS;
 125
 126   /* directsound sound object interface pointer */
 127   LPDIRECTSOUNDBUFFER pDSBSecondary;
 128
 129   /* directSound buffer size */
 130   guint buffer_size;
 131
 132   /* offset of the circular buffer where we must write next */
 133   guint current_circular_offset;
 134
 135   guint bytes_per_sample;
 136
 137   /* current volume setup by mixer interface */
 138   glong volume;
 139
 140   /* tracks list of our mixer interface implementation */
 141   GList *tracks;
 142
 143   GstCaps *cached_caps;
 144
 145   /* lock used to protect writes and resets */
 146   GMutex *dsound_lock;
 147
 148   gboolean first_buffer_after_reset;
 149
 150   GstBufferFormat buffer_format;
 151 };
 152 </pre>
 153 <p>
 154 </p>
 155 </div>
 156 </div>
 157 </div>
 158 <div class="footer">
 159 <hr>
 160           Generated by GTK-Doc V1.17</div>
 161 </body>
 162 </html>