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

# roarvs(7)

RoarAudio sound library roarvs - RoarAudio very simple API

## NAME

libroar - RoarAudio sound library

roarvs - RoarAudio very simple API

## SYNOPSIS

 \#include \<roaraudio.h\>

 roar\_vs\_t \* vss;

## DESCRIPTION

The VS (for Very Simple) API is a high level abstraction layer used to allow use of RoarAudio from very simple programs. The API was designed to help people to easly upgrade existing artsc and pulse-simple code to RoarAudio. While the API is equivalently simple it is much more powerful than one one by aRtsc or PulseAudio.

The VS API also has a mode to play back (and record) files easly. As this uses VIO/DSTR it can handle streams as well.

## TUTORIALS

Tutorials can be found in [**roartut**(7)](/roartut/7.md).

## IMPORTANT FUNCTIONS

There are several important functions. This is a small list of the most important ones.

- **Error handling**

  [**roar\_vs\_strerr**(3)](/roar_vs_strerr/3.md)

- **Opening**

  [**roar\_vs\_new**(3)](/roar_vs_new/3.md), [**roar\_vs\_new\_simple**(3)](/roar_vs_new_simple/3.md), [**roar\_vs\_new\_playback**(3)](/roar_vs_new_playback/3.md), [**roar\_vs\_new\_from\_file**(3)](/roar_vs_new_from_file/3.md)

- **Closing**

  [**roar\_vs\_close**(3)](/roar_vs_close/3.md)

- **Reading and writing**

  [**roar\_vs\_read**(3)](/roar_vs_read/3.md), [**roar\_vs\_write**(3)](/roar_vs_write/3.md)

- **Non-Blocking and Asyncron IO**

  [**roar\_vs\_blocking**(3)](/roar_vs_blocking/3.md), **roar\_vio\_select**(3)

- **Volume and Flags**

  [**roar\_vs\_pause**(3)](/roar_vs_pause/3.md), [**roar\_vs\_mute**(3)](/roar_vs_mute/3.md), [**roar\_vs\_volume\_mono**(3)](/roar_vs_volume_mono/3.md), [**roar\_vs\_volume\_stereo**(3)](/roar_vs_volume_stereo/3.md), [**roar\_vs\_volume\_get**(3)](/roar_vs_volume_get/3.md)

- **Meta data**

  [**roar\_vs\_meta**(3)](/roar_vs_meta/3.md), [**roar\_vs\_role**(3)](/roar_vs_role/3.md)

- **File mode**

  [**roar\_vs\_file**(3)](/roar_vs_file/3.md), [**roar\_vs\_file\_simple**(3)](/roar_vs_file_simple/3.md), [**roar\_vs\_iterate**(3)](/roar_vs_iterate/3.md), [**roar\_vs\_run**(3)](/roar_vs_run/3.md)

- **Buffered mode**

  [**roar\_vs\_buffer**(3)](/roar_vs_buffer/3.md), [**roar\_vs\_iterate**(3)](/roar_vs_iterate/3.md), [**roar\_vs\_run**(3)](/roar_vs_run/3.md)

## BUGS

A lot...

## SEE ALSO

[**roar-config**(1)](/roar-config/1.md), [**roartypes**(1)](/roartypes/1.md), [**roartut**(7)](/roartut/7.md), [**RoarAudio**(7)](/RoarAudio/7.md).