Developer World
Spresense SDK v1.3.1
Files
Audio Command ID
Collaboration diagram for Audio Command ID:

Files

file  audio_command_id.h
 CXD5602 Audio Command ID.
 

Command Category code

#define AUDCMD_CATEGORY_GENERAL   0x00
 
#define AUDCMD_CATEGORY_EFFECTOR   0x10
 
#define AUDCMD_CATEGORY_PLAYER   0x20
 
#define AUDCMD_CATEGORY_RECORDER   0x30
 
#define AUDCMD_CATEGORY_RECOGNITION   0x40
 
#define AUDCMD_CATEGORY_BASEBAND   0x50
 
#define AUDCMD_CATEGORY_THROUGH   0x60
 
#define AUDCMD_CATEGORY_TRANSITION   0x70
 
#define AUDCMD_CATEGORY_ERRNOTIFY   0xF0
 

Command General Function code

#define AUDCMD_GETSTATUS   (AUDCMD_CATEGORY_GENERAL | 0x01)
 Command Code: GetStatus.
 
#define AUDCMD_INITATTENTIONS   (AUDCMD_CATEGORY_GENERAL | 0x02)
 Command Code: InitAttentions.
 

General Result code

#define AUDRLT_NOTIFYSTATUS   AUDCMD_GETSTATUS
 Result Code: NotifyStatus.
 
#define AUDRLT_INITATTENTIONSCMPLT   AUDCMD_INITATTENTIONS
 Result Code: InitAttentions.
 

Command Effector Function code

#define AUDCMD_SETMFETYPE   (AUDCMD_CATEGORY_EFFECTOR | 0x01)
 Command Code: EnablePreProc.
 
#define AUDCMD_INITMFE   (AUDCMD_CATEGORY_EFFECTOR | 0x02)
 Command Code: InitMFE.
 
#define AUDCMD_SETMFE   (AUDCMD_CATEGORY_EFFECTOR | 0x03)
 Command Code: SetMFE.
 
#define AUDCMD_INITMPP   (AUDCMD_CATEGORY_EFFECTOR | 0x04)
 Command Code: InitMPP.
 
#define AUDCMD_SETMPPPARAM   (AUDCMD_CATEGORY_EFFECTOR | 0x05)
 Command Code: SetMPPParam.
 

Effector Result code

#define AUDRLT_ENPREPROCCMPLT   AUDCMD_SETMFETYPE
 Result Code: EnableProProcessCmplt.
 
#define AUDRLT_INITMFECMPLT   AUDCMD_INITMFE
 Result Code: InitMFECmplt.
 
#define AUDRLT_SETMFECMPLT   AUDCMD_SETMFE
 Result Code: SetMFECmplt.
 
#define AUDRLT_INITMPPCMPLT   AUDCMD_INITMPP
 Result Code: InitMPPCmplt.
 
#define AUDRLT_SETMPPCMPLT   AUDCMD_SETMPPPARAM
 Result Code: SetMPPParamCmplt.
 

Command Player Function code

#define AUDCMD_INITPLAYER   (AUDCMD_CATEGORY_PLAYER | 0x01)
 Command Code: InitPlayer.
 
#define AUDCMD_PLAYPLAYER   (AUDCMD_CATEGORY_PLAYER | 0x02)
 Command Code: PlayPlayer.
 
#define AUDCMD_STOPPLAYER   (AUDCMD_CATEGORY_PLAYER | 0x03)
 Command Code: StopPlayer.
 
#define AUDCMD_CLKRECOVERY   (AUDCMD_CATEGORY_PLAYER | 0x04)
 Command Code: ClkRecovery.
 
#define AUDCMD_SETGAIN   (AUDCMD_CATEGORY_PLAYER | 0x05)
 Command Code: SetGain.
 

Player Result code

#define AUDRLT_INITPLAYERCMPLT   AUDCMD_INITPLAYER
 Result Code: InitPlayCmplt.
 
#define AUDRLT_PLAYCMPLT   AUDCMD_PLAYPLAYER
 Result Code: PlayCmplt.
 
#define AUDRLT_STOPCMPLT   AUDCMD_STOPPLAYER
 Result Code: StopPlayCmplt.
 
#define AUDRLT_CLKRECOVERY_CMPLT   AUDCMD_CLKRECOVERY
 Result Code: ClkRecoveryComplete.
 
#define AUDRLT_SETGAIN_CMPLT   AUDCMD_SETGAIN
 Result Code: SetGainComplete.
 
#define AUDRLT_SENDPFCMD_CMPLT   AUDCMD_SENDPOSTCMD
 Result Code: SendPfCommandComplete.
 

Command Recorder Function code

#define AUDCMD_INITREC   (AUDCMD_CATEGORY_RECORDER | 0x01)
 Command Code: InitRecorder.
 
#define AUDCMD_STARTREC   (AUDCMD_CATEGORY_RECORDER | 0x02)
 Command Code: StartRec.
 
#define AUDCMD_STOPREC   (AUDCMD_CATEGORY_RECORDER | 0x03)
 Command Code: StopRec.
 

Recoder Result code

#define AUDRLT_RECCMPLT   AUDCMD_STARTREC
 Result Code: RecCmplt.
 
#define AUDRLT_STOPRECCMPLT   AUDCMD_STOPREC
 Result Code: StopRecCmplt.
 
#define AUDRLT_INITRECCMPLT   AUDCMD_INITREC
 Result Code: InitRecCmplt.
 

Command Recognition Function code

#define AUDCMD_STARTVOICECOMMAND   (AUDCMD_CATEGORY_RECOGNITION | 0x01)
 Command Code: StartVoiceCommand (not supported)
 
#define AUDCMD_STOPVOICECOMMAND   (AUDCMD_CATEGORY_RECOGNITION | 0x02)
 Command Code: StopVoiceCommand (not supported)
 

Result code

#define AUDRLT_STARTVOICECOMMANDCMPLT   AUDCMD_STARTVOICECOMMAND
 Result Code: StartVoiceCommandCmplt (not supported)
 
#define AUDRLT_STOPVOICECOMMANDCMPLT   AUDCMD_STOPVOICECOMMAND
 Result Code: StopVoiceCommandCmplt (not supported)
 

Command Baseband Function code

#define AUDCMD_STARTBB   (AUDCMD_CATEGORY_BASEBAND | 0x01)
 Command Code: StartBB (not supported)
 
#define AUDCMD_STOPBB   (AUDCMD_CATEGORY_BASEBAND | 0x02)
 Command Code: StopBB (not supported)
 
#define AUDCMD_INITMICGAIN   (AUDCMD_CATEGORY_BASEBAND | 0x03)
 Command Code: InitMicGain.
 
#define AUDCMD_INITI2SPARAM   (AUDCMD_CATEGORY_BASEBAND | 0x04)
 Command Code: InitI2SParam (not supported)
 
#define AUDCMD_INITDEQPARAM   (AUDCMD_CATEGORY_BASEBAND | 0x05)
 Command Code: InitDEQParam (not supported)
 
#define AUDCMD_INITOUTPUTSELECT   (AUDCMD_CATEGORY_BASEBAND | 0x06)
 Command Code: InitOutputSelect.
 
#define AUDCMD_INITDNCPARAM   (AUDCMD_CATEGORY_BASEBAND | 0x07)
 Command Code: InitDNCParam (not supported)
 
#define AUDCMD_INITCLEARSTEREO   (AUDCMD_CATEGORY_BASEBAND | 0x08)
 Command Code: InitClearStereo (not supported)
 
#define AUDCMD_SETVOLUME   (AUDCMD_CATEGORY_BASEBAND | 0x09)
 Command Code: SetVolume.
 
#define AUDCMD_SETVOLUMEMUTE   (AUDCMD_CATEGORY_BASEBAND | 0x0a)
 Command Code: SetVolumeMute.
 
#define AUDCMD_SETBEEPPARAM   (AUDCMD_CATEGORY_BASEBAND | 0x0b)
 Command Code: SetBeep.
 
#define AUDCMD_SETRENDERINGCLK   (AUDCMD_CATEGORY_BASEBAND | 0x0c)
 Command Code: SetRenderingClk.
 
#define AUDCMD_SETSPDRVMODE   (AUDCMD_CATEGORY_BASEBAND | 0x0d)
 Command Code: SetSpDrvMode.
 
#define AUDCMD_SETMICMAP   (AUDCMD_CATEGORY_BASEBAND | 0x0e)
 Command Code: SetMicMap.
 

Baseband Result code

#define AUDRLT_STARTBBCMPLT   AUDCMD_STARTBB
 Result Code: StartBBCmplt (not supported)
 
#define AUDRLT_STOPBBCMPLT   AUDCMD_STOPBB
 Result Code: StopBBCmplt (not supported)
 
#define AUDRLT_INITMICGAINCMPLT   AUDCMD_INITMICGAIN
 Result Code: InitMicGainCmplt.
 
#define AUDRLT_SETMICMAPCMPLT   AUDCMD_SETMICMAP
 Result Code: InitMicGainCmplt.
 
#define AUDRLT_INITI2SPARAMCMPLT   AUDCMD_INITI2SPARAM
 Result Code: InitI2SCmplt (not supported)
 
#define AUDRLT_INITDEQPARAMCMPLT   AUDCMD_INITDEQPARAM
 Result Code: InitDEQCmplt (not supported)
 
#define AUDRLT_INITOUTPUTSELECTCMPLT   AUDCMD_INITOUTPUTSELECT
 Result Code: InitOutputSelectCmplt.
 
#define AUDRLT_INITDNCPARAMCMPLT   AUDCMD_INITDNCPARAM
 Result Code: InitDNCCmplt (not supported)
 
#define AUDRLT_INITCLEARSTEREOCMPLT   AUDCMD_INITCLEARSTEREO
 Result Code: InitClearStereoCmplt (not supported)
 
#define AUDRLT_SETVOLUMECMPLT   AUDCMD_SETVOLUME
 Result Code: SetVolumeCmplt.
 
#define AUDRLT_SETVOLUMEMUTECMPLT   AUDCMD_SETVOLUMEMUTE
 Result Code: SetVolumeMuteCmplt.
 
#define AUDRLT_SETBEEPCMPLT   AUDCMD_SETBEEPPARAM
 Result Code: SetBeepCmplt.
 
#define AUDRLT_SETRENDERINGCLKCMPLT   AUDCMD_SETRENDERINGCLK
 Result Code: SetRenderingClkCmplt.
 
#define AUDRLT_SETSPDRVMODECMPLT   AUDCMD_SETSPDRVMODE
 Result Code: SetSpDrvModeCmplt.
 

Command Through Function code

#define AUDCMD_SETTHROUGHPATH   (AUDCMD_CATEGORY_THROUGH | 0x01)
 Command Code: SetThroughPath.
 

Through Result code

#define AUDRLT_SETTHROUGHPATHCMPLT   AUDCMD_SETTHROUGHPATH
 Result Code: SetThroughPathCmplt.
 

Command Transition Function code

#define AUDCMD_POWERON   (AUDCMD_CATEGORY_TRANSITION | 0x01)
 Command Code: PowerOn.
 
#define AUDCMD_SETPOWEROFFSTATUS   (AUDCMD_CATEGORY_TRANSITION | 0x02)
 Command Code: SetPowerOffStatus.
 
#define AUDCMD_SETBASEBANDSTATUS   (AUDCMD_CATEGORY_TRANSITION | 0x03)
 Command Code: SetBaseBandStatus (not supported)
 
#define AUDCMD_SETPLAYERSTATUS   (AUDCMD_CATEGORY_TRANSITION | 0x04)
 Command Code: SetPlayerStatus.
 
#define AUDCMD_SETRECORDERSTATUS   (AUDCMD_CATEGORY_TRANSITION | 0x05)
 Command Code: SetRecorderStatus.
 
#define AUDCMD_SETREADYSTATUS   (AUDCMD_CATEGORY_TRANSITION | 0x06)
 Command Code: SetReadyStartus.
 
#define AUDCMD_SETTHROUGHSTATUS   (AUDCMD_CATEGORY_TRANSITION | 0x07)
 Command Code: SetThroughStartus.
 
#define AUDCMD_SETPLAYERSTATUSPOST   (AUDCMD_CATEGORY_TRANSITION | 0x08)
 Command Code: SetPlayerStatus.
 

Transition Result code

#define AUDRLT_STATUSCHANGED   (AUDCMD_CATEGORY_TRANSITION | 0x0f)
 Result Code: StatusChanged.
 

Error Notification code

#define AUDRLT_ERRORRESPONSE   (AUDCMD_CATEGORY_ERRNOTIFY | 0x01)
 Result Code: ErrorResponse.
 
#define AUDRLT_ERRORATTENTION   (AUDCMD_CATEGORY_ERRNOTIFY | 0x02)
 Result Code: ErrorAttention.
 

Detailed Description