Skip to main content

odin_audio_set_stream_delay

Sets the delay estimate for the reverse stream used in the ODIN echo cancellation. This function is important in scenarios where the audio output and the audio input are not synchronized. An accurate delay value ensures that the echo canceller can correctly align the two audio streams, resulting in effective echo cancellation.

Improper delay values may lead to poor echo cancellation and thus degrade the quality of the audio communication.

Declaration
OdinReturnCode odin_audio_set_stream_delay(OdinRoomHandle room, uint64_t delay_ms);

Parameters​

room​

Handle of the room to which the streams belong. See

OdinRoomHandle

for more information.

Declaration
OdinRoomHandle room;

delay_ms​

The delay estimate in milliseconds. This value should be set to the estimated delay between the audio output and the audio input. The delay estimate should be as accurate as possible to ensure effective echo cancellation.

Declaration
uint64_t delay_ms;

Returns​

A return code indicating success or failure.

Return Type
OdinReturnCode