Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-07-08 16:37:46 +02:00
Code Issues Projects Releases Wiki Activity

2018-10-11 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Replaced listings of the 'rd_cart' structure with a reference
	to the rd_listcartcuts(7) man page in the rd_listcart(7),
	rd_listcarts(7) and rd_listcartscuts(7) man pages.
	* Replaced listings of the 'rd_cut' structure with a reference
	to the rd_listcartcuts(7) man page in the rd_listcut(7) and
	rd_listcuts(7) man pages.
This commit is contained in:
Fred Gleason 2018-10-11 19:24:43 -04:00
parent ae75610054
commit e3a42f3a66
6 changed files with 23 additions and 306 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ChangeLog
View File

@ -17766,3 +17766,10 @@
in 'rivwebcapi'.
2018-10-11 Fred Gleason <fredg@paravelsystems.com>
* Added an 'RD_ListCartsCuts()' function to 'rivwebcapi'.
2018-10-11 Fred Gleason <fredg@paravelsystems.com>
* Replaced listings of the 'rd_cart' structure with a reference
to the rd_listcartcuts(7) man page in the rd_listcart(7),
rd_listcarts(7) and rd_listcartscuts(7) man pages.
* Replaced listings of the 'rd_cut' structure with a reference
to the rd_listcartcuts(7) man page in the rd_listcut(7) and
rd_listcuts(7) man pages.

102
docs/rivwebcapi/rd_listcart.xml
View File

@ -194,104 +194,12 @@
</table>
<para>
When successful function will return the number of records sent (numrecs) and a rd_cart structure which
is stored in the provided memory locations. The rd_cart structure has the following fields:
When successful function will return the number of records sent
(numrecs) and a rd_cart structure which
is stored in the provided memory locations. (See the
<command>rd_listcartcuts</command><manvolnum>7</manvolnum> man page
for a listing of the rd_cart structure).
</para>
<programlisting>
struct rd_cart {
unsigned cart_number; /* Cart Number */
unsigned cart_type; /* Cart Type */
char cart_grp_name[11]; /* Group Name */
char cart_title[256]; /* Cart Title */
char cart_artist[256]; /* Artist */
char cart_album[256]; /* Album */
int cart_year; /* Year */
char cart_label[65]; /* Label */
char cart_client[65]; /* Client */
char cart_agency[65]; /* Agency */
char cart_publisher[65]; /* Publisher */
char cart_composer[65]; /* Composer */
char cart_conductor[65]; /* Conductor */
char cart_user_defined[256]; /* User Defined */
int cart_usage_code; /* Usage Code */
int cart_forced_length; /* Forced Length */
int cart_average_length; /* AverageLength */
int cart_length_deviation; /* Length Deviation */
int cart_average_segue_length; /* Average Segue Length */
int cart_average_hook_length; /* Average Hook Length */
unsigned cart_cut_quantity; /* Cut Quantity */
unsigned cart_last_cut_played; /* Last Cut Played */
unsigned cart_validity; /* Validity */
int cart_enforce_length; /* Enforce Length Flag */
int cart_asyncronous; /* Asyncronous Flag */
char cart_owner[65]; /* Owner */
struct tm cart_metadata_datetime; /* Metatdata Datetime */
char cart_notes[1024]; /* Notes */
};
All character arrays above are the sizes listed and must be null-terminated.
The cart number is a unsigned integer.
The cart_type is 1=Audio,2=Macro.
The cart_grp_name must be a valid Rivendell DB Group.
The cart_title is 255 characters.
The cart_artist is 255 characters.
The cart_album is 255 characters.
The cart_year is a date (YYYY).
The cart_label is 64 characters.
The cart_client is 64 characters.
The cart_agency is 64 characters.
The cart_publisher is 64 characters.
The cart_composer is 64 characters.
The cart_conductor is 64 characters.
The cart_user_defined is 255 characters.
The cart_usage_code is 0=Feature, 1=Theme Open,
2=Theme Close, 3=Theme Open/Close,
4=Background, 5=Comm/Promo
The cart_forced_length is in milliseconds.
The cart_average_length is in milliseconds.
The cart_length_deviation is in milliseconds.
The cart_average_segue_length is in milliseconds.
The cart_average_hook_length is in milliseconds.
The cart_cut_quantity is number of cuts.
The cart_last_cut_played is self explanatory.
The cart_validity is 0=NeverValid, 1=Conditional, 2=AlwaysValid
3=EvergreenValid, 4=FutureValid
The cart_enforce_length is True(1) or False(0).
The cart_asyncronous is True(1) or False(0).
The cart_owner is 64 characters.
The cart_metadata_datetime is a struct tm.
The cart_user_notes is a character array up to 1024 characters.
</programlisting>
</refsect1>
<refsect2 id='returns'><title>RETURN VALUE</title>
<para>

4
docs/rivwebcapi/rd_listcartcuts.xml
View File

@ -45,7 +45,7 @@
<funcprototype>
<funcdef>struct rd_cut *<function>RD_ListCartCuts_GetCut</function></funcdef>
<paramdef> struct rd_cart * <parameter>cart</parameter></paramdef>
<paramdef>int <parameter>pos</parameter></paramdef>
<paramdef>int <parameter>cut_rec</parameter></paramdef>
</funcprototype>
<funcprototype>
@ -252,7 +252,7 @@
Information about the cuts associated with the cart can be accessed
from the returned rd_cart structure through use of the
<command>RD_ListCartCuts_GetCut()</command> function.
The <parameter>pos</parameter> parameter should range between
The <parameter>cut_rec</parameter> parameter should range between
<userinput>0</userinput> and one less than the
value of the <parameter>cart_cut_quantity</parameter> member of the
cart's rd_cart structure.

100
docs/rivwebcapi/rd_listcarts.xml
View File

@ -227,104 +227,10 @@
<para>
When successful function will return the number of records sent (numrecs) and a rd_cart structure which
is stored in the provided memory locations. The rd_cart structure has the following fields:
is stored in the provided memory locations. (See the
<command>rd_listcartcuts</command><manvolnum>7</manvolnum> man page
for a listing of the rd_cart structure).
</para>
<programlisting>
struct rd_cart {
unsigned cart_number; /* Cart Number */
unsigned cart_type; /* Cart Type */
char cart_grp_name[41]; /* Group Name */
char cart_title[1021]; /* Cart Title */
char cart_artist[1021]; /* Artist */
char cart_album[1021]; /* Album */
int cart_year; /* Year */
char cart_label[257]; /* Label */
char cart_client[257]; /* Client */
char cart_agency[257]; /* Agency */
char cart_publisher[257]; /* Publisher */
char cart_composer[257]; /* Composer */
char cart_conductor[257]; /* Conductor */
char cart_user_defined[1021]; /* User Defined */
int cart_usage_code; /* Usage Code */
int cart_forced_length; /* Forced Length */
int cart_average_length; /* AverageLength */
int cart_length_deviation; /* Length Deviation */
int cart_average_segue_length; /* Average Segue Length */
int cart_average_hook_length; /* Average Hook Length */
unsigned cart_cut_quantity; /* Cut Quantity */
unsigned cart_last_cut_played; /* Last Cut Played */
unsigned cart_validity; /* Validity */
int cart_enforce_length; /* Enforce Length Flag */
int cart_asyncronous; /* Asyncronous Flag */
char cart_owner[257]; /* Owner */
struct tm cart_metadata_datetime; /* Metatdata Datetime */
char cart_notes[4096]; /* Notes */
};
All character arrays above are the sizes listed and must be null-terminated.
Character encoding is UTF-8.
The cart number is a unsigned integer.
The cart_type is 1=Audio,2=Macro.
The cart_grp_name must be a valid Rivendell DB Group.
The cart_title is 255 characters.
The cart_artist is 255 characters.
The cart_album is 255 characters.
The cart_year is a date (YYYY).
The cart_label is 64 characters.
The cart_client is 64 characters.
The cart_agency is 64 characters.
The cart_publisher is 64 characters.
The cart_composer is 64 characters.
The cart_conductor is 64 characters.
The cart_user_defined is 255 characters.
The cart_usage_code is 0=Feature, 1=Theme Open,
2=Theme Close, 3=Theme Open/Close,
4=Background, 5=Comm/Promo
The cart_forced_length is in milliseconds.
The cart_average_length is in milliseconds.
The cart_length_deviation is in milliseconds.
The cart_average_segue_length is in milliseconds.
The cart_average_hook_length is in milliseconds.
The cart_cut_quantity is number of cuts.
The cart_last_cut_played is self explanatory.
The cart_validity is 0=NeverValid, 1=Conditional, 2=AlwaysValid
3=EvergreenValid, 4=FutureValid
The cart_enforce_length is True(1) or False(0).
The cart_asyncronous is True(1) or False(0).
The cart_owner is 64 characters.
The cart_metadata_datetime is a struct tm.
The cart_user_notes is a character array up to 1024 characters.
</programlisting>
</refsect1>
<refsect2 id='returns'><title>RETURN VALUE</title>
<para>

58
docs/rivwebcapi/rd_listcut.xml
View File

@ -210,62 +210,10 @@
<para>
When successful function will return the number of records sent (numrecs) and a rd_cut structure which
is stored in the provided memory locations. The rd_cut structure has the following fields:
is stored in the provided memory locations. (See the
<command>rd_listcartcuts</command><manvolnum>7</manvolnum> man page
for a listing of the rd_cut structure).
</para>
<programlisting>
struct rd_cut {
char cut_name[11];
unsigned cut_cart_number;
unsigned cut_cut_number;
int cut_evergreen;
char cut_description[257];
char cut_outcue[257];
char cut_isrc[49];
char cut_isci[129];
unsigned cut_length;
struct tm cut_origin_datetime;
struct tm cut_start_datetime;
struct tm cut_end_datetime;
int cut_sun;
int cut_mon;
int cut_tue;
int cut_wed;
int cut_thu;
int cut_fri;
int cut_sat;
char cut_start_daypart[9];
char cut_end_daypart[9];
char cut_origin_name[257];
char cut_origin_login_name[1021];
char cut_source_hostname[1021];
unsigned cut_weight;
struct tm cut_last_play_datetime;
unsigned cut_play_counter;
unsigned cut_local_counter;
unsigned cut_validity;
unsigned cut_coding_format;
unsigned cut_sample_rate;
unsigned cut_bit_rate;
unsigned cut_channels;
int cut_play_gain;
int cut_start_point;
int cut_end_point;
int cut_fadeup_point;
int cut_fadedown_point;
int cut_segue_start_point;
int cut_segue_end_point;
int cut_segue_gain;
int cut_hook_start_point;
int cut_hook_end_point;
int cut_talk_start_point;
int cut_talk_end_point;
};
All character arrays above are the sizes listed and must be null-terminated.
Character encoding is UTF-8.
</programlisting>
</refsect1>
<refsect2 id='returns'><title>RETURN VALUE</title>
<para>

58
docs/rivwebcapi/rd_listcuts.xml
View File

@ -196,62 +196,10 @@
<para>
When successful function will return the number of records sent (numrecs) and a rd_cut structure which
is stored in the provided memory locations. The rd_cut structure has the following fields:
is stored in the provided memory locations. (See the
<command>rd_listcartcuts</command><manvolnum>7</manvolnum> man page
for a listing of the rd_cut structure).
</para>
<programlisting>
struct rd_cut {
char cut_name[11];
unsigned cut_cart_number;
unsigned cut_cut_number;
int cut_evergreen;
char cut_description[257];
char cut_outcue[257];
char cut_isrc[49];
char cut_isci[129];
unsigned cut_length;
struct tm cut_origin_datetime;
struct tm cut_start_datetime;
struct tm cut_end_datetime;
int cut_sun;
int cut_mon;
int cut_tue;
int cut_wed;
int cut_thu;
int cut_fri;
int cut_sat;
char cut_start_daypart[14];
char cut_end_daypart[14];
char cut_origin_name[257];
char cut_origin_login_name[1021];
char cut_source_hostname[1021];
unsigned cut_weight;
struct tm cut_last_play_datetime;
unsigned cut_play_counter;
unsigned cut_local_counter;
unsigned cut_validity;
unsigned cut_coding_format;
unsigned cut_sample_rate;
unsigned cut_bit_rate;
unsigned cut_channels;
int cut_play_gain;
int cut_start_point;
int cut_end_point;
int cut_fadeup_point;
int cut_fadedown_point;
int cut_segue_start_point;
int cut_segue_end_point;
int cut_segue_gain;
int cut_hook_start_point;
int cut_hook_end_point;
int cut_talk_start_point;
int cut_talk_end_point;
};
All character arrays above are the sizes listed and must be null-terminated.
Charater encoding is UTF-8.
</programlisting>
</refsect1>
<refsect2 id='returns'><title>RETURN VALUE</title>
<para>