AAudioStreamBuilder_setSessionId

aaudio_sys

Function AAudioStreamBuilder_setSessionId 

Source 
pub unsafe extern "C" fn AAudioStreamBuilder_setSessionId(
    builder: *mut AAudioStreamBuilder,
    session_id: i32,
)
Expand description

The session ID can be used to associate a stream with effects processors. The effects are controlled using the Android AudioEffect Java API.

The default, if you do not call this function, is SESSION_ID_NONE.

If set to SESSION_ID_ALLOCATE then a session ID will be allocated when the stream is opened.

The allocated session ID can be obtained by calling AAudioStream_getSessionId() and then used with this function when opening another stream. This allows effects to be shared between streams.

Session IDs from AAudio can be used with the Android Java APIs and vice versa. So a session ID from an AAudio stream can be passed to Java and effects applied using the Java AudioEffect API.

Note that allocating or setting a session ID may result in a stream with higher latency.

Allocated session IDs will always be positive and nonzero.

Available since API level 28.

ยงArguments

  • builder - reference provided by AAudio_createStreamBuilder()
  • session_id - an allocated sessionID or SESSION_ID_ALLOCATE