mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-27 12:11:13 +00:00
ext/jack/gstjackaudiosink.*: Improve docs.
Original commit message from CVS: * ext/jack/gstjackaudiosink.c: (jack_sample_rate_cb), (jack_buffer_size_cb), (jack_shutdown_cb), (gst_jack_ring_buffer_acquire): * ext/jack/gstjackaudiosink.h: Improve docs.
This commit is contained in:
parent
675f4c10de
commit
328506bf6a
3 changed files with 45 additions and 10 deletions
|
@ -1,3 +1,11 @@
|
||||||
|
2007-01-12 Wim Taymans <wim@fluendo.com>
|
||||||
|
|
||||||
|
* ext/jack/gstjackaudiosink.c: (jack_sample_rate_cb),
|
||||||
|
(jack_buffer_size_cb), (jack_shutdown_cb),
|
||||||
|
(gst_jack_ring_buffer_acquire):
|
||||||
|
* ext/jack/gstjackaudiosink.h:
|
||||||
|
Improve docs.
|
||||||
|
|
||||||
2007-01-12 Wim Taymans <wim@fluendo.com>
|
2007-01-12 Wim Taymans <wim@fluendo.com>
|
||||||
|
|
||||||
* ext/gsm/gstgsmenc.c: (gst_gsmenc_init):
|
* ext/gsm/gstgsmenc.c: (gst_gsmenc_init):
|
||||||
|
|
|
@ -20,29 +20,45 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* SECTION:gstjacksink
|
* SECTION:element-jackaudiosink
|
||||||
* @short_description: JACK audio sink
|
* @short_description: JACK audio sink
|
||||||
* @see_also: #GstBaseAudioSink, #GstRingBuffer
|
* @see_also: #GstBaseAudioSink, #GstRingBuffer
|
||||||
*
|
*
|
||||||
|
* <refsect2>
|
||||||
|
* <para>
|
||||||
* A Sink that outputs data to Jack ports.
|
* A Sink that outputs data to Jack ports.
|
||||||
*
|
* </para>
|
||||||
* It will create N Jack ports named out_<num> where <num> is starting from 1.
|
* <para>
|
||||||
|
* It will create N Jack ports named out_<num> where <num> is starting from 1.
|
||||||
* Each port corresponds to a gstreamer channel.
|
* Each port corresponds to a gstreamer channel.
|
||||||
*
|
* </para>
|
||||||
|
* <para>
|
||||||
* The samplerate as exposed on the caps is always the same as the samplerate of
|
* The samplerate as exposed on the caps is always the same as the samplerate of
|
||||||
* the jack server.
|
* the jack server.
|
||||||
*
|
* </para>
|
||||||
|
* <para>
|
||||||
* When the ::connect property is set to auto, this element will try to connect
|
* When the ::connect property is set to auto, this element will try to connect
|
||||||
* each output port to a random physical jack input pin. In this mode, the sink
|
* each output port to a random physical jack input pin. In this mode, the sink
|
||||||
* will expose the number of physical channels on its pad caps.
|
* will expose the number of physical channels on its pad caps.
|
||||||
*
|
* </para>
|
||||||
|
* <para>
|
||||||
* When the ::connect property is set to none, the element will accept any
|
* When the ::connect property is set to none, the element will accept any
|
||||||
* number of input channels and will create (but not connect) an output port for
|
* number of input channels and will create (but not connect) an output port for
|
||||||
* each channel.
|
* each channel.
|
||||||
*
|
* </para>
|
||||||
|
* <para>
|
||||||
* The element will generate an error when the Jack server is shut down when it
|
* The element will generate an error when the Jack server is shut down when it
|
||||||
* was PAUSED or PLAYING. This element does not support dynamic rate and buffer
|
* was PAUSED or PLAYING. This element does not support dynamic rate and buffer
|
||||||
* size changes at runtime.
|
* size changes at runtime.
|
||||||
|
* </para>
|
||||||
|
* <title>Example launch line</title>
|
||||||
|
* <para>
|
||||||
|
* <programlisting>
|
||||||
|
* gst-launch audiotestsrc ! jackaudiosink
|
||||||
|
* </programlisting>
|
||||||
|
* Play a sine wave to using jack.
|
||||||
|
* </para>
|
||||||
|
* </refsect2>
|
||||||
*
|
*
|
||||||
* Last reviewed on 2006-11-30 (0.10.4)
|
* Last reviewed on 2006-11-30 (0.10.4)
|
||||||
*/
|
*/
|
||||||
|
@ -394,9 +410,9 @@ gst_jack_ring_buffer_close_device (GstRingBuffer * buf)
|
||||||
/* allocate a buffer and setup resources to process the audio samples of
|
/* allocate a buffer and setup resources to process the audio samples of
|
||||||
* the format as specified in @spec.
|
* the format as specified in @spec.
|
||||||
*
|
*
|
||||||
* We allocate N jack ports for each channel. If we are asked to automatically
|
* We allocate N jack ports, one for each channel. If we are asked to
|
||||||
* make a connection with physical ports, we connect as many ports as there are
|
* automatically make a connection with physical ports, we connect as many
|
||||||
* physical ports, leaving leftover ports unconnected.
|
* ports as there are physical ports, leaving leftover ports unconnected.
|
||||||
*
|
*
|
||||||
* It is assumed that samplerate and number of channels are acceptable since our
|
* It is assumed that samplerate and number of channels are acceptable since our
|
||||||
* getcaps method will always provide correct values. If unacceptable caps are
|
* getcaps method will always provide correct values. If unacceptable caps are
|
||||||
|
|
|
@ -39,6 +39,17 @@ G_BEGIN_DECLS
|
||||||
typedef struct _GstJackAudioSink GstJackAudioSink;
|
typedef struct _GstJackAudioSink GstJackAudioSink;
|
||||||
typedef struct _GstJackAudioSinkClass GstJackAudioSinkClass;
|
typedef struct _GstJackAudioSinkClass GstJackAudioSinkClass;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstJackConnect:
|
||||||
|
* @GST_JACK_CONNECT_NONE: Don't automatically connect to physical ports.
|
||||||
|
* In this mode, the element will accept any number of input channels and will
|
||||||
|
* create (but not connect) an output port for each channel.
|
||||||
|
* @GST_JACK_CONNECT_AUTO: In this mode, the element will try to connect each
|
||||||
|
* output port to a random physical jack input pin. The sink will
|
||||||
|
* expose the number of physical channels on its pad caps.
|
||||||
|
*
|
||||||
|
* Specify how the output ports will be connected.
|
||||||
|
*/
|
||||||
typedef enum {
|
typedef enum {
|
||||||
GST_JACK_CONNECT_NONE,
|
GST_JACK_CONNECT_NONE,
|
||||||
GST_JACK_CONNECT_AUTO
|
GST_JACK_CONNECT_AUTO
|
||||||
|
|
Loading…
Reference in a new issue