Name

rd_exportpeaks — Rivendell ExportPeaks Audio C Library Function

Synopsis

#include <rivwebcapi/rd_exportpeaks.h>
int RD_ExportPeaks(hostname[],  
 username[],  
 passwd[],  
 ticket[],  
 cartnumber,  
 cutnumber,  
 filename[],  
 user_agent[]); 
const char hostname[];
const char username[];
const char passwd[];
const char ticket[];
const unsigned cartnumber;
const unsigned cutnumber;
const char filename[];
const char user_agent[];
 

Description

RD_ExportPeaks is the function to use to export Peak Data from the audio store.

Table 1. RDExportPeaks function call fields

FIELD NAME FIELD TYPE MEANING REMARKS
hostname Character Array Name Of Rivendell DB Host Mandatory When NO Ticket Provided
username Character Array Rivendell User Name Mandatory
passwd Character Array Rivendell User Password Mandatory When NO Ticket Provided
ticket Character Array Rivendell Authentification Ticket Mandatory When NO User/Password Pair Provided.
cartnumber unsigned integer Cart Number Mandatory
cutnumber unsigned integer Cut Number Mandatory
filename character array File Name For Export Peak Data Mandatory
user_agent Character Array User Agent Value put into HTTP request Optional (default is Rivendell-C-API/x.x.x)

RETURN VALUE

On success, zero is returned.

If a server error occurs a -1 is returned. If a client error occurs a specific error number is returned.

ERRORS

400 Missing Cart Number / Cut Number Error.

400 No Peak Data Available.

403 User Authentification Error.

404 UnAuthorized.

404 No Such Cart / Cut.

404 No Audio.

nnn Unknown Error Occurred.