roar_vs_role(3)

roar_vs_role3

Update role for a stream

Usage

#include <roaraudio.h>

int roar_vs_role (roar_vs_t * vss, int role, int * error);

Overview

This function updates the role of the stream. This should be done before any read or write operation and can be used at any time to update the meta data.

Parameters

vss

The VS object to be updated.

role

The new role of the stream.

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 0. On error, -1 is returned.

Examples

struct roar_keyval kv[2] = {
{.key = "TITLE", .value = "Some title"},
{.key = "ARTIST", .value = "Some artist"}
};
ret = roar_vs_meta(vss, &kv, 2, &err);

Releases

Unchanged in 5 releases since Debian 7 (Wheezy).

  1. 7–11

From libroar-dev 1.0~beta12-4 in Debian 11 (Bullseye). Parsed by carta from the page's man source.