rd_listlog — Rivendell List Log C Library Function
#include <rivwebcapi/rd_listlog.h>
int RD_ListLog( | logline[], | |
| hostname[], | ||
| username[], | ||
| passwd[], | ||
| ticket[], | ||
| logname[], | ||
| user_agent[], | ||
numrecs); |
struct rd_logline * logline[];const char hostname[];const char username[];const char passwd[];const char ticket[];const char logname[];const char user_agent[];unsigned * numrecs;RD_ListLog is the function to use to list the log lines that are stored for a particular log file within the Rivendell Database.
This function lists the lines in a pre-existing Log File.
Table 1. RD_ListLog function call fields
| FIELD NAME | FIELD TYPE | MEANING | REMARKS |
|---|---|---|---|
| *logline[] | Pointer to rd_logline structure | Memory location to store logline information | Mandatory |
| hostname | Character Array | Name Of Rivendell DB Host | Mandatory |
| username | Character Array | Rivendell User Name | Mandatory When NO Ticket Provided |
| passwd | Character Array | Rivendell User Password | Mandatory When NO Ticket Provided |
| ticket | Character Array | Rivendell Authentification Ticket | Mandatory When NO User/Password Pair Provided. |
| logname | character array | LogFile Name | Mandatory |
| user_agent | Character Array | User Agent Value put into HTTP request | Optional (default is Rivendell-C-API/x.x.x) |
| *numrecs | pointer to integer | memory location for number of records returned | Mandatory |
When successful function will return the number of records sent (numrecs) and rd_logline structure which is stored in the provided memory locations. The rd_logline structure has the following fields:
struct rd_logline {
int logline_line;
int logline_id;
int logline_type;
int logline_cart_type;
unsigned logline_cart_number;
unsigned logline_cut_number;
char logline_group_name[11];
char logline_group_color[10];
char logline_title[1021];
char logline_artist[1021];
char logline_album[1021];
int logline_year;
char logline_label[257];
char logline_client[257];
char logline_agency[257];
char logline_publisher[257];
char logline_composer[257];
char logline_conductor[257];
char logline_user_defined[1021];
int logline_usage_code;
int logline_enforce_length;
char logline_forced_length[10];
int logline_evergreen;
int logline_source;
int logline_time_type;
char logline_starttime[13];
int logline_transition_type;
int logline_cut_quantity;
int logline_last_cut_played;
char logline_marker_comment[1021];
char logline_marker_label[257];
char logline_origin_user[1021];
struct tm logline_origin_datetime;
int logline_start_point_cart;
int logline_start_point_log;
int logline_end_point_cart;
int logline_end_point_log;
int logline_segue_start_point_cart;
int logline_segue_start_point_log;
int logline_segue_end_point_cart;
int logline_segue_end_point_log;
int logline_segue_gain;
int logline_fadeup_point_cart;
int logline_fadeup_point_log;
int logline_fadeup_gain;
int logline_fadedown_point_cart;
int logline_fadedown_point_log;
int logline_duckup_gain;
int logline_duckdown_gain;
int logline_talk_start_point;
int logline_talk_end_point;
int logline_hook_mode;
int logline_hook_start_point;
int logline_hook_end_point;
};
All character arrays above are the sizes listed and must be null-terminated.
Charater encoding is UTF-8.
logline_line is a integer which represents the line number in the log.
logline_id is an integer which represents the line id (generated by rdlogedit).
logline_type is an integer 0=Cart, 1=Marker, 2=Macro, 3=OpenBracket,
4=CloseBracket, 5=Chain, 6=Track, 7=MusicLink, 8=TrafficLink,
9=UnknownType.
logline_cart_type is an integer 1=Audio, 2=Macro.
logline_cart_number is an unsigned integer.
logline_cut_number is an unsigned integer.
logline_group_name is a character arrray.
logline_group_color is a character arrray. No value set is #000000.
logline_title is a character arrray.
logline_artist is a character arrray.
logline_album is a character arrray.
logline_year is the 4 digit year.
logline_label is a character arrray.
logline_client is a character arrray.
logline_agency is a character arrray.
logline_publisher is a character arrray.
logline_composer is a character arrray.
logline_conductor is a character arrray.
logline_user_defined is a character arrray.
logline_usage_code is an integer 0=UsageFeature, 1=UsageOpen, 2=UsageClose,
3=UsageTheme, 4=UsageBackground, 5=UsagePromo, 6=UsageLast.
logline_enforce_length is a Boolean 0 = False, 1 = True.
logline_forced_length is the Length (Format HH:MM:SS.milliseconds).
logline_evergreen is a Boolean 0 = False, 1 = True.
logline_source is an integer 0=Manual, 1=Traffic, 2=Music,
3=Template, 4=Tracker
logline_time_type is an integer 0 = Relative, 1=Hard, 255 = NoTime.
logline_starttime is start Time (Format HH:MM:SS.milliseconds).
logline_transition_type is an integer 0=Play, 1=Segue, 2=Stop, 255=NoTrans.
logline_cut_quantity is an integer.
logline_last_cut_played is an integer.
logline_marker_comment is a character array.
logline_marker_label is a character array.
logline_origin_user is a character array.
logline_origin_datetime is a struct tm.
logline_start_point_cart is a integer. No Value = -1.
logline_start_point_log is a integer. No Value = -1.
logline_end_point_cart is a integer. No Value = -1.
logline_end_point_log is a integer. No Value = -1.
logline_segue_start_point_cart is a integer. No Value = -1.
logline_segue_start_point_log is a integer. No Value = -1.
logline_segue_end_point_cart is a integer. No Value = -1.
logline_segue_end_point_log is a integer. No Value = -1.
logline_segue_gain is an integer. No Value = -3000.
logline_fadeup_point_cart is a integer. No Value = -1.
logline_fadeup_point_log is a integer. No Value = -1.
logline_fadeup_gain is an integer.
logline_fadedown_point_cart is a integer. No Value = -1.
logline_fadedown_point_log is a integer. No Value = -1.
logline_duckup_gain is a integer.
logline_duckdown_gain is a integer.
logline_talk_start_point is a integer. No Value = -1.
logline_talk_end_point is a integer. No Value = -1.
logline_hook_mode is a integer. No Value = -1.
logline_hook_start_point is a integer. No Value = -1.
logline_hook_end_point is a integer. No Value = -1.