[][src]Function aaudio_sys::AAudioStream_getSessionId

pub unsafe extern "C" fn AAudioStream_getSessionId(
    stream: *mut AAudioStream
) -> i32

Passes back the session ID associated with this stream.

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

If AAudioStreamBuilder_setSessionId() was called with SESSION_ID_ALLOCATE then a new session ID should be allocated once when the stream is opened.

If AAudioStreamBuilder_setSessionId() was called with a previously allocated session ID then that value should be returned.

If AAudioStreamBuilder_setSessionId() was not called then this function should return SESSION_ID_NONE.

The sessionID for a stream should not change once the stream has been opened.

Available since API level 28.

Arguments

  • stream - reference provided by AAudioStreamBuilder_openStream()