---
name: "SDL_SetAudioStreamFormat"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_SetAudioStreamFormat"
---

# SDL\_SetAudioStreamFormat(3)

Change the input and output formats of an audio stream.

## NAME

SDL\_SetAudioStreamFormat - Change the input and output formats of an audio stream.

## HEADER FILE

Defined in SDL3/SDL\_audio.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_SetAudioStreamFormat(SDL\_AudioStream \*stream, const SDL\_AudioSpec \*src\_spec, const SDL\_AudioSpec \*dst\_spec);**

## DESCRIPTION

Future calls to and

**SDL\_GetAudioStreamAvailable**\
  and

**SDL\_GetAudioStreamData**\
  will reflect the new format, and future calls to

**SDL\_PutAudioStreamData**\
  must provide data in the new input formats.

Data that was previously queued in the stream will still be operated on in the format that was current when it was added, which is to say you can put the end of a sound file in one format to a stream, change formats for the next sound file, and start putting that new data while the previous sound file is still queued, and everything will still play back correctly.

If a stream is bound to a device, then the format of the side of the stream bound to a device cannot be changed (src\_spec for recording devices, dst\_spec for playback devices). Attempts to make a change to this side will be ignored, but this will not report an error. The other side's format can be changed.

## FUNCTION PARAMETERS

- *stream*

  the stream the format is being changed.

- *src\_spec*

  the new format of the audio input; if NULL, it is not changed.

- *dst\_spec*

  the new format of the audio output; if NULL, it is not changed.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## 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

**•**(3), [**SDL\_GetAudioStreamFormat**(3)](/SDL_GetAudioStreamFormat/3.md), **•**(3), [**SDL\_SetAudioStreamFrequencyRatio**(3)](/SDL_SetAudioStreamFrequencyRatio/3.md)