diff --git a/ChangeLog b/ChangeLog index 7c3e863a..87d4fe74 100644 --- a/ChangeLog +++ b/ChangeLog @@ -22680,3 +22680,5 @@ * Added an 'AudioInfo()' method to the 'rivwebpyapi' API. 2021-12-06 Fred Gleason * Added an 'AudioStore()' method to the 'rivwebpyapi' API. +2021-12-06 Fred Gleason + * Added an 'DeleteAudio()' method to the 'rivwebpyapi' API. diff --git a/apis/rivwebpyapi/api/rivwebpyapi.py b/apis/rivwebpyapi/api/rivwebpyapi.py index c60931cd..569bf51c 100755 --- a/apis/rivwebpyapi/api/rivwebpyapi.py +++ b/apis/rivwebpyapi/api/rivwebpyapi.py @@ -537,6 +537,58 @@ class rivwebpyapi(object): return handler.output() + def DeleteAudio(self,cart_number,cut_number): + """ + Delete PCM/MPEG data from the audio store. + + cart_number - The number of the desired cart, in the range + 1 - 999999 (integer) + + cut_number - The number of the desired cut, in the range + 1 - 999 (integer) + """ + + if((cart_number<1)or(cart_number>999999)): + raise ValueError('invalid cart number') + if((cut_number<1)or(cut_number>999)): + raise ValueError('invalid cut number') + + # + # Build the WebAPI arguments + # + postdata={ + 'COMMAND': '3', + 'LOGIN_NAME': self.__connection_username, + 'PASSWORD': self.__connection_password, + 'CART_NUMBER': str(cart_number), + 'CUT_NUMBER': str(cut_number) + } + + # + # Fetch the XML + # + r=requests.post(self.__connection_url,data=postdata) + if(r.status_code!=requests.codes.ok): + r.raise_for_status() + + # + # Generate the output dictionary + # + fields={ + 'cartNumber': 'integer', + 'cutNumber': 'integer', + 'format': 'integer', + 'channels': 'integer', + 'sampleRate': 'integer', + 'bitRate': 'integer', + 'frames': 'integer', + 'length': 'integer' + } + handler=RivWebPyApi_ListHandler(base_tag='audioInfo',fields=fields) + xml.sax.parseString(r.text,handler) + + return handler.output() + def DeleteLog(self,log_name): """ Delete an existing log. diff --git a/apis/rivwebpyapi/tests/Makefile.am b/apis/rivwebpyapi/tests/Makefile.am index 2d26644d..4f24e141 100644 --- a/apis/rivwebpyapi/tests/Makefile.am +++ b/apis/rivwebpyapi/tests/Makefile.am @@ -26,6 +26,7 @@ EXTRA_DIST = add_cart.py\ assign_sched_code.py\ audio_info.py\ audio_store.py\ + delete_audio.py\ delete_log.py\ list_cart.py\ list_cart_sched_codes.py\ diff --git a/apis/rivwebpyapi/tests/delete_audio.py b/apis/rivwebpyapi/tests/delete_audio.py new file mode 100755 index 00000000..7d23333e --- /dev/null +++ b/apis/rivwebpyapi/tests/delete_audio.py @@ -0,0 +1,63 @@ +#!%PYTHON_BANGPATH% + +# delete_audio.py +# +# RivWebPyApi test script for Rivendell +# +# Test the DeleteAudio Web API call +# +# (C) Copyright 2021 Fred Gleason +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License version 2 as +# published by the Free Software Foundation. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public +# License along with this program; if not, write to the Free Software +# Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +# + +import getpass +import rivwebpyapi +import sys + +url=''; +username='' +password='' +cart_number=0 +cut_number=0 + +# +# Get login parameters +# +usage='delete_audio --url= --username= --cart-number= --cut-number= [--password=]' +for arg in sys.argv: + f0=arg.split('=') + if(len(f0)==2): + if(f0[0]=='--url'): + url=f0[1] + if(f0[0]=='--username'): + username=f0[1] + if(f0[0]=='--password'): + password=f0[1] + if(f0[0]=='--cart-number'): + cart_number=int(f0[1]) + if(f0[0]=='--cut-number'): + cut_number=int(f0[1]) + +if(not password): + password=getpass.getpass() +if((not url)or(not username)): + print(usage) + sys.exit(1) + +# +# Get the code list +# +webapi=rivwebpyapi.rivwebpyapi(url=url,username=username,password=password) +webapi.DeleteAudio(cart_number=cart_number,cut_number=cut_number)