2023-08-31 15:30:31 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< meta name = "generator" content = "Doxygen 1.8.5" / >
< title > MCUXpresso SDK API Reference Manual: CS42888 Adapter< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
$(window).load(resizeHeight);
< / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< link href = "customdoxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectlogo" > < img alt = "Logo" src = "fs_logo.gif" / > < / td >
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > MCUXpresso SDK API Reference Manual
2024-03-15 14:23:36 +00:00
  < span id = "projectnumber" > Rev 2.15.000< / span >
2023-08-31 15:30:31 +00:00
< / div >
< div id = "projectbrief" > NXP Semiconductors< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
< script type = "text/javascript" >
var searchBox = new SearchBox("searchBox", "search",false,'Search');
< / script >
< div id = "navrow1" class = "tabs" >
< ul class = "tablist" >
< li > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
< li > < a href = "pages.html" > < span > Related  Pages< / span > < / a > < / li >
< li > < a href = "modules.html" > < span > API  Reference< / span > < / a > < / li >
< li >
< div id = "MSearchBox" class = "MSearchBoxInactive" >
< span class = "left" >
< img id = "MSearchSelect" src = "search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
< input type = "text" id = "MSearchField" value = "Search" accesskey = "S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
< / span > < span class = "right" >
< a id = "MSearchClose" href = "javascript:searchBox.CloseResultsWindow()" > < img id = "MSearchCloseImg" border = "0" src = "search/close.png" alt = "" / > < / a >
< / span >
< / div >
< / li >
< / ul >
< / div >
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
$(document).ready(function(){initNavTree('a00288.html','');});
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(0)" > < span class = "SelectionMark" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Data Structures< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Typedefs< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / span > Pages< / a > < / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#define-members" > Macros< / a > |
< a href = "#func-members" > Functions< / a > < / div >
< div class = "headertitle" >
< div class = "title" > CS42888 Adapter< div class = "ingroups" > < a class = "el" href = "a00014.html" > CODEC Common Driver< / a > < / div > < / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< a name = "details" id = "details" > < / a > < h2 class = "groupheader" > Overview< / h2 >
< p > The cs42888 adapter provides a codec unify control interface. < / p >
< table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "define-members" > < / a >
Macros< / h2 > < / td > < / tr >
< tr class = "memitem:ga6e1a98c1da1cf3d4e216e0cd88275e42" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "anchor" id = "ga6e1a98c1da1cf3d4e216e0cd88275e42" > < / a >
#define  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga6e1a98c1da1cf3d4e216e0cd88275e42" > HAL_CODEC_CS42888_HANDLER_SIZE< / a >       (< a class = "el" href = "a00016.html#ga953230c47c19e6eb63913ae2b64e1ae5" > CS42888_I2C_HANDLER_SIZE< / a > + 4)< / td > < / tr >
< tr class = "memdesc:ga6e1a98c1da1cf3d4e216e0cd88275e42" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec handler size < br / > < / td > < / tr >
< tr class = "separator:ga6e1a98c1da1cf3d4e216e0cd88275e42" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table > < table class = "memberdecls" >
< tr class = "heading" > < td colspan = "2" > < h2 class = "groupheader" > < a name = "func-members" > < / a >
Functions< / h2 > < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga6322a862a0ec9af4c568967bab1050ae" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga6322a862a0ec9af4c568967bab1050ae" > HAL_CODEC_CS42888_Init< / a > (void *handle, void *config)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga6322a862a0ec9af4c568967bab1050ae" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Codec initilization. < a href = "#ga6322a862a0ec9af4c568967bab1050ae" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga6322a862a0ec9af4c568967bab1050ae" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga8b695d26d408770842cc1db1a890de08" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga8b695d26d408770842cc1db1a890de08" > HAL_CODEC_CS42888_Deinit< / a > (void *handle)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga8b695d26d408770842cc1db1a890de08" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Codec de-initilization. < a href = "#ga8b695d26d408770842cc1db1a890de08" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga8b695d26d408770842cc1db1a890de08" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga55278264c196bcf67adaec5c4e887c01" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga55278264c196bcf67adaec5c4e887c01" > HAL_CODEC_CS42888_SetFormat< / a > (void *handle, uint32_t mclk, uint32_t sampleRate, uint32_t bitWidth)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga55278264c196bcf67adaec5c4e887c01" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio data format. < a href = "#ga55278264c196bcf67adaec5c4e887c01" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga55278264c196bcf67adaec5c4e887c01" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga45e63cee64d7102825364b48e2a17178" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga45e63cee64d7102825364b48e2a17178" > HAL_CODEC_CS42888_SetVolume< / a > (void *handle, uint32_t playChannel, uint32_t volume)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga45e63cee64d7102825364b48e2a17178" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio codec module volume. < a href = "#ga45e63cee64d7102825364b48e2a17178" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga45e63cee64d7102825364b48e2a17178" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga4696410df0b0cd8c88b50882bfbb546b" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga4696410df0b0cd8c88b50882bfbb546b" > HAL_CODEC_CS42888_SetMute< / a > (void *handle, uint32_t playChannel, bool isMute)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga4696410df0b0cd8c88b50882bfbb546b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio codec module mute. < a href = "#ga4696410df0b0cd8c88b50882bfbb546b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga4696410df0b0cd8c88b50882bfbb546b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gaa2fc2e8795723a17bd1411adcd389736" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gaa2fc2e8795723a17bd1411adcd389736" > HAL_CODEC_CS42888_SetPower< / a > (void *handle, uint32_t module, bool powerOn)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gaa2fc2e8795723a17bd1411adcd389736" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio codec module power. < a href = "#gaa2fc2e8795723a17bd1411adcd389736" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaa2fc2e8795723a17bd1411adcd389736" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gac4169264637d0977800168f8328a1d2e" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gac4169264637d0977800168f8328a1d2e" > HAL_CODEC_CS42888_SetRecord< / a > (void *handle, uint32_t recordSource)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gac4169264637d0977800168f8328a1d2e" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec set record source. < a href = "#gac4169264637d0977800168f8328a1d2e" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gac4169264637d0977800168f8328a1d2e" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga047461f10f6439bbaab7a3d1b32c7d89" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga047461f10f6439bbaab7a3d1b32c7d89" > HAL_CODEC_CS42888_SetRecordChannel< / a > (void *handle, uint32_t leftRecordChannel, uint32_t rightRecordChannel)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga047461f10f6439bbaab7a3d1b32c7d89" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec set record channel. < a href = "#ga047461f10f6439bbaab7a3d1b32c7d89" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga047461f10f6439bbaab7a3d1b32c7d89" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga786ee3e35b7aaace2bc0223579c43d1d" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga786ee3e35b7aaace2bc0223579c43d1d" > HAL_CODEC_CS42888_SetPlay< / a > (void *handle, uint32_t playSource)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga786ee3e35b7aaace2bc0223579c43d1d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec set play source. < a href = "#ga786ee3e35b7aaace2bc0223579c43d1d" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga786ee3e35b7aaace2bc0223579c43d1d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga942a8ccfeaa7e26824def528a9564a29" > < td class = "memItemLeft" align = "right" valign = "top" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga942a8ccfeaa7e26824def528a9564a29" > HAL_CODEC_CS42888_ModuleControl< / a > (void *handle, uint32_t cmd, uint32_t data)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga942a8ccfeaa7e26824def528a9564a29" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec module control. < a href = "#ga942a8ccfeaa7e26824def528a9564a29" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga942a8ccfeaa7e26824def528a9564a29" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gafe47075da9b829e30e618a86ac2cc9c6" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gafe47075da9b829e30e618a86ac2cc9c6" > HAL_CODEC_Init< / a > (void *handle, void *config)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gafe47075da9b829e30e618a86ac2cc9c6" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Codec initilization. < a href = "#gafe47075da9b829e30e618a86ac2cc9c6" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gafe47075da9b829e30e618a86ac2cc9c6" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga6728d97d2c909d8bff9fee477b0cd9e9" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga6728d97d2c909d8bff9fee477b0cd9e9" > HAL_CODEC_Deinit< / a > (void *handle)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga6728d97d2c909d8bff9fee477b0cd9e9" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > Codec de-initilization. < a href = "#ga6728d97d2c909d8bff9fee477b0cd9e9" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga6728d97d2c909d8bff9fee477b0cd9e9" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gaaf073d16e55b2da18b4b801acd03454b" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gaaf073d16e55b2da18b4b801acd03454b" > HAL_CODEC_SetFormat< / a > (void *handle, uint32_t mclk, uint32_t sampleRate, uint32_t bitWidth)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gaaf073d16e55b2da18b4b801acd03454b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio data format. < a href = "#gaaf073d16e55b2da18b4b801acd03454b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gaaf073d16e55b2da18b4b801acd03454b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga17769c66cf7b5c0f01041e7f36f4c89c" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga17769c66cf7b5c0f01041e7f36f4c89c" > HAL_CODEC_SetVolume< / a > (void *handle, uint32_t playChannel, uint32_t volume)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga17769c66cf7b5c0f01041e7f36f4c89c" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio codec module volume. < a href = "#ga17769c66cf7b5c0f01041e7f36f4c89c" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga17769c66cf7b5c0f01041e7f36f4c89c" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga6e3171b042e6150ac410abced6123feb" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga6e3171b042e6150ac410abced6123feb" > HAL_CODEC_SetMute< / a > (void *handle, uint32_t playChannel, bool isMute)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga6e3171b042e6150ac410abced6123feb" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio codec module mute. < a href = "#ga6e3171b042e6150ac410abced6123feb" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga6e3171b042e6150ac410abced6123feb" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gad630677f451ca311d9f149d34da70637" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gad630677f451ca311d9f149d34da70637" > HAL_CODEC_SetPower< / a > (void *handle, uint32_t module, bool powerOn)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gad630677f451ca311d9f149d34da70637" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > set audio codec module power. < a href = "#gad630677f451ca311d9f149d34da70637" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gad630677f451ca311d9f149d34da70637" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga78612feccab62150fb8ee1ef9eb4b6ed" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga78612feccab62150fb8ee1ef9eb4b6ed" > HAL_CODEC_SetRecord< / a > (void *handle, uint32_t recordSource)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga78612feccab62150fb8ee1ef9eb4b6ed" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec set record source. < a href = "#ga78612feccab62150fb8ee1ef9eb4b6ed" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga78612feccab62150fb8ee1ef9eb4b6ed" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gad96c5638cbc67a85bfdb44aa1eee435b" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gad96c5638cbc67a85bfdb44aa1eee435b" > HAL_CODEC_SetRecordChannel< / a > (void *handle, uint32_t leftRecordChannel, uint32_t rightRecordChannel)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gad96c5638cbc67a85bfdb44aa1eee435b" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec set record channel. < a href = "#gad96c5638cbc67a85bfdb44aa1eee435b" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gad96c5638cbc67a85bfdb44aa1eee435b" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:ga10228c6005d118872915a0412c466a7d" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#ga10228c6005d118872915a0412c466a7d" > HAL_CODEC_SetPlay< / a > (void *handle, uint32_t playSource)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:ga10228c6005d118872915a0412c466a7d" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec set play source. < a href = "#ga10228c6005d118872915a0412c466a7d" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:ga10228c6005d118872915a0412c466a7d" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
2024-03-15 14:23:36 +00:00
< tr class = "memitem:gab2e790a1ed09bc9a6b910d94180e5bd4" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "a00288.html#gab2e790a1ed09bc9a6b910d94180e5bd4" > HAL_CODEC_ModuleControl< / a > (void *handle, uint32_t cmd, uint32_t data)< / td > < / tr >
2023-08-31 15:30:31 +00:00
< tr class = "memdesc:gab2e790a1ed09bc9a6b910d94180e5bd4" > < td class = "mdescLeft" >   < / td > < td class = "mdescRight" > codec module control. < a href = "#gab2e790a1ed09bc9a6b910d94180e5bd4" > More...< / a > < br / > < / td > < / tr >
< tr class = "separator:gab2e790a1ed09bc9a6b910d94180e5bd4" > < td class = "memSeparator" colspan = "2" >   < / td > < / tr >
< / table >
< h2 class = "groupheader" > Function Documentation< / h2 >
< a class = "anchor" id = "ga6322a862a0ec9af4c568967bab1050ae" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_Init < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > config< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > config< / td > < td > codec configuration. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else initial failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga8b695d26d408770842cc1db1a890de08" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_Deinit < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else de-initial failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga55278264c196bcf67adaec5c4e887c01" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetFormat < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > mclk< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > sampleRate< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > bitWidth< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > mclk< / td > < td > master clock frequency in HZ. < / td > < / tr >
< tr > < td class = "paramname" > sampleRate< / td > < td > sample rate in HZ. < / td > < / tr >
< tr > < td class = "paramname" > bitWidth< / td > < td > bit width. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga45e63cee64d7102825364b48e2a17178" > < / a >
< div class = "memitem" >
< div class="memproto">
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetVolume < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playChannel< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > volume< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > playChannel< / td > < td > audio codec play channel, can be a value or combine value of _codec_play_channel. < / td > < / tr >
< tr > < td class = "paramname" > volume< / td > < td > volume value, support 0 ~ 100, 0 is mute, 100 is the maximum volume value. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga4696410df0b0cd8c88b50882bfbb546b" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetMute < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playChannel< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > isMute< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > playChannel< / td > < td > audio codec play channel, can be a value or combine value of _codec_play_channel. < / td > < / tr >
< tr > < td class = "paramname" > isMute< / td > < td > true is mute, false is unmute. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gaa2fc2e8795723a17bd1411adcd389736" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetPower < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > module< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > powerOn< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > audio codec module. < / td > < / tr >
< tr > < td class = "paramname" > powerOn< / td > < td > true is power on, false is power down. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gac4169264637d0977800168f8328a1d2e" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetRecord < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > recordSource< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > recordSource< / td > < td > audio codec record source, can be a value or combine value of _codec_record_source.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga047461f10f6439bbaab7a3d1b32c7d89" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetRecordChannel < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > leftRecordChannel< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > rightRecordChannel< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > leftRecordChannel< / td > < td > audio codec record channel, reference _codec_record_channel, can be a value or combine value of member in _codec_record_channel. < / td > < / tr >
< tr > < td class = "paramname" > rightRecordChannel< / td > < td > audio codec record channel, reference _codec_record_channel, can be a value combine of member in _codec_record_channel.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga786ee3e35b7aaace2bc0223579c43d1d" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_SetPlay < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playSource< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > playSource< / td > < td > audio codec play source, can be a value or combine value of _codec_play_source.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga942a8ccfeaa7e26824def528a9564a29" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_CS42888_ModuleControl < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > cmd< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > data< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > This function is used for codec module control, support switch digital interface cmd, can be expand to support codec module specific feature< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > cmd< / td > < td > module control cmd, reference _codec_module_ctrl_cmd. < / td > < / tr >
< tr > < td class = "paramname" > data< / td > < td > value to write, when cmd is kCODEC_ModuleRecordSourceChannel, the data should be a value combine of channel and source, please reference macro CODEC_MODULE_RECORD_SOURCE_CHANNEL(source, LP, LN, RP, RN), reference codec specific driver for detail configurations. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gafe47075da9b829e30e618a86ac2cc9c6" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_Init < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > config< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > config< / td > < td > codec configuration. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else initial failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga6728d97d2c909d8bff9fee477b0cd9e9" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_Deinit < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > < / td > < td > )< / td >
< td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else de-initial failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gaaf073d16e55b2da18b4b801acd03454b" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetFormat < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > mclk< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > sampleRate< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > bitWidth< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > mclk< / td > < td > master clock frequency in HZ. < / td > < / tr >
< tr > < td class = "paramname" > sampleRate< / td > < td > sample rate in HZ. < / td > < / tr >
< tr > < td class = "paramname" > bitWidth< / td > < td > bit width. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga17769c66cf7b5c0f01041e7f36f4c89c" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetVolume < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playChannel< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > volume< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > playChannel< / td > < td > audio codec play channel, can be a value or combine value of _codec_play_channel. < / td > < / tr >
< tr > < td class = "paramname" > volume< / td > < td > volume value, support 0 ~ 100, 0 is mute, 100 is the maximum volume value. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga6e3171b042e6150ac410abced6123feb" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetMute < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playChannel< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > isMute< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > playChannel< / td > < td > audio codec play channel, can be a value or combine value of _codec_play_channel. < / td > < / tr >
< tr > < td class = "paramname" > isMute< / td > < td > true is mute, false is unmute. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gad630677f451ca311d9f149d34da70637" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetPower < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > module< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > bool  < / td >
< td class = "paramname" > < em > powerOn< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > module< / td > < td > audio codec module. < / td > < / tr >
< tr > < td class = "paramname" > powerOn< / td > < td > true is power on, false is power down. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga78612feccab62150fb8ee1ef9eb4b6ed" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetRecord < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > recordSource< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > recordSource< / td > < td > audio codec record source, can be a value or combine value of _codec_record_source.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gad96c5638cbc67a85bfdb44aa1eee435b" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetRecordChannel < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > leftRecordChannel< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > rightRecordChannel< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > leftRecordChannel< / td > < td > audio codec record channel, reference _codec_record_channel, can be a value or combine value of member in _codec_record_channel. < / td > < / tr >
< tr > < td class = "paramname" > rightRecordChannel< / td > < td > audio codec record channel, reference _codec_record_channel, can be a value combine of member in _codec_record_channel.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "ga10228c6005d118872915a0412c466a7d" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_SetPlay < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > playSource< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > playSource< / td > < td > audio codec play source, can be a value or combine value of _codec_play_source.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< a class = "anchor" id = "gab2e790a1ed09bc9a6b910d94180e5bd4" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "mlabels" >
< tr >
< td class = "mlabels-left" >
< table class = "memname" >
< tr >
2024-03-15 14:23:36 +00:00
< td class = "memname" > static < a class = "el" href = "a00260.html#gaaabdaf7ee58ca7269bd4bf24efcde092" > status_t< / a > HAL_CODEC_ModuleControl < / td >
2023-08-31 15:30:31 +00:00
< td > (< / td >
< td class = "paramtype" > void *  < / td >
< td class = "paramname" > < em > handle< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > cmd< / em > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > data< / em >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < / td >
< / tr >
< / table >
< / td >
< td class = "mlabels-right" >
< span class = "mlabels" > < span class = "mlabel" > inline< / span > < span class = "mlabel" > static< / span > < / span > < / td >
< / tr >
< / table >
< / div > < div class = "memdoc" >
< p > This function is used for codec module control, support switch digital interface cmd, can be expand to support codec module specific feature< / p >
< dl class = "params" > < dt > Parameters< / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > handle< / td > < td > codec handle. < / td > < / tr >
< tr > < td class = "paramname" > cmd< / td > < td > module control cmd, reference _codec_module_ctrl_cmd. < / td > < / tr >
< tr > < td class = "paramname" > data< / td > < td > value to write, when cmd is kCODEC_ModuleRecordSourceChannel, the data should be a value combine of channel and source, please reference macro CODEC_MODULE_RECORD_SOURCE_CHANNEL(source, LP, LN, RP, RN), reference codec specific driver for detail configurations. < / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns< / dt > < dd > kStatus_Success is success, else configure failed. < / dd > < / dl >
< / div >
< / div >
< / div > <!-- contents -->
< / div > <!-- doc - content -->
<!-- HTML footer for doxygen 1.8.5 -->
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul class = "foot" >
< li class = "footer" > © 2016 NXP Semiconductors. All rights reserved.
< / li >
< / ul >
< / div >
< / body >
< / html >