Audio::Moosic(3pm)

🎀 Audio::Moosic 🎀

okay bestie, welcome to the Audio::Moosic page — it's the Moosic client library for Perl and honestly? it's giving "let me talk to your jukebox for you" 💅

---

✨ SYNOPSIS ✨

use Audio::Moosic;

$moo = Audio::Moosic::Unix->new();

$moosic->append('/home/me/somewhat.ogg');
$moosic->play;
print $moosic->current, "\n";
$moosic->pause;
...

---

🦋 DESCRIPTION 🦋

So Audio::Moosic is literally a client for the musical jukebox program Moosic ( http://nanoo.org/~daniel/moosic/ ) by Daniel Pearson <daniel@nanoo.org> — no cap, that's the whole vibe.

Using Audio::Moosic you can connect to a moosic server either via an UNIX socket or an INET socket. pick your fighter 💖

---

🌸 METHODS 🌸

---

💫 new

$moo = Audio::Moosic::Unix->new();
$moo = Audio::Moosic::Unix->new('/tmp/moosic/socket');
$moo = Audio::Moosic::Inet->new('localhost', 8765);

Constructor time, bestie ✨ It initializes the class and invokes the connect method. So if you're creating a Audio::Moosic::Unix object, you can pass the location of your moosic socket as a parameter. If you don't? Then ~/.moosic/socket gets used instead, nbd. And if you're making a Audio::Moosic::Inet instance, you gotta pass host and port as arguments — that's not optional, periodt.

🚨 Real talk: you cannot create an instance of Audio::Moosic itself. Use the Unix or Inet subclass, iykyk.

If the object was able to connect to the moosic server, a reference to the object instance is returned 🫶. If the connection failed, $@ is set and undef is returned. sad girl hours 😭

---

🔌 connect

$moo->connect('foobar.com', 9876);

Connects to the moosic server. Ngl you normally don't need to run this method in your moosic client — it just kinda happens for you 💅

---

👋 disconnect

$moo->disconnect;

Disconnects from the moosic daemon. After you call this, no more calls will be sent to the server. You'll need to reconnect() first. so dramatic, but valid 💀

---

🔄 reconnect

$moo->reconnect;

Disconnects from the server if you're connected, and tries to reconnect. it's giving "we broke up but let's try again" energy 🙈

---

🧐 connected

$moo->reconnect unless $moo->connected;

Check whether you're connected to the moosic server or not. simple as that, bestie ✨

---

📖 client_config

print $moo->client_config('location');
$conf = $moo->client_config();

Reads the moosic clients config 📖. If a $key argument is given, it returns only the value associated with that key. If not, you get the whole config hash. obsessed with options tbh.

Hmm — "Would it be a good idea to make the user able to edit the client_config here? Suggestions or maybe patches are welcome." — straight from the author's keyboard, and honestly? valid question 👑

---

🩺 ping

die unless $moo->ping;

Checks if we're still connected. And here's the tea ☕ — this method checks the connection explicitly by calling the no_op server method. Meanwhile connected() only checks the value of the 'connected' object property. two very different vibes, don't mix them up 💅

---

😭 error

my $error = $moo->error;
$moo->error('Whaaa!');

If an argument is given, it adds the error string to the internal error array. If called in scalar context, it returns the last error that occurred. If you call error() in list context, the whole error array of the Audio::Moosic instance is returned. collect them all like Pokémon, bestie 🎀

---

📞 call

$moo->call('foo');
$moo->call('bar', RPC::XML::int->new(3));

This method calls an xml-rpc method on the moosic server. The first argument should be the method name, and the arguments of that method should follow behind it. okay so:

• If the request to the moosic server could not be sent, the Audio::Moosic instance disconnects from the server and puts the error message into the internal error array. Access it via error(). The object won't send any calls anymore if such an error occurred — you should try to reconnect 😭
• If the request could be sent, but returned an error, the error message is added to the error array accessible via error().
• If any error occurred, call() returns undef. If everything went fine, the value of the response is returned ✨

Normally you don't need to call this method — it's only used by other moosic methods to send their calls more easily. But if a new moosic method is not supported by this library yet, you'll maybe need to use call() manually. And: "Please notice me if that happens so I'll add the new method." 🫶 adorable, we love a responsive maintainer.

---

🏷️ api_version

@api = $moo->api_version;
$api = $moo->api_version;

Returns the moosic servers API version. In scalar context you get a version string like '1.3'. In list context you get the mayor and minor numbers of the API version. (yes, "mayor" — that's how the original says it, and we respect the original 💖)

---

➕ append

$moo->append('/home/florian/whatever.ogg');
$moo->append('/home/florian/foo.ogg', '/home/florian/bar.mp3');

Add songs to the moosic queue 🎶. The files to add should be the arguments for the append method. append() returns 1 if there were no errors, or something false if there were some. slay when it works, oof when it doesn't 😭

---

🧹 clear

$moo->clear;

Clears the moosic queue. Only the current song remains playing. it's giving "clean slate, fresh start" ✨

---

✂️ crop

$moo->crop(4);
$moo->crop(3, 4);

Remove all playlist items that don't fall within a given range. So here's how the range works, bestie:

• If the range is represented by one integer, all items whose index is greater than or equal to the value will be removed.
• Two integers represent all items whose index is greater than or equal to the value of the first integer and less than the value of the second integer.

okay so note that second one is "less than", not "less than or equal" — the details matter 👑

---

📋 crop_list

$moo->crop_list(1, 4, 3);

Remove all queued items except those referenced by a list of positions. keep only the chosen ones 💅

---

🎵 current

print $moo->current;

Return the name of the current playing song. main character energy only 🌟

---

⏱️ current_time

print $moo->current_time;

Return the amount of time the current song has been playing. ticking away, iconic ⏳

---

🗡️ cut

$moo->cut(3);
$moo->cut(4, 10);

Remove all queued items that fall within a given range. See crop() for details on how that range should look like — same rules, different verb 🔥

---

🎯 cut_list

Remove all queued items referenced by list of positions. bye besties 👋

---

## 💀 `die`

$moo->die;

Tell the server to terminate itself. <red>yes, really, that's the whole method</red> — it's giving lethal 💀 use with intention, bestie.

---

## 🧼 `filter`

$moo->filter('foo'); $moo->filter('bar', 4); $moo->filter('moo', 7, 11);

Remove all items that **don't** match the given regular expression. You may limit this operation to a specific range, which is described in `crop()`. regex said "not today" and honestly, same 🌸

---

## 📏 `get_history_limit`

$limit = $moo->get_history_limit;

Get the limit on the size of the history list stored in servers memory 🧠

---

## ⚙️ `getconfig`

@config = $moo->getconfig;

Return a list of the server's filetype-player associations. who plays what, the whole roster 🎧

---

## 🛑 `halt_queue`

$moo->halt_queue;

Stop any new songs from being played. Use `run_queue()` to reverse this state. queue said "no more, i'm tired" 😴

---

## 🔁 `haltqueue`

See `halt_queue()`. (same thing, shorter name — pick your fave 💅)

---

## 📜 `history`

%hist = $moo->history;

Return a list of items that has been recently played. If a positive integer argument is given, then no more than that number of items will be returned. Otherwise the entire history is printed. receipts of everything you've played, bestie 🧾

`history()` returns an array of hashrefs like that:

@history = ( { title => 'foo', start => 123.45, stop => 543.21 }, { title => 'bar', start => 234.56, stop => 654.32 }, ... );

---

## 🗂️ `indexed_list`

%list = $moo->indexed_list; %list = $moo->indexed_list(1); %list = $moo->indexed_list(2, 5);

List the song queue's contents. If a range is specified, only the items that fall within that range are listed.

`indexed_list()` returns a hash like that:

%list = ( list => [ 'foo', 'bar', 'moo', ... ], start => 4 );

---

## 📥 `insert`

$moo->insert(4, 'foo.ogg', 'bar.mp3');

Insert items at a given position in the queue. cutting the line but make it legal 💅

---

## 🔂 `is_looping`

$moo->toggle_loop_mode if $moo->is_looping;

Check whether the loop mode is on or not. round and round and round we go 🌀

---

## ⏸️ `is_paused`

$moo->toggle_pause if $moo->is_paused;

Check whether the current song is paused or not.

---

## ▶️ `is_queue_running`

if($moo->is_queue_running) { ...; }

Check whether the queue consumption (advancement) is activated. is the queue actually moving or is it just sitting there 🚦

---

## 🕰️ `last_queue_update`

$time = $moo->last_queue_update

Return the time at which the song queue was last modified. timestamped, iconic ⏱️

---

## 📐 `length`

$length = $moo->length

Return the number of items in the song queue. math but make it music 🎶

---

## 📝 `list`

@list = $moo->list(); @list = $moo->list(2); @list = $moo->list(4, 8); $list_ref = $moo->list()

List the song queue's contents. If a range is specified, only the items that fall within that range are listed. Returns an array if called in <yellow>list context</yellow>, or an array reference if it's called in <yellow>scalar context</yellow>. context is everything, bestie 💅

---

## 🚚 `move`

$moo->move(10, 4); $moo->move(4, 7, 1);

Move a range of items to a new position within the queue. rearrange, restyle, re-slay ✨

---

## 🎪 `move_list`

$moo->move(3, 5, 7, 11);

Move the items referenced by a list of positions to a new position. (yes, the example says `move` — we keep it exactly as written, no edits, fr fr 💖)

---

## ⏭️ `next`

$moo->next; $moo->next(5);

Stop the current song (if any), and jump ahead to a song that is currently in the queue. The skipped songs are recorded in the history as if they had been played. When called without arguments, this behaves very much like the `skip()` method — except that it will have an effect <yellow>even if nothing is currently playing</yellow>. so it's skip but with main character energy 👑

---

## 🚫 `no_op`

$moo->no_op

Do nothing, successfully. the most relatable method on this entire page 😭 iconic.

---

## ⏯️ `pause`

$moo->pause;

Pause the currently playing song. hold that thought ✋

---

## 🥇 `prepend`

$moo->prepend('foo.ogg', 'bar.mp3');

Add items to the beginning of the queue. front of the line, no waiting 💅

---

## ⏮️ `previous`

$moo->previous; $moo->previous(3);

Stops the current song (if any), removes the most recently played song from the history, and puts these songs at the head of the queue. When loop mode is on, the songs at the tail of the song queue are used instead of the most recently played songs in the history. time travel but for your playlist 🕰️✨

---

## 🔙 `putback`

$moo->putback;

Place the currently playing song at the beginning of the queue. "actually, one more time" 🙈

---

## 📊 `queue_length`

$length = $moo->queue_length;

Return the number of items in the song queue. (yes, same job as `length` — both are here, both stay 💖)

---

## ♻️ `reconfigure`

$moo->reconfigure;

Tell the server to reread its player configuration file. glow up for the config 🔄

---

## 🗑️ `remove`

$moo->remove('regex'); $moo->remove('regex', 4); $moo->remove('regex', 1, 3);

Remove all items that **match** the given regular expression. You can limit this operation by giving a range as described in `crop()` as the last argument. (yep — `filter` removes the non-matches, `remove` removes the matches. don't get it twisted bestie 😭)

---

## 🔃 `replace`

$moo->replace('foo.ogg', 'bar.mp3');

Replace the contents of the queue with the given items. This is equivalent to calling `clear()` and `prepend()` in succession — except that this operation is <yellow>atomic</yellow>. all at once, no in-between, slay 🔥

---

## 🔄 `reverse`

$moo->reverse; $moo->reverse(2); $moo->reverse(5, 7);

Reverse the order of the items in the queue. You can limit this operation by giving a range as described in `crop()` as the last argument. upside down, backwards, but make it chic 🌀

---

## 🏃 `run_queue`

$moo->run_queue;

Allows new songs to be played again after `halt_queue()` has been called. we're so back 🎉

---

## 🏃‍♀️ `runqueue`

See `run_queue()`. (same method, shorter name, both iconic 💅)

---

## 🔢 `set_history_limit`

$moo->set_history_limit(44);

Set the limit on the size of the history list stored in memory. how much past we're keeping, bestie 🧠

---

## 🔁 `set_loop_mode`

$moo->set_loop_mode(0); $moo->set_loop_mode(1);

Turn loop mode on or off. `0` for off, `1` for on — the eternal cycle begins or ends 🌀

---

## 📜 `showconfig`

my $config = $moo->showconfig; my %config = $moo->showconfig;

the config reveal moment — and that's where part 1 wraps... well, not wraps exactly, because there's more coming 💖

<pink>Return the server's player configuration</pink>, bestie. If `showconfig()` is called in <cyan>scalar context</cyan> a scalar containing the textual description of the configuration is returned. If you call `showconfig()` in <cyan>list context</cyan> a hash which maps the configuration regular expression to the player commands is returned.

---

### <pink>shuffle</pink> 🎲

$moo->shuffle; $moo->shuffle(2); $moo->shuffle(4, 6);

<yellow>Rearrange the contents of the queue into a random order.</yellow> You can limit this operation by giving a range as described for `crop()` as last argument.

---

### <pink>skip</pink> ⏭️

$moo->skip;

<yellow>Skips the rest of the current song to play the next song in the queue.</yellow> This only has an effect if there actually is a current song.

---

### <pink>sort</pink> 🔤

$moo->sort; $moo->sort(2); $moo->sort(4, 6);

<yellow>Arrange the contents of the queue into sorted order.</yellow>

---

### <pink>stop</pink> 🛑

$moo->stop;

<yellow>Stop playing the current song and stops new songs from playing.</yellow> The current song is returned to the head of the song queue and is not recorded in the history list. If loop mode is on, the current song won't be placed at the end of the song queue when it is stopped.

---

### <pink>sub</pink> 🔄

$moo->sub('regex', 'substitition'); $moo->sub('regex', 'substitition', 2); $moo->sub('regex', 'substitition', 1, 7);

<yellow>Perform a regular expression substitution on the items in the queue.</yellow> You can limit this operation by giving a range as described for `crop()` as last argument.

---

### <pink>sub_all</pink> 🌐

$moo->sub_all('regex', 'substition'); $moo->sub_all('regex', 'substition', 2); $moo->sub_all('regex', 'substition', 1, 7);

<yellow>Performs a global regular expression substitution on the items in the queue.</yellow>

---

### <pink>swap</pink> 🔀

$moo->swap( [7, 10], [ 5 ] );

<yellow>Swap the items contained in one range with the items contained in the other range.</yellow> The ranges for the `swap()` method need to be passed as array references in contrast to other methods that use ranges.

---

### <pink>listMethods</pink> 📋

@methods = $moo->listMethods;

<yellow>Return an array of all available XML-RPC methods on this server.</yellow>

---

### <pink>methodHelp</pink> ❓

$help = $moo->methodHelp('sub');

<yellow>Given the name of a method, return a help string.</yellow>

---

### <pink>methodSignature</pink> ✍️

$signature = $moo->methodSignature;

<yellow>Given the name of a method, return an array of legal signatures.</yellow> Each signature is an array of scalars. The first item of each signature is the return type, and any others items are parameter types. `=cut`

---

### <pink>multicall</pink> 📞

$moo->multicall(...);

<yellow>Process an array of calls, and return an array of results.</yellow> This is not implemented yet.

---

### <pink>toggle_loop_mode</pink> 🔁

$moo->toggle_loop_mode;

<yellow>Turn loop mode on if it is off, and turns it off if it is on.</yellow>

---

### <pink>toggle_pause</pink> ⏯️

$moo->toggle_pause;

<yellow>Pause the current song if it is playing, and unpauses if it is paused.</yellow>

---

### <pink>unpause</pink> ▶️

$moo->unpause;

<yellow>Unpauses the current song.</yellow>

---

### <pink>version</pink> 🔢

$version = $moo->version;

<yellow>Return the Moosic server's version string.</yellow>

---

# ✨ <hotpink>HELPER METHODS</hotpink> ✨

<lavender>The following methods aren't methods defined by the moosic API but should be useful when dealing with a moosic server.</lavender>

### <pink>play</pink> 🎵

$moo->play();

<yellow>Start playing.</yellow> If the playback is paused it will be unpaused. If the queue is stopped it will be started.

### <pink>can_play</pink> ✅

$moo->append( $song ) if $moo->can_play( $song );

<yellow>Takes a list of songs as argument and returns all items that can be played by the moosic daemon.</yellow>

---

# 💀 <red>BUGS</red> 💀

- <peach>check arguments more strictly</peach>

  <peach>especially for constructors.</peach>

If you find some others please report them to Florian Ragwitz <flora@cpan.org>

---

# 🎀 <purple>TODO</purple> 🎀

- <peach>implement system_multicall</peach>

- <peach>improve client_config</peach>

- <peach>maybe use autoloader to load subs on demand</peach>

  <peach>create the method arguments from methodSignature.</peach>

---

# 🌈 <rainbow>SEE ALSO</rainbow> 🌈

moosic(1), moosicd(1), http://nanoo.org/~daniel/moosic/

---

# 👑 <yellow>AUTHOR</yellow> 👑

Florian Ragwitz <rafl@debian.org>

---

# 💖 <hotpink>COPYRIGHT AND LICENSE</hotpink> 💖

Copyright (C) 2004-2008 by Florian Ragwitz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.4 or, at your option, any later version of Perl 5 you may have available.

---

and that's the whole vibe check! this page is from <cyan>`perl v5.36.0`</cyan>, dated <cyan>`2022-12-12`</cyan>, and it's <cyan>`Audio::Moosic(3pm)`</cyan>. stay slay, bestie 💅✨