Function SDL_GetAudioStreamInputChannelMap

pub unsafe extern "C" fn SDL_GetAudioStreamInputChannelMap(
    stream: *mut SDL_AudioStream,
    count: *mut i32,
) -> *mut i32
Available on crate feature dep_sdl3 only.
Expand description

Get the current input channel map of an audio stream.

Channel maps are optional; most things do not need them, instead passing data in the order that SDL expects.

Audio streams default to no remapping applied. This is represented by returning NULL, and does not signify an error.

§Parameters

  • stream: the SDL_AudioStream to query.
  • count: On output, set to number of channels in the map. Can be NULL.

§Return value

Returns an array of the current channel mapping, with as many elements as the current output spec’s channels, or NULL if default. This should be freed with SDL_free() when it is no longer needed.

§Thread safety

It is safe to call this function from any thread, as it holds a stream-specific mutex while running.

§Availability

This function is available since SDL 3.2.0.

§See also