1.1.3.7.2 DRV_GENERICCODEC_LRCLK_Sync Function

uint32_t DRV_GENERICCODEC_LRCLK_Sync (const DRV_HANDLE handle);

Summary

Synchronize to the start of the I2S LRCLK (left/right clock) signal

Description

This function waits until low-to high transition of the I2S LRCLK (left/right clock) signal (high-low if Left-Justified format, this is determined by the PLIB). In the case where this signal is generated from a codec or other external source, this allows the caller to synchronize calls to the DMA with the LRCLK signal so the left/right channel association is valid.

Preconditions

None.

Parameters

Returns

True - if the function was successful.

False - if a timeout occurred (no transitions seen).

Remarks

None.

Example

_// myGENERICCODECHandle is the handle returned_ _// by the DRV_GENERICCODEC_Open function._

DRV_GENERICCODEC_LRCLK_Sync(myGENERICCODECHandle);

C

bool DRV_GENERICCODEC_LRCLK_Sync(const DRV_HANDLE handle);