---
name: "roar_vs_pause"
section: "3"
platform: "linux"
package: "libroar-dev"
version: "1.0~beta12-4"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/roar_vs_pause"
---

# roar\_vs\_pause(3)

Alter stream flags

## NAME

roar\_vs\_pause, roar\_vs\_mute - Alter stream flags

## SYNOPSIS

\#include \<roaraudio.h\>

int     roar\_vs\_pause(roar\_vs\_t \* vss, int val, int \* error);

int     roar\_vs\_mute (roar\_vs\_t \* vss, int val, int \* error);

## DESCRIPTION

roar\_vs\_pause() and roar\_vs\_mute() alters the stream flags PAUSE and MUTE, respectively.

## PARAMETERS

- **vss**

  The VS object pointing to the stream which flags should be altered.

- **val**

  Specifies the new state. Value must be ROAR\_VS\_TRUE, ROAR\_VS\_FALSE, ROAR\_VS\_TOGGLE or ROAR\_VS\_ASK.

- **error**

  This is a pointer to a integer used to store the error value in case of error. This can be NULL if not used but it is very recommended to use this error value to report good error messages to the user.

## RETURN VALUE

On success these calls return the old (current if ROAR\_VS\_ASK is used) state of the stream flag. On error, -1 is returned.

## EXAMPLES

FIXME

## SEE ALSO

[**roarvs**(7)](/roarvs/7.md), [**libroar**(7)](/libroar/7.md), [**RoarAudio**(7)](/RoarAudio/7.md).