Symbols

Files

Summary Syntax Arguments Related References

SourceVuESP-IDF Framework and ExamplesESP-IDFi2s_channel_write()

i2s_channel_write() function

I2S write data

Syntax

Show:

Summary

Declaration

Definition

from i2s_common.h:215

esp_err_t i2s_channel_write(i2s_chan_handle_t handle, const void *src, size_t size, size_t *bytes_written, uint32_t timeout_ms);

Implemented in i2s_common.c:1272

Arguments

Argument

Description

handle

I2S channel handler

src

The pointer of sent data buffer

size

Max data buffer length

bytes_written

Byte number that actually be sent, can be NULL if not needed

timeout_ms

Max block time

Return value

- ESP_OK Write successfully - ESP_ERR_INVALID_ARG NULL pointer or this handle is not TX handle - ESP_ERR_TIMEOUT Writing timeout, no writing event received from ISR within ticks_to_wait - ESP_ERR_INVALID_STATE I2S is not ready to write

Notes

Only allowed to be called when the channel state is RUNNING, (i.e., TX channel has been started and is not writing now) but the RUNNING only stands for the software state, it doesn't mean there is no the signal transporting on line.

Examples

i2s_channel_write() is referenced by 6 libraries and example projects:

References

from examples

i2s_channel_write() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle

i2s_channel_write() function

Syntax

Arguments

Return value

Notes

Related Functions

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle