inc/PalDefs.h
Structures
aac_enc_cfg
Members
uint16_t
AAC encoder mode.
uint16_t
AAC format flag.
pal_snd_enc_aac
Members
uint32_t
uint32_t
struct aac_enc_cfg
pal_snd_dec_aac
Members
uint16_t
uint16_t
pal_snd_dec_wma
Members
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
pal_snd_dec_alac
Members
uint32_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint8_t
uint16_t
uint32_t
uint32_t
uint32_t
uint32_t
pal_snd_dec_ape
Members
uint16_t
uint16_t
uint32_t
uint32_t
uint32_t
uint32_t
uint16_t
uint16_t
uint32_t
uint32_t
pal_snd_dec_flac
Members
uint16_t
uint16_t
uint16_t
uint16_t
uint16_t
pal_snd_dec_vorbis
Members
uint32_t
pal_snd_dec_opus
Members
uint16_t
uint16_t
uint8_t
uint8_t
uint16_t
uint32_t
uint16_t
uint8_t
uint8_t
uint8_t
uint8_t
pal_haptics_payload
Members
pal_haptics_mode
pal_spkr_prot_payload
Members
uint32_t
uint32_t
pal_spkr_prot_mode
pal_snd_dec_t
Audio parameter data.
Members
struct pal_snd_dec_aac
struct pal_snd_dec_wma
struct pal_snd_dec_alac
struct pal_snd_dec_ape
struct pal_snd_dec_flac
struct pal_snd_dec_vorbis
struct pal_snd_dec_opus
pal_snd_enc_t
Audio encoder parameter data.
Members
struct pal_snd_enc_aac
pal_param_payload_s
Audio parameter data.
Members
uint32_t
uint8_t
pal_channel_info
Audio channel info data structure.
Members
uint16_t
number of channels
uint8_t
ch_map value per channel.
pal_stream_info
Members
int64_t
int64_t
version of structure
int64_t
size of structure
bool
duration in microseconds, -1 if unknown
bool
optional, true if stream is tied to a video stream
int32_t
true if streaming, false if local playback
int32_t
used only if stream_type is LOOPBACK.
int32_t
enums defined in enum pal_stream_proxy_tx_types
int32_t
enums defined in enum pal_stream_proxy_rx_types
bool
enums defined in enum pal_sream_haptics_types
pal_voice_record_info
Members
int64_t
int64_t
version of structure
pal_incall_record_direction
size of structure
pal_voice_call_info
Members
uint32_t
uint32_t
pal_incall_music_info
Members
bool
pal_incall_music_direction
pal_hpcm_stream_info
Members
pal_hpcm_stream_type_t
pal_stream_info_t
Members
struct pal_stream_info
struct pal_voice_record_info
struct pal_voice_call_info
struct pal_incall_music_info
struct pal_hpcm_stream_info
pal_media_config
Media configuraiton.
Members
uint32_t
sample rate
uint32_t
bit width
pal_audio_fmt_t
audio format id
struct pal_channel_info
channel info
dynamic_media_config
Members
uint32_t
sample rate
uint32_t
format
uint32_t
channel mask
bool
input/output jack status
pal_stream_attributes
Key value pair to identify the topology of a usecase from default
Members
pal_stream_type_t
stream type
pal_stream_info_t
stream info
pal_stream_flags_t
stream flags
pal_stream_direction_t
direction of the streams
struct pal_media_config
media config of the input audio samples
struct pal_media_config
media config of the output audio samples
char *
address
modifier_kv
Members
uint32_t
uint32_t
pal_extern_alloc_buff_info
Members
int
unique memory handle identifying extern mem allocation
uint32_t
size of external allocation
uint32_t
offset of buffer within extern allocation
pal_buffer
PAL buffer structure used for reading/writing buffers from/to the stream.
Members
uint8_t *
buffer pointer
size_t
number of bytes
size_t
offset in buffer from where valid byte starts
struct timespec *
timestmap
uint32_t
flags
size_t
size of metadata buffer in bytes
uint8_t *
metadata buffer.
pal_extern_alloc_buff_info_t
holds info for extern buff
uint64_t
frame index of the buffer
pal_clbk_buffer_info
Members
uint64_t
frame index of the buffer
uint32_t
updated sample rate
uint32_t
updated bit width
uint16_t
updated channel count
pal_callback_buffer
Members
uint8_t *
buffer pointer
size_t
filled length of the buffer
struct timespec *
timestamp
uint32_t
status of callback payload
struct pal_clbk_buffer_info
callback buffer info
pal_mmap_buffer
PAL buffer structure used for reading/writing buffers from/to the stream.
Members
void *
base address of mmap memory buffer, for use by local proces only
int32_t
fd for mmap memory buffer
uint32_t
total buffer size in frames
uint32_t
transfer size granularity in frames
pal_mmap_buffer_flags_t
Attributes describing the buffer.
pal_mmap_position
Mmap buffer read/write position returned by GetMmapPosition.
Members
int64_t
timestamp in ns, CLOCK_MONOTONIC
int32_t
increasing 32 bit frame count reset when stop() is called
pal_channel_vol_kv
channel mask and volume pair
Members
uint32_t
channel mask
float
gain of the channel mask
pal_volume_data
Volume data strucutre defintion used as argument for volume command.
Members
uint32_t
no of volume pairs
struct pal_channel_vol_kv
channel mask and volume pair
pal_gain_data
Gain data strucutre defintion used as argument for gain command.
Members
uint16_t
uint16_t
Gain value in q13 format.
pal_time_us
Members
uint32_t
uint32_t
Lower 32 bits of 64 bit time value in microseconds.
pal_session_time
Timestamp strucutre defintion used as argument for gettimestamp api.
Members
struct pal_time_us
struct pal_time_us
Value of the current session time in microseconds.
struct pal_time_us
Value of the absolute time in microseconds.
pal_param_proxy_channel_config
Audio parameter data.
Members
uint32_t
pal_param_context_list
Members
uint32_t
uint32_t
pal_param_disp_port_config_params
Members
int
int
pal_usb_device_address
Members
int
int
pal_device_config_t
Members
struct pal_param_disp_port_config_params
struct pal_usb_device_address
pal_amp_db_and_gain_table
Members
float
float
uint32_t
pal_vol_ctrl_ramp_param
Members
uint32_t
pal_device_custom_config
Members
char
pal_address_type_t
Structure to hold various types of device addresses.
Members
char
uint8_t
uint8_t
uint32_t
uint32_t
pal_device
Members
pal_device_id_t
device id
struct pal_media_config
media config of the device
struct pal_usb_device_address
char
pal_device_custom_config_t
Optional.
pal_address_type_t
pal_param_device_connection
Members
pal_device_id_t
bool
pal_device_config_t
struct pal_device
pal_param_gain_lvl_map
Members
struct pal_amp_db_and_gain_table *
int
int
pal_param_gain_lvl_cal
Members
int
pal_param_mspp_linear_gain
Members
int32_t
pal_param_playback_rate
Members
float
float
pal_param_device_capability
Members
pal_device_id_t
struct pal_usb_device_address
bool
struct dynamic_media_config *
pal_param_screen_state
Members
bool
pal_param_charging_state
Members
bool
pal_param_charger_state
Members
bool
bool
pal_param_st_capture_info
Members
int
pal_stream_handle_t *
pal_param_resources_available
Members
void *
uint64_t
pal_param_device_rotation
Members
pal_speaker_rotation_type
pal_param_uhqa_state
Members
bool
pal_param_haptics_cnfg_t
Members
pal_stream_haptics_type_t
int16_t
float
int16_t
int32_t
int16_t
bool
int32_t
uint8_t *
btsco_lc3_cfg
Members
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
uint32_t
char
char
pal_param_btsco
Members
bool
bool
bool
int
bool
btsco_lc3_cfg_t
bool
pal_param_bta2dp
Members
int32_t
bool
bool
bool
bool
bool
bool
uint32_t
pal_device_id_t
bool
bool
pal_param_latency_mode
Members
pal_device_id_t
size_t
uint32_t
pal_param_upd_event_detection
Members
bool
pal_bt_tws_payload_s
Members
bool
uint32_t
pal_param_dtmf_detection_cfg
Members
uint16_t
pal_stream_direction_t
pal_param_dtmf_gen_tone_cfg
Members
pal_stream_direction_t
uint16_t
uint16_t
uint16_t
int32_t
pal_bt_lc3_payload_s
Members
bool
pal_param_haptics_intensity
Members
int
pal_sound_dose_info
payload for Sound Dose Info
Members
struct pal_device
uint32_t
uint32_t
float
uint64_t
st_uuid
Members
uint32_t
uint16_t
uint16_t
uint16_t
uint8_t
pal_st_properties
sound trigger implementation descriptor read by the framework via get_properties().
Members
int8_t
int8_t
uint32_t
struct st_uuid
uint32_t
uint32_t
uint32_t
uint32_t
bool
uint32_t
bool
bool
uint32_t
pal_st_phrase
key phrase descriptor
Members
uint32_t
keyphrase ID
uint32_t
recognition modes supported by this key phrase
uint32_t
number of users in the key phrase
uint32_t
users ids: (not uid_t but sound trigger specific IDs
char
locale - JAVA Locale style (e.g.
char
phrase text in UTF-8 format.
pal_st_confidence_level
Members
uint32_t
uint32_t
pal_st_phrase_recognition_extra
Specialized recognition event for key phrase detection.
Members
uint32_t
uint32_t
uint32_t
uint32_t
struct pal_st_confidence_level
pal_st_recognition_event
Members
int32_t
recognition status e.g.
pal_st_sound_model_type_t
event type, same as sound model type.
pal_st_handle_t *
handle of sound trigger session
bool
it is possible to capture audio from this utterance buffered by the implementation
int32_t
audio session ID.
int32_t
delay in ms between end of model detection and start of audio available for capture.
int32_t
duration in ms of audio captured before the start of the trigger.
bool
the opaque data is the capture of the trigger sound
struct pal_media_config
media format of either the trigger in event data or to use for capture of the rest of the utterance
uint32_t
size of opaque event data
uint32_t
offset of opaque data start from start of this struct (e.g sizeof struct sound_trigger_phrase_recognition_event)
pal_st_recognition_config
Members
int32_t
IO handle that will be used for capture.
uint32_t
input device requested for detection capture
bool
capture and buffer audio for this recognition instance
uint32_t
number of key phrases recognition extras
struct pal_st_phrase_recognition_extra
configuration for each key phrase
pal_st_recognition_callback_t
callback for recognition events
uint8_t *
cookie set from client
uint32_t
size of opaque capture configuration data
uint32_t
offset of opaque data start from start of this struct (e.g sizeof struct sound_trigger_recognition_config)
pal_st_phrase_recognition_event
Members
struct pal_st_recognition_event
uint32_t
struct pal_st_phrase_recognition_extra
pal_st_generic_recognition_event
Members
struct pal_st_recognition_event
detection_engine_config_voice_wakeup
Members
uint16_t
uint16_t
uint8_t
uint8_t
uint8_t
uint8_t
detection_engine_config_stage1_pdk
Members
uint16_t
uint16_t
uint32_t
uint32_t
uint32_t
detection_engine_multi_model_buffering_config
Members
uint32_t
uint32_t
uint32_t
ffv_doa_tracking_monitor_t
Members
int16_t
int16_t
int8_t
pal_asr_model
Payload for ID : PAL_PARAM_ID_ASR_MODEL.
Members
struct st_uuid
Unique vendor ID.
int32_t
ASR model.
uint32_t
ASR model size.
pal_asr_config
Payload for ID : PAL_PARAM_ID_ASR_CONFIG.
Members
int32_t
input language code
int32_t
output language code
bool
language detection switch enable/disable flag
bool
translation switch enable/disable flag
bool
continuous mode enable/disable flag
bool
partial transcription switch enable/disable flag
bool
Flag to enable/disable logger mode.
bool
Flag to enable/disable output with timestamp details.
bool
Flag to enable/disable speaker diarization.
uint32_t
Confidence threshold for ASR transcription.
uint32_t
ASR processing timeout, in milliseconds, if silence is not detected after the speech processing is started.
uint32_t
“No speech” duration needed before determining speech has ended (in ms)
bool
Buffer mode enable/disable.
uint32_t
Additional Engine specific custom data size.
uint8_t
custom data offset from the start of this structure
pal_tts_config
Members
uint32_t
consistente enum across ASR, Translation and TTS
uint32_t
Speech output mode.
uint32_t
pal_nmt_config
Members
uint32_t
uint32_t
call_translation_config
Members
bool
pal_call_translation_direction
struct pal_tts_config
Direction for the call_translation usecase.
struct pal_nmt_config
TTS module config.
struct pal_asr_config
NMT module config.
pal_asr_engine_event
Members
bool
Final transcription after end of speech is detected.
uint32_t
Confidence for the entire transcription.
uint32_t
Size of text to sent to the client.
char
Text to be sent to the client.
uint32_t
size of JSON output, to be sent to client
char
JSON result.
uint32_t
event payload size
uint8_t
event payload offset from the start of this structure
pal_asr_event
Payload to be used for callback for ASR event through pal_stream_callback.
Members
pal_asr_event_status_t
uint32_t
struct pal_asr_engine_event
asr_word
Struct to store timestamp details of every word present in ASR’s output text.
Members
uint32_t
Confidence level for the word.
char
Word, whose timestamp details are within the strcut.
uint64_t
Word’s start timestamp.
uint64_t
Word’s end timestamp.
pal_asr_engine_ts_event
Payload to be used to generate callback data for ASR’s timestamp based output.
Members
bool
Final transcription after end of speech is detected.
uint32_t
Confidence for the entire transcription.
uint32_t
Size of text to sent to the client.
char
Text to be sent to the client.
uint64_t
Text’s start timestamp.
uint64_t
Text’s end timestamp.
uint32_t
Number of words present in word array.
struct asr_word
Store timestamp details of every word present in text.
uint32_t
size of JSON output, to be sent to client
char
JSON result.
uint32_t
event payload size
uint8_t
event payload offset from the start of this structure
pal_asr_ts_event
Payload to be used for callback for ASR’s timestamp based event through pal_stream_callback.
Members
pal_asr_event_status_t
uint32_t
struct pal_asr_engine_ts_event
sdz_speaker_info
Payload containing speaker’s information.
Members
uint32_t
uint64_t
uint64_t
sdz_output
Output payload for speaker diarization.
Members
uint32_t
uint32_t
struct sdz_speaker_info
pal_sdz_event
Payload for speaker diarization event.
Members
uint32_t
struct sdz_output
pal_nmt_engine_event
Members
uint32_t
payload is partial output of NMT or complete
uint32_t
Output size of text to sent to the client.
char
Text to be sent to the client.
uint32_t
Input size of text to sent to the client.
char
Text to be sent to the client.
uint32_t
size of JSON output, to be sent to client
char
JSON result.
uint32_t
event payload size
uint8_t
event payload offset from the start of this structure
pal_nmt_event
Members
int32_t
int32_t
int32_t
pal_stream_direction_t
uint32_t
struct pal_nmt_engine_event
pal_callback_config
Members
int32_t
int32_t
pal_device_id_t *
pal_device_id_t *
struct pal_stream_attributes
uint32_t *
pal_compr_gapless_mdata
Members
uint32_t
uint32_t
pal_device_mute_t
Members
pal_stream_direction_t
bool
pal_event_read_write_done_payload
Event payload passed to client with PAL_STREAM_CBK_EVENT_READ_DONE and PAL_STREAM_CBK_EVENT_WRITE_READY events.
Members
uint32_t
tag that was used to read/write this buffer
uint32_t
data buffer status as defined in ar_osal_error.h
uint32_t
meta-data status as defined in ar_osal_error.h
struct pal_buffer
buffer that was passed to pal_stream_read/pal_stream_write
pal_event_dtmf_detect_data
Event payload passed to client with PAL_STREAM_CBK_EVENT_DTMF_DETECTION events.
Members
pal_stream_direction_t
uint32_t
uint32_t
pal_buffer_config
Members
size_t
number of buffers
size_t
This would be the size of each buffer.
size_t
pal_cshm_info
Members
pal_cshm_id_t
pal_cshm_type
int64_t
uint32_t
pal_cshm_msg_payload
Members
pal_cshm_id_t
uint32_t
uint32_t
uint32_t
uint32_t
custom_payload_uc_info_s
Members
pal_stream_type_t
type of stream to apply the payload param
pal_device_id_t
type of device to apply the payload param
uint32_t
sample rate of the stream to apply the payload param
uint32_t
instance id of the stream
bool
set to true to create a dummy stream to send command directly to framework
char *
address
pal_stream_direction_t
direction of stream, used in case of sharedmemory

