RD_AudioInfo
7
October 2015
Rivendell C Library Manual
rd_audioinfo
Rivendell Audio Info C Library Function
Todd
Baker
bakert@rfa.org
Rivendell C Library Author
#include <rivwebcapi/rd_audioinfo.h>
int RD_AudioInfo
struct rd_audioinfo * audioinfo[]
const char hostname[]
const char username[]
const char passwd[]
const char ticket[]
const unsigned cartnumber
const unsigned cutnumber
const char user_agent[]
unsigned * numrecs
Description
RD_AudioInfo is the function to use
to get information about an entry in the audio store.
RD_AudioInfo function call fields
FIELD NAME
FIELD TYPE
MEANING
REMARKS
*rd_audioinfo
Pointer to rd_audioinfo structure
Memory location to store specific audioinfo data
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.
cartnumber
unsigned integer
Cart Number
Mandatory
cutnumber
unsigned integer
Cut Number
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 a rd_audioinfo structure which
is stored in the provided memory locations. The rd_audioinfo structure has the following fields:
struct rd_audioinfo {
unsigned cart_number; /* Cart Number */
unsigned cut_number; /* Cut Number */
int format;
int channels;
int samplerate;
unsigned frames;
unsigned length;
};
RETURN VALUE
On success, zero is returned. Using the provided parameters an rd_audioinfo
structure is returned and the number of records 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.
400 Unknown Audio Format.
403 User Authentification Error.
404 No Such Cart Exists.
404 No Such Audio Exists.
nnn Unknown Error Occurred.