roar_vs_meta(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_vs_meta — it's giving "update the meta data for a stream" ✨

okay bestie, so this page is from the RoarAudio Programmer's Manual, and it's literally all about one lil function that lets you tell your stream who it is. no cap.

🎀 NAME 🎀

roar_vs_meta — update meta data for a stream. that's it. that's the whole vibe. 💅

🌸 SYNOPSIS 🌸

#include <roaraudio.h>

int     roar_vs_meta          (roar_vs_t * vss, struct roar_keyval * kv,
size_t len, int * error);

copy that exactly, don't get creative, i'm watching 👀

🦋 DESCRIPTION 🦋

So. This function updates the meta data of the stream. Think of it like changing your profile pic but for audio — title, artist, all that cute stuff. 🎵

The important bit: this should be done before any read or write operation, and it can be used at any time to update the meta data. So like, you can set it up early, and also come back and change it whenever. main character energy, honestly.

✨ PARAMETERS ✨

  • vss — the VS object you're updating. the one getting the glow-up. 👑
  • kv — an array of meta data elements. it's giving a lil list of key-value cuties.
  • len — the length of the array kv. yes bestie, you gotta tell it how many.
  • error — this is a pointer to an integer used to store the error value in case of error. it can be NULL if you're not using it, but it is very recommended to use this error value to report good error messages to the user. fr fr, don't skip this one, your users will thank you. 🙈

🔥 RETURN VALUE 🔥

  • On success these calls return 0. slay. ✨
  • On error, -1 is returned. 💀

🌈 EXAMPLES 🌈

look at this gorgeous code, no notes:

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

two keyvals, a title, an artist, and a dream. ate. 💅

🫶 SEE ALSO 🫶

go read those next, iykyk 🧚

mwah, that's the whole page. This lil slice of documentation came out of the RoarAudio corner of the world back in May 2011, and the man page answers to roar_vs_meta(3). bye bestie, go update some meta data 💖✨🎀

📦 where this page comes from