---
name: "roar_vs_blocking"
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_blocking"
---

# roar\_vs\_blocking(3)

Change blocking mode of VS object

## NAME

roar\_vs\_blocking - Change blocking mode of VS object

## SYNOPSIS

\#include \<roaraudio.h\>

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

## DESCRIPTION

Changes blocking mode of VS object or ask for the current mode if **val** is set to ROAR\_VS\_ASK.

## PARAMETERS

- **vss**

  The VS object to be altered.

- **val**

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

- **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 blocking mode. On error, -1 is returned.

## EXAMPLES

FIXME

## SEE ALSO

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