Name
scheduleAudio — schedule a new alarm which executes a shell command.
Synopsis
bool scheduleAudio(const QString&name
, const QString&audioURL
, intvolumePercent
, const QString&startDateTime
, intlateCancel
, unsignedflags
, const QString&recurrence
, intsubRepeatInterval
, intsubRepeatCount
)
bool scheduleAudio(const QString&name
, const QString&audioURL
, intvolumePercent
, const QString&startDateTime
, intlateCancel
, unsignedflags
, intrecurType
, intrecurInterval
, intrecurCount
)
bool scheduleAudio(const QString&name
, const QString&audioURL
, intvolumePercent
, const QString&startDateTime
, intlateCancel
, unsignedflags
, intrecurType
, intrecurInterval
, const QString&endDateTime
)
Parameters
name
Specifies an optional name for the alarm.
audioURL
Specifies the audio file which is to be played.
volumePercent
Specifies the volume level to use, as a percentage of full volume. Specify -1 to use the default volume.
startDateTime
Specifies the scheduled date, or date and time, at which the message should be displayed. For a date-only alarm, the string should be in the format
YYYY-MM-DD[ TZ]
(as returned byQDate::toString(Qt::ISODate)
). For an alarm with a date and time, the string should be in the formatYYYY-MM-DDTHH:MM[:SS][ TZ]
(as returned byQDateTime::toString(Qt::ISODate)
) orHH:MM[:SS]
(as returned byQTime::toString(Qt::ISODate)
). If no date is specified, today's date is used. Note that any seconds value is ignored.If no time zone is specified, the local system time zone is assumed. If a time zone specifier
TZ
is present, it may be the name of a system time zone (e.g.Europe/London
), orUTC
representing the UTC time zone.lateCancel
Causes the alarm to be canceled if it cannot be triggered within the specified number of minutes after the alarm's scheduled time. If the value is 0, the alarm will not be canceled no matter how late it is triggered.
flags
Specifies the logical OR of the desired alarm flags. The flag bits are those defined in class
KAlarmIface
inkalarmiface.h
. Note that not all flag bits are applicable to command alarms.recurrence
Specifies a regular recurrence for the alarm, using iCalendar syntax as defined in RFC2445. For example, “FREQ=MONTHLY;COUNT=4;INTERVAL=3;BYDAY=-1MO” would specify 4 repetitions at 3-monthly intervals on the last Monday of the month. For a non-recurring alarm, specify an empty string.
recurType
Specifies the recurrence type for the alarm. The permissible values are MINUTELY, DAILY, WEEKLY, MONTHLY, YEARLY. These are defined in class
KAlarmIface
inkalarmiface.h
. Monthly recurrences are of the day of the month type, and yearly recurrences are of the date in the year type, with the date in both cases taken from thestartDateTime
parameter.recurInterval
Specifies the number of periods (minutes/days/weeks/months/years as specified by
recurType
) between recurrences of the alarm.recurCount
Specifies the number of times that the alarm should be repeated. Specify -1 to repeat the alarm indefinitely.
endDateTime
Specifies the end date, or date and time, for recurrences of the alarm. If
startDateTime
includes a time, this parameter must also include a time; ifstartDateTime
contains only a date, this parameter must also contain only a date. It must not contain a time zone specifier; the same time zone as forstartDateTime
is used to interpret this parameter's value.subRepeatInterval
Specifies the number of minutes between sub-repetitions of the alarm. Specify 0 for no sub-repetition. Ignored if no recurrence is specified.
subRepeatCount
Specifies the number of sub-repetitions of the alarm, including the initial occurrence.
Description
scheduleAudio()
is a D-Bus call to
schedule the specified audio file to be played at the specified date
and time. Apart from specifying a volume and omitting the message
color and font parameters, its usage is identical to
scheduleMessage
- see the description of that function for further details.