Blame docs/plugins/html/gst-plugins-good-plugins-dtmfsrc.html

Packit 1f69a5
Packit 1f69a5
<html>
Packit 1f69a5
<head>
Packit 1f69a5
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 1f69a5
<title>dtmfsrc: GStreamer Good Plugins 1.0 Plugins Reference Manual</title>
Packit 1f69a5
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 1f69a5
<link rel="home" href="index.html" title="GStreamer Good Plugins 1.0 Plugins Reference Manual">
Packit 1f69a5
<link rel="up" href="ch01.html" title="gst-plugins-good Elements">
Packit 1f69a5
<link rel="prev" href="gst-plugins-good-plugins-directsoundsink.html" title="directsoundsink">
Packit 1f69a5
<link rel="next" href="gst-plugins-good-plugins-dv1394src.html" title="dv1394src">
Packit 1f69a5
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit 1f69a5
<link rel="stylesheet" href="style.css" type="text/css">
Packit 1f69a5
</head>
Packit 1f69a5
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Top  | 
Packit 1f69a5
                  Description  | 
Packit 1f69a5
                  Object Hierarchy  | 
Packit 1f69a5
                  Properties
Packit 1f69a5
Packit 1f69a5
Home
Packit 1f69a5
Up
Packit 1f69a5
Prev
Packit 1f69a5
Next
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

dtmfsrc

Packit 1f69a5

dtmfsrc

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Properties

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
guint
Packit 1f69a5
interval
Packit 1f69a5
Read / Write
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Types and Values

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
struct
Packit 1f69a5
GstDTMFSrc
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Object Hierarchy

Packit 1f69a5
    GObject
Packit 1f69a5
    ╰── GInitiallyUnowned
Packit 1f69a5
        ╰── GstObject
Packit 1f69a5
            ╰── GstElement
Packit 1f69a5
                ╰── GstBaseSrc
Packit 1f69a5
                    ╰── GstDTMFSrc
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Description

Packit 1f69a5

The DTMFSrc element generates DTMF (ITU-T Q.23 Specification) tone packets on request

Packit 1f69a5
from application. The application communicates the beginning and end of a
Packit 1f69a5
DTMF event using custom upstream gstreamer events. To report a DTMF event, an
Packit 1f69a5
application must send an event of type GST_EVENT_CUSTOM_UPSTREAM, having a
Packit 1f69a5
structure of name "dtmf-event" with fields set according to the following
Packit 1f69a5
table:

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Name
Packit 1f69a5
GType
Packit 1f69a5
Possible values
Packit 1f69a5
Purpose
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
type
Packit 1f69a5
G_TYPE_INT
Packit 1f69a5
0-1
Packit 1f69a5
The application uses this field to specify which of the two methods
Packit 1f69a5
specified in RFC 2833 to use. The value should be 0 for tones and 1 for
Packit 1f69a5
named events. Tones are specified by their frequencies and events are specied
Packit 1f69a5
by their number. This element can only take events as input. Do not confuse
Packit 1f69a5
with "method" which specified the output.
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
number
Packit 1f69a5
G_TYPE_INT
Packit 1f69a5
0-15
Packit 1f69a5
The event number.
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
volume
Packit 1f69a5
G_TYPE_INT
Packit 1f69a5
0-36
Packit 1f69a5
This field describes the power level of the tone, expressed in dBm0
Packit 1f69a5
after dropping the sign. Power levels range from 0 to -63 dBm0. The range of
Packit 1f69a5
valid DTMF is from 0 to -36 dBm0. Can be omitted if start is set to FALSE.
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
start
Packit 1f69a5
G_TYPE_BOOLEAN
Packit 1f69a5
True or False
Packit 1f69a5
Whether the event is starting or ending.
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
method
Packit 1f69a5
G_TYPE_INT
Packit 1f69a5
2
Packit 1f69a5
The method used for sending event, this element will react if this
Packit 1f69a5
field is absent or 2.
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

For example, the following code informs the pipeline (and in turn, the

Packit 1f69a5
DTMFSrc element inside the pipeline) about the start of a DTMF named
Packit 1f69a5
event '1' of volume -25 dBm0:

Packit 1f69a5
Packit 1f69a5
structure = gst_structure_new ("dtmf-event",
Packit 1f69a5
                   "type", G_TYPE_INT, 1,
Packit 1f69a5
                   "number", G_TYPE_INT, 1,
Packit 1f69a5
                   "volume", G_TYPE_INT, 25,
Packit 1f69a5
                   "start", G_TYPE_BOOLEAN, TRUE, NULL);
Packit 1f69a5
Packit 1f69a5
event = gst_event_new_custom (GST_EVENT_CUSTOM_UPSTREAM, structure);
Packit 1f69a5
gst_element_send_event (pipeline, event);
Packit 1f69a5
Packit 1f69a5

When a DTMF tone actually starts or stop, a "dtmf-event-processed"

Packit 1f69a5
element GstMessage with the same fields as the "dtmf-event"
Packit 1f69a5
GstEvent that was used to request the event. Also, if any event
Packit 1f69a5
has not been processed when the element goes from the PAUSED to the
Packit 1f69a5
READY state, then a "dtmf-event-dropped" message is posted on the
Packit 1f69a5
GstBus in the order that they were received.

Packit 1f69a5
Packit 1f69a5

Synopsis

Packit 1f69a5
Packit 1f69a5

Element Information

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

plugin

Packit 1f69a5
Packit 1f69a5
            dtmf
Packit 1f69a5
          
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

author

Packit 1f69a5
Youness Alaoui <youness.alaoui@collabora.co.uk>
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

class

Packit 1f69a5
Source/Audio
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Packit 1f69a5
Packit 1f69a5

Element Pads

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

name

Packit 1f69a5
src
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

direction

Packit 1f69a5
source
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

presence

Packit 1f69a5
always
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

details

Packit 1f69a5
audio/x-raw, format=(string)S16LE, rate=(int)[ 1, 2147483647 ], channels=(int)1
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Functions

Packit 1f69a5

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Types and Values

Packit 1f69a5
Packit 1f69a5

struct GstDTMFSrc

Packit 1f69a5
struct GstDTMFSrc;
Packit 1f69a5

The opaque GstDTMFSrc data structure.

Packit 1f69a5
Packit 1f69a5

Members

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Property Details

Packit 1f69a5
Packit 1f69a5

The “interval” property

Packit 1f69a5
  “interval”                 guint
Packit 1f69a5

Interval in ms between two tone packets.

Packit 1f69a5

Flags: Read / Write

Packit 1f69a5

Allowed values: [10,50]

Packit 1f69a5

Default value: 50

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

See Also

Packit 1f69a5

rtpdtmsrc, rtpdtmfmuxx

Packit 1f69a5
Packit 1f69a5
Packit 1f69a5
Packit 1f69a5

Generated by GTK-Doc V1.27
Packit 1f69a5
</body>
Packit 1f69a5
</html>