VOICE enumerations and flags

VOICE enumerations and flags

Synopsis

enum                QmiVoiceCallState;
enum                QmiVoiceCallType;
enum                QmiVoiceCallDirection;
enum                QmiVoiceCallMode;
enum                QmiVoiceAls;
enum                QmiVoicePresentation;
enum                QmiVoiceDomain;
enum                QmiVoicePrivacy;
enum                QmiVoiceServiceOption;
enum                QmiVoiceTtyMode;
enum                QmiVoiceWcdmaAmrStatus;

const gchar *       qmi_voice_call_state_get_string     (QmiVoiceCallState val);
const gchar *       qmi_voice_call_type_get_string      (QmiVoiceCallType val);
const gchar *       qmi_voice_call_direction_get_string (QmiVoiceCallDirection val);
const gchar *       qmi_voice_call_mode_get_string      (QmiVoiceCallMode val);
const gchar *       qmi_voice_als_get_string            (QmiVoiceAls val);
const gchar *       qmi_voice_presentation_get_string   (QmiVoicePresentation val);
const gchar *       qmi_voice_domain_get_string         (QmiVoiceDomain val);
const gchar *       qmi_voice_privacy_get_string        (QmiVoicePrivacy val);
const gchar *       qmi_voice_service_option_get_string (QmiVoiceServiceOption val);
const gchar *       qmi_voice_tty_mode_get_string       (QmiVoiceTtyMode val);
gchar *             qmi_voice_wcdma_amr_status_build_string_from_mask
                                                        (QmiVoiceWcdmaAmrStatus mask);

Object Hierarchy

  GEnum
   +----QmiVoiceCallState
  GEnum
   +----QmiVoiceCallType
  GEnum
   +----QmiVoiceCallDirection
  GEnum
   +----QmiVoiceCallMode
  GEnum
   +----QmiVoiceAls
  GEnum
   +----QmiVoicePresentation
  GEnum
   +----QmiVoiceDomain
  GEnum
   +----QmiVoicePrivacy
  GEnum
   +----QmiVoiceServiceOption
  GEnum
   +----QmiVoiceTtyMode
  GFlags
   +----QmiVoiceWcdmaAmrStatus

Description

This section defines enumerations and flags used in the VOICE service interface.

Details

enum QmiVoiceCallState

typedef enum {
    QMI_VOICE_CALL_STATE_UNKNOWN        = 0x00,
    QMI_VOICE_CALL_STATE_ORIGINATION    = 0x01,
    QMI_VOICE_CALL_STATE_INCOMING       = 0x02,
    QMI_VOICE_CALL_STATE_CONVERSATION   = 0x03,
    QMI_VOICE_CALL_STATE_CC_IN_PROGRESS = 0x04,
    QMI_VOICE_CALL_STATE_ALERTING       = 0x05,
    QMI_VOICE_CALL_STATE_HOLD           = 0x06,
    QMI_VOICE_CALL_STATE_WAITING        = 0x07,
    QMI_VOICE_CALL_STATE_DISCONNECTING  = 0x08,
    QMI_VOICE_CALL_STATE_END            = 0x09,
    QMI_VOICE_CALL_STATE_SETUP          = 0x0A,
} QmiVoiceCallState;

State of a call.

QMI_VOICE_CALL_STATE_UNKNOWN

Unknown state.

QMI_VOICE_CALL_STATE_ORIGINATION

Call is being originated.

QMI_VOICE_CALL_STATE_INCOMING

Incoming call.

QMI_VOICE_CALL_STATE_CONVERSATION

Call is in progress.

QMI_VOICE_CALL_STATE_CC_IN_PROGRESS

Call is originating but waiting for call control to complete.

QMI_VOICE_CALL_STATE_ALERTING

Alerting.

QMI_VOICE_CALL_STATE_HOLD

On hold.

QMI_VOICE_CALL_STATE_WAITING

Waiting.

QMI_VOICE_CALL_STATE_DISCONNECTING

Disconnecting.

QMI_VOICE_CALL_STATE_END

Call is finished.

QMI_VOICE_CALL_STATE_SETUP

MT call is in setup state (3GPP).

enum QmiVoiceCallType

typedef enum {
    QMI_VOICE_CALL_TYPE_VOICE         = 0x00,
    QMI_VOICE_CALL_TYPE_VOICE_IP      = 0x02,
    QMI_VOICE_CALL_TYPE_OTAPA         = 0x06,
    QMI_VOICE_CALL_TYPE_NON_STD_OTASP = 0x08,
    QMI_VOICE_CALL_TYPE_EMERGENCY     = 0x09,
    QMI_VOICE_CALL_TYPE_SUPS          = 0x0A,
} QmiVoiceCallType;

Type of a voice call.

QMI_VOICE_CALL_TYPE_VOICE

Voice call.

QMI_VOICE_CALL_TYPE_VOICE_IP

VoIP call.

QMI_VOICE_CALL_TYPE_OTAPA

OTAPA.

QMI_VOICE_CALL_TYPE_NON_STD_OTASP

Non-standard OTASP.

QMI_VOICE_CALL_TYPE_EMERGENCY

Emergency call.

QMI_VOICE_CALL_TYPE_SUPS

Supplementary service.

enum QmiVoiceCallDirection

typedef enum {
    QMI_VOICE_CALL_DIRECTION_UNKNOWN = 0x00,
    QMI_VOICE_CALL_DIRECTION_MO      = 0x01,
    QMI_VOICE_CALL_DIRECTION_MT      = 0x02,
} QmiVoiceCallDirection;

Call direction.

QMI_VOICE_CALL_DIRECTION_UNKNOWN

Unknown.

QMI_VOICE_CALL_DIRECTION_MO

Mobile-originated.

QMI_VOICE_CALL_DIRECTION_MT

Mobile-terminated.

enum QmiVoiceCallMode

typedef enum {
    QMI_VOICE_CALL_MODE_UNKNOWN = 0x00,
    QMI_VOICE_CALL_MODE_CDMA    = 0x01,
    QMI_VOICE_CALL_MODE_GSM     = 0x02,
    QMI_VOICE_CALL_MODE_UMTS    = 0x03,
    QMI_VOICE_CALL_MODE_LTE     = 0x04,
} QmiVoiceCallMode;

Call mode.

QMI_VOICE_CALL_MODE_UNKNOWN

Unknown.

QMI_VOICE_CALL_MODE_CDMA

CDMA.

QMI_VOICE_CALL_MODE_GSM

GSM.

QMI_VOICE_CALL_MODE_UMTS

UMTS.

QMI_VOICE_CALL_MODE_LTE

LTE.

enum QmiVoiceAls

typedef enum {
    QMI_VOICE_ALS_LINE_1 = 0x00,
    QMI_VOICE_ALS_LINE_2 = 0x01,
} QmiVoiceAls;

ALS line indicator.

QMI_VOICE_ALS_LINE_1

Line 1 (default).

QMI_VOICE_ALS_LINE_2

Line 2.

enum QmiVoicePresentation

typedef enum {
    QMI_VOICE_PRESENTATION_ALLOWED     = 0x00,
    QMI_VOICE_PRESENTATION_RESTRICTED  = 0x01,
    QMI_VOICE_PRESENTATION_UNAVAILABLE = 0x02,
    QMI_VOICE_PRESENTATION_PAYPHONE    = 0x04,
} QmiVoicePresentation;

Remote party number presentation indicator.

QMI_VOICE_PRESENTATION_ALLOWED

Allowed presentation.

QMI_VOICE_PRESENTATION_RESTRICTED

Restricted presentation.

QMI_VOICE_PRESENTATION_UNAVAILABLE

Unavailable presentation.

QMI_VOICE_PRESENTATION_PAYPHONE

Payphone presentation (3GPP only).

enum QmiVoiceDomain

typedef enum {
    QMI_VOICE_DOMAIN_CS_ONLY      = 0x00,
    QMI_VOICE_DOMAIN_PS_ONLY      = 0x01,
    QMI_VOICE_DOMAIN_CS_PREFERRED = 0x02,
    QMI_VOICE_DOMAIN_PS_PREFERRED = 0x03,
} QmiVoiceDomain;

Voice domain preference.

QMI_VOICE_DOMAIN_CS_ONLY

CS-only.

QMI_VOICE_DOMAIN_PS_ONLY

PS-only.

QMI_VOICE_DOMAIN_CS_PREFERRED

CS preferred, PS secondary.

QMI_VOICE_DOMAIN_PS_PREFERRED

PS preferred, CS secondary.

enum QmiVoicePrivacy

typedef enum {
    QMI_VOICE_PRIVACY_STANDARD = 0x00,
    QMI_VOICE_PRIVACY_ENHANCED = 0x01,
} QmiVoicePrivacy;

Voice privacy.

QMI_VOICE_PRIVACY_STANDARD

Standard.

QMI_VOICE_PRIVACY_ENHANCED

Enhanced.

enum QmiVoiceServiceOption

typedef enum {
    QMI_VOICE_SERVICE_OPTION_WILD                    = 0x0000,
    QMI_VOICE_SERVICE_OPTION_IS_96A                  = 0x0001,
    QMI_VOICE_SERVICE_OPTION_EVRC                    = 0x0003,
    QMI_VOICE_SERVICE_OPTION_13K_IS733               = 0x0011,
    QMI_VOICE_SERVICE_OPTION_SELECTABLE_MODE_VOCODER = 0x0038,
    QMI_VOICE_SERVICE_OPTION_4GV_NARROW_BAND         = 0x0044,
    QMI_VOICE_SERVICE_OPTION_4GV_WIDE_BAND           = 0x0046,
    QMI_VOICE_SERVICE_OPTION_13K                     = 0x8000,
    QMI_VOICE_SERVICE_OPTION_IS_96                   = 0x8001,
    QMI_VOICE_SERVICE_OPTION_WVRC                    = 0x8023,
} QmiVoiceServiceOption;

Service option.

QMI_VOICE_SERVICE_OPTION_WILD

Any service option.

QMI_VOICE_SERVICE_OPTION_IS_96A

IS-96A.

QMI_VOICE_SERVICE_OPTION_EVRC

EVRC.

QMI_VOICE_SERVICE_OPTION_13K_IS733

IS733.

QMI_VOICE_SERVICE_OPTION_SELECTABLE_MODE_VOCODER

Selectable mode vocoder.

QMI_VOICE_SERVICE_OPTION_4GV_NARROW_BAND

4GV narrowband.

QMI_VOICE_SERVICE_OPTION_4GV_WIDE_BAND

4GV wideband.

QMI_VOICE_SERVICE_OPTION_13K

13K.

QMI_VOICE_SERVICE_OPTION_IS_96

IS-96.

QMI_VOICE_SERVICE_OPTION_WVRC

WVRC.

enum QmiVoiceTtyMode

typedef enum {
    QMI_VOICE_TTY_MODE_FULL = 0x00,
    QMI_VOICE_TTY_MODE_VCO  = 0x01,
    QMI_VOICE_TTY_MODE_HCO  = 0x02,
    QMI_VOICE_TTY_MODE_OFF  = 0x03,
} QmiVoiceTtyMode;

TTY mode.

QMI_VOICE_TTY_MODE_FULL

Full.

QMI_VOICE_TTY_MODE_VCO

Voice carry over.

QMI_VOICE_TTY_MODE_HCO

Hearing carry over.

QMI_VOICE_TTY_MODE_OFF

Off.

enum QmiVoiceWcdmaAmrStatus

typedef enum {
    QMI_VOICE_WCDMA_AMR_STATUS_NOT_SUPPORTED = 1 << 0,
    QMI_VOICE_WCDMA_AMR_STATUS_WCDMA_AMR_WB  = 1 << 1,
    QMI_VOICE_WCDMA_AMR_STATUS_GSM_HR_AMR    = 1 << 2,
    QMI_VOICE_WCDMA_AMR_STATUS_GSM_AMR_WB    = 1 << 3,
    QMI_VOICE_WCDMA_AMR_STATUS_GSM_AMR_NB    = 1 << 4,
} QmiVoiceWcdmaAmrStatus;

WCDMA AMR status.

QMI_VOICE_WCDMA_AMR_STATUS_NOT_SUPPORTED

Not supported.

QMI_VOICE_WCDMA_AMR_STATUS_WCDMA_AMR_WB

WCDMA AMR wideband.

QMI_VOICE_WCDMA_AMR_STATUS_GSM_HR_AMR

GSM half-rate AMR.

QMI_VOICE_WCDMA_AMR_STATUS_GSM_AMR_WB

GSM AMR wideband.

QMI_VOICE_WCDMA_AMR_STATUS_GSM_AMR_NB

GSM AMR narrowband.

qmi_voice_call_state_get_string ()

const gchar *       qmi_voice_call_state_get_string     (QmiVoiceCallState val);

Gets the nickname string for the QmiVoiceCallState specified at val.

val :

a QmiVoiceCallState.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_call_type_get_string ()

const gchar *       qmi_voice_call_type_get_string      (QmiVoiceCallType val);

Gets the nickname string for the QmiVoiceCallType specified at val.

val :

a QmiVoiceCallType.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_call_direction_get_string ()

const gchar *       qmi_voice_call_direction_get_string (QmiVoiceCallDirection val);

Gets the nickname string for the QmiVoiceCallDirection specified at val.

val :

a QmiVoiceCallDirection.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_call_mode_get_string ()

const gchar *       qmi_voice_call_mode_get_string      (QmiVoiceCallMode val);

Gets the nickname string for the QmiVoiceCallMode specified at val.

val :

a QmiVoiceCallMode.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_als_get_string ()

const gchar *       qmi_voice_als_get_string            (QmiVoiceAls val);

Gets the nickname string for the QmiVoiceAls specified at val.

val :

a QmiVoiceAls.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_presentation_get_string ()

const gchar *       qmi_voice_presentation_get_string   (QmiVoicePresentation val);

Gets the nickname string for the QmiVoicePresentation specified at val.

val :

a QmiVoicePresentation.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_domain_get_string ()

const gchar *       qmi_voice_domain_get_string         (QmiVoiceDomain val);

Gets the nickname string for the QmiVoiceDomain specified at val.

val :

a QmiVoiceDomain.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_privacy_get_string ()

const gchar *       qmi_voice_privacy_get_string        (QmiVoicePrivacy val);

Gets the nickname string for the QmiVoicePrivacy specified at val.

val :

a QmiVoicePrivacy.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_service_option_get_string ()

const gchar *       qmi_voice_service_option_get_string (QmiVoiceServiceOption val);

Gets the nickname string for the QmiVoiceServiceOption specified at val.

val :

a QmiVoiceServiceOption.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_tty_mode_get_string ()

const gchar *       qmi_voice_tty_mode_get_string       (QmiVoiceTtyMode val);

Gets the nickname string for the QmiVoiceTtyMode specified at val.

val :

a QmiVoiceTtyMode.

Returns :

a string with the nickname, or NULL if not found. Do not free the returned value. [transfer none]

qmi_voice_wcdma_amr_status_build_string_from_mask ()

gchar *             qmi_voice_wcdma_amr_status_build_string_from_mask
                                                        (QmiVoiceWcdmaAmrStatus mask);

Builds a string containing a comma-separated list of nicknames for each QmiVoiceWcdmaAmrStatus in mask.

mask :

bitmask of QmiVoiceWcdmaAmrStatus values.

Returns :

a string with the list of nicknames, or NULL if none given. The returned value should be freed with g_free(). [transfer full]