audio_manager_audio_type_t

The supported audio types.

Synopsis:

#include <audio/audio_manager_routing.h>
 

typedef enum {
      AUDIO_TYPE_VOICE   
      AUDIO_TYPE_RINGTONE   
      AUDIO_TYPE_VOICE_RECOGNITION   
      AUDIO_TYPE_TEXT_TO_SPEECH   
      AUDIO_TYPE_VIDEO_CHAT   
      AUDIO_TYPE_VOICE_RECORDING   
      AUDIO_TYPE_MULTIMEDIA   
      AUDIO_TYPE_INPUT_FEEDBACK   
      AUDIO_TYPE_DEFAULT   
      AUDIO_TYPE_ALERT   
      AUDIO_TYPE_VOICE_TONES   
      AUDIO_TYPE_SOUND_EFFECT   
      AUDIO_TYPE_PUSH_TO_TALK   
      AUDIO_TYPE_RESERVED_0   
      AUDIO_TYPE_CMAS   
      AUDIO_TYPE_ALARM   
      AUDIO_TYPE_SCREEN_READER   
      AUDIO_TYPE_COUNT   
      AUDIO_TYPE_UNCHANGED = INT_MAX   
} audio_manager_audio_type_t;

Since:

BlackBerry 10.0.0

Data:

AUDIO_TYPE_VOICE
The audio source is best used for voice.
AUDIO_TYPE_RINGTONE
The audio source is best used for ringtone.
AUDIO_TYPE_VOICE_RECOGNITION
The audio source is best used for voice recognition systems.
AUDIO_TYPE_TEXT_TO_SPEECH
The audio source is best used for text-to-speech.
AUDIO_TYPE_VIDEO_CHAT
The audio source is best used for video chat.
AUDIO_TYPE_VOICE_RECORDING
The audio source is best used for a voice recording.
AUDIO_TYPE_MULTIMEDIA
The audio source is best used for multimedia.
AUDIO_TYPE_INPUT_FEEDBACK
The audio source is best used for user input feedback.
AUDIO_TYPE_DEFAULT
The audio source used as default.
AUDIO_TYPE_ALERT
The audio source is best used to provide alert or notification sound.
AUDIO_TYPE_VOICE_TONES
The audio source is best used to provide voice tone.
AUDIO_TYPE_SOUND_EFFECT
The audio source is best used to provide a high priority sound effect or notification.
AUDIO_TYPE_PUSH_TO_TALK
The audio source is best used to for push-to-talk sound systems.
AUDIO_TYPE_RESERVED_0
The reserved audio type 0.

Since: BlackBerry 10.1.0

AUDIO_TYPE_CMAS
The audio source is best used for Commercial Mobile Alert System (CMAS) emergency broadcast systems.

Since: BlackBerry 10.1.0

AUDIO_TYPE_ALARM
The audio source is best used to as an alarm.

Since: BlackBerry 10.1.0

AUDIO_TYPE_SCREEN_READER
The audio source is best used for screen readers.

Screen readers are used for accessibility.

Since: BlackBerry 10.2.0

AUDIO_TYPE_COUNT
The total number of all audio types.
AUDIO_TYPE_UNCHANGED
The audio type is unchanged if the specified value is specified.

Since: BlackBerry 10.2.0

Library:

libaudio_manager (For the qcc command, use the -l audio_manager option to link against this library)

Description:

Use the enumerated type that describe best describes the usage of the audio source. For example, if the audio source is used as voice, then use choose AUDIO_TYPE_VOICE, however if the audio source is for a ring tone, use AUDIO_TYPE_RINGTONE.

Parent topic: Data types in audio_manager_routing.h