Data::...::Audio(3pm)

✨ NAME ✨

okay so bestie, this page is the manual for Data::ICal::Entry::Alarm::Audio (lives in the Data::...::Audio corner of perl's 3pm section, ft. Data::ICal::Entry::Alarm::Audio) — it's the thing that represents an audio alarm in an iCalendar file. yes that's the whole job. she's niche and she's booked. 💖

---

🌸 SYNOPSIS 🌸

living proof, in code:

my $valarm = Data::ICal::Entry::Alarm::Audio->new();
$valarm->add_properties(
    attach => [ "ftp://host.com/pub/sounds/bell-01.aud", { fmttype => "audio/basic" } ],
    # Dat*e*::ICal is not a typo here
    trigger   => [ Date::ICal->new( epoch => ... )->ical, { value => 'DATE-TIME' } ],
);

$vevent->add_entry($valarm);

okay and before u come for me — yes, that comment is doing overtime, Dat*e*::ICal is not a typo. it's a whole different module from Data::ICal and the docs are being loud about it on purpose. 💅

---

🦋 DESCRIPTION 🦋

A Data::ICal::Entry::Alarm::Audio object represents an audio alarm attached to a todo item or an event inside an iCalendar file. (quick side quest: the iCalendar RFC calls entries "components" — so if u see that word floating around, same thing, no jump scare.) 🫶

It is a subclass of Data::ICal::Entry::Alarm and accepts all of its methods. so everything the parent can do, she can do too. main character inheriting main character energy. 👑

---

🎀 METHODS 🎀

✨ new

Creates a shiny new Data::ICal::Entry::Alarm::Audio object; and — plot twist — it sets its ACTION property to AUDIO. so like, the alarm knows what it is. self-aware queen. 🔥

✨ optional_unique_properties

In addition to duration and repeat (go look at "optional_unique_properties" in Data::ICal::Entry::Alarm for those two), audio alarms may also specify a value for attach. that's the extra lil slot she gets to fill. 🎧

---

💜 AUTHOR 💜

Best Practical Solutions, LLC <modules@bestpractical.com>

---

👑 LICENCE AND COPYRIGHT 👑

Copyright (c) 2005 - 2020, Best Practical Solutions, LLC. All rights reserved.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

fr fr read the license before u go redistributing, bestie — it's literally two lines, u got this. 🫶

---

and that's the whole page!! this one came to u from perl v5.36.0, dated 2022-10-14, filed under Data::...::Audio(3pm). slay, bye. 💖✨🎀