Name

rd_deleteaudio — Rivendell Audio Store C Library Function

Synopsis

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

Description

RD_DeleteAudio is the function to use to delete PCM/MPEG data from the audio store.

Table 1. RD_DeleteAudio function call fields

FIELD NAME FIELD TYPE MEANING REMARKS
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)

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.

403 User Authentification Error.

404 No Such Cut or Invalid Permissions.

nnn Unknown Error Occurred.