VOICE Burst DTMF response: libqmi-glib Reference Manual

## VOICE Burst DTMF response VOICE Burst DTMF response — Methods to manage the VOICE Burst DTMF response. |

## Functions

QmiMessageVoiceBurstDtmfInput * | qmi_message_voice_burst_dtmf_input_new ()
QmiMessageVoiceBurstDtmfInput * | qmi_message_voice_burst_dtmf_input_ref ()
void | qmi_message_voice_burst_dtmf_input_unref ()
gboolean | qmi_message_voice_burst_dtmf_input_get_data ()
gboolean | qmi_message_voice_burst_dtmf_input_set_data ()
QmiMessageVoiceBurstDtmfOutput * | qmi_message_voice_burst_dtmf_output_ref ()
void | qmi_message_voice_burst_dtmf_output_unref ()
gboolean | qmi_message_voice_burst_dtmf_output_get_result ()
gboolean | qmi_message_voice_burst_dtmf_output_get_call_id ()
QmiMessageVoiceBurstDtmfOutput * | qmi_message_voice_burst_dtmf_response_parse ()
void | qmi_client_voice_burst_dtmf ()
QmiMessageVoiceBurstDtmfOutput * | qmi_client_voice_burst_dtmf_finish ()

## Types and Values

| QmiMessageVoiceBurstDtmfInput
| QmiMessageVoiceBurstDtmfOutput

## Object Hierarchy

        GBoxed
        ├── QmiMessageVoiceBurstDtmfInput
        ╰── QmiMessageVoiceBurstDtmfOutput

## Description

Collection of methods to create requests and parse responses of the VOICE Burst DTMF message.

## Functions

### qmi_message_voice_burst_dtmf_input_new ()

    QmiMessageVoiceBurstDtmfInput *
    qmi_message_voice_burst_dtmf_input_new
                                   (void);

Allocates a new QmiMessageVoiceBurstDtmfInput.

#### Returns

the newly created QmiMessageVoiceBurstDtmfInput. The returned value should be freed with `qmi_message_voice_burst_dtmf_input_unref()`.

Since: 1.32

### qmi_message_voice_burst_dtmf_input_ref ()

    QmiMessageVoiceBurstDtmfInput *
    qmi_message_voice_burst_dtmf_input_ref
                                   (QmiMessageVoiceBurstDtmfInput *self);

Atomically increments the reference count of `self` by one.

#### Parameters

self | a QmiMessageVoiceBurstDtmfInput. |

#### Returns

the new reference to `self` .

Since: 1.32

### qmi_message_voice_burst_dtmf_input_unref ()

    void
    qmi_message_voice_burst_dtmf_input_unref
                                   (QmiMessageVoiceBurstDtmfInput *self);

Atomically decrements the reference count of `self` by one. If the reference count drops to 0, `self` is completely disposed.

#### Parameters

self | a QmiMessageVoiceBurstDtmfInput. |

Since: 1.32

### qmi_message_voice_burst_dtmf_input_get_data ()

    gboolean
    qmi_message_voice_burst_dtmf_input_get_data
                                   (QmiMessageVoiceBurstDtmfInput *self,
                                    guint8 *value_data_call_id,
                                    const gchar **value_data_digit_buffer,
                                    GError **error);

Get the 'Data' field from `self` .

#### Parameters

self | a QmiMessageVoiceBurstDtmfInput. |
value_data_call_id | a placeholder for the output guint8, or `NULL` if not required. | [out][optional]
value_data_digit_buffer | a placeholder for the output constant string, or `NULL` if not required. | [out][optional][transfer none]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_voice_burst_dtmf_input_set_data ()

    gboolean
    qmi_message_voice_burst_dtmf_input_set_data
                                   (QmiMessageVoiceBurstDtmfInput *self,
                                    guint8 value_data_call_id,
                                    const gchar *value_data_digit_buffer,
                                    GError **error);

Set the 'Data' field in the message.

#### Parameters

self | a QmiMessageVoiceBurstDtmfInput. |
value_data_call_id | a guint8. |
value_data_digit_buffer | a constant string. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if `value` was successfully set, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_voice_burst_dtmf_output_ref ()

    QmiMessageVoiceBurstDtmfOutput *
    qmi_message_voice_burst_dtmf_output_ref
                                   (QmiMessageVoiceBurstDtmfOutput *self);

Atomically increments the reference count of `self` by one.

#### Parameters

self | a QmiMessageVoiceBurstDtmfOutput. |

#### Returns

the new reference to `self` .

Since: 1.32

### qmi_message_voice_burst_dtmf_output_unref ()

    void
    qmi_message_voice_burst_dtmf_output_unref
                                   (QmiMessageVoiceBurstDtmfOutput *self);

Atomically decrements the reference count of `self` by one. If the reference count drops to 0, `self` is completely disposed.

#### Parameters

self | a QmiMessageVoiceBurstDtmfOutput. |

Since: 1.32

### qmi_message_voice_burst_dtmf_output_get_result ()

    gboolean
    qmi_message_voice_burst_dtmf_output_get_result
                                   (QmiMessageVoiceBurstDtmfOutput *self,
                                    GError **error);

Get the result of the QMI operation.

#### Parameters

self | a QmiMessageVoiceBurstDtmfOutput. |
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the QMI operation succeeded, `FALSE` if `error` is set.

[skip]

Since: 1.32

### qmi_message_voice_burst_dtmf_output_get_call_id ()

    gboolean
    qmi_message_voice_burst_dtmf_output_get_call_id
                                   (QmiMessageVoiceBurstDtmfOutput *self,
                                    guint8 *value_call_id,
                                    GError **error);

Get the 'Call ID' field from `self` .

#### Parameters

self | a QmiMessageVoiceBurstDtmfOutput. |
value_call_id | a placeholder for the output guint8, or `NULL` if not required. | [out][optional]
error | Return location for error or `NULL`. |

#### Returns

`TRUE` if the field is found, `FALSE` otherwise.

[skip]

Since: 1.32

### qmi_message_voice_burst_dtmf_response_parse ()

    QmiMessageVoiceBurstDtmfOutput *
    qmi_message_voice_burst_dtmf_response_parse
                                   (QmiMessage *message,
                                    GError **error);

Parses a QmiMessage and builds a QmiMessageVoiceBurstDtmfOutput out of it. The operation fails if the message is of the wrong type.

#### Parameters

message | a QmiMessage. |
error | return location for error or `NULL`. |

#### Returns

a QmiMessageVoiceBurstDtmfOutput, or `NULL` if `error` is set. The returned value should be freed with `qmi_message_voice_burst_dtmf_output_unref()`.

Since: 1.34

### qmi_client_voice_burst_dtmf ()

    void
    qmi_client_voice_burst_dtmf (QmiClientVoice *self,
                                 QmiMessageVoiceBurstDtmfInput *input,
                                 guint timeout,
                                 GCancellable *cancellable,
                                 GAsyncReadyCallback callback,
                                 gpointer user_data);

Asynchronously sends a Burst DTMF request to the device.

When the operation is finished, `callback` will be invoked in the thread-default main loop of the thread you are calling this method from.

You can then call `qmi_client_voice_burst_dtmf_finish()` to get the result of the operation.

#### Parameters

self | a QmiClientVoice. |
input | a QmiMessageVoiceBurstDtmfInput. |
timeout | maximum time to wait for the method to complete, in seconds. |
cancellable | a GCancellable or `NULL`. |
callback | a GAsyncReadyCallback to call when the request is satisfied. |
user_data | user data to pass to `callback` . |

Since: 1.32

### qmi_client_voice_burst_dtmf_finish ()

    QmiMessageVoiceBurstDtmfOutput *
    qmi_client_voice_burst_dtmf_finish (QmiClientVoice *self,
                                        GAsyncResult *res,
                                        GError **error);

Finishes an async operation started with `qmi_client_voice_burst_dtmf()`.

#### Parameters

self | a QmiClientVoice. |
res | the GAsyncResult obtained from the GAsyncReadyCallback passed to `qmi_client_voice_burst_dtmf()`. |
error | Return location for error or `NULL`. |

#### Returns

a QmiMessageVoiceBurstDtmfOutput, or `NULL` if `error` is set. The returned value should be freed with `qmi_message_voice_burst_dtmf_output_unref()`.

Since: 1.32

## Types and Values

### QmiMessageVoiceBurstDtmfInput

    typedef struct _QmiMessageVoiceBurstDtmfInput QmiMessageVoiceBurstDtmfInput;

The QmiMessageVoiceBurstDtmfInput structure contains private data and should only be accessed using the provided API.

Since: 1.32

### QmiMessageVoiceBurstDtmfOutput

    typedef struct _QmiMessageVoiceBurstDtmfOutput QmiMessageVoiceBurstDtmfOutput;

The QmiMessageVoiceBurstDtmfOutput structure contains private data and should only be accessed using the provided API.

Since: 1.32