help with XML-RPC API

Hi,

LS guys, please help me find documentation about XML RPC
functions (if they existed) for the
following purposes:

- interrogate the LS archive (this should return a list of
items):
    * can be a simple list of n elements, starting with
element m
    * filter by author, title etc.
    * search by keyword
- download an item from LS archive
- upload an iterm to the LS archive

If there are no such XML RPC functions then they must be
implemented for the radio package.

Thanks,
Mugur


__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection
around 
http://mail.yahoo.com 

On Wed, 27 Sep 2006 21:03:37 +0200 (CEST) Mugur Rus wrote:
> Hi,
> 
> LS guys, please help me find documentation about XML
RPC functions (if they existed) for the
> following purposes:
> 
> - interrogate the LS archive (this should return a list
of items):
>     * can be a simple list of n elements, starting with
element m
>     * filter by author, title etc.
>     * search by keyword
> - download an item from LS archive
> - upload an iterm to the LS archive
> 
> If there are no such XML RPC functions then they must
be implemented for the radio package.
> 
> Thanks,
> Mugur
> 
> 
> __________________________________________________
> Do You Yahoo!?
> Tired of spam?  Yahoo! Mail has the best spam
protection around 
> http://mail.yahoo.com 

Hi Mugur,

methods with functionality listed above (and source docs for
doxygen)
can be found here in LS source tree:
livesupport/src/modules/storageServer/var/xmlrpc/XR_LocStor.
php

look for methods:
locstor.searchMetadata
locstor.downloadRawAudioDataOpen
locstor.storeAudioClipOpen
etc.

remark: storage functions often have open and close XML-RPC
methods.

Tomáš Hlava
thlavaemail.cz

On 9/27/06, Mugur Rus <mugur1973yahoo.com> wrote:
> LS guys, please help me find documentation about XML
RPC functions (if they existed) for the
> following purposes:

see http://livesupport-doc.campware.org/xm
l-rpc_doc/html/classXR__LocStor.html


> - interrogate the LS archive (this should return a list
of items):
>     * can be a simple list of n elements, starting with
element m
>     * filter by author, title etc.
>     * search by keyword

searchMetadata


> - download an item from LS archive

- to get the metadata: downloadMetadataOpen +
downloadMetadataClose
- to get a temporary URL pointing to the sound file, for
playback:
accessRawAudioData + releaseRawAudioData
- there is also a downloadRawAudioDataOpen/Close


> - upload an iterm to the LS archive

storeAudioClipOpen + storeAudioClipClose.

Ferenc

Sorry, I didn't see that Tomas had answered already.

Thank you guys!

--- Ferenc Gerlits <fgerlitsgmail.com> wrote:
> On 9/27/06, Mugur Rus <mugur1973yahoo.com> wrote:
> > LS guys, please help me find documentation about
XML RPC functions (if they existed) for the
> > following purposes:
> 
> see http://livesupport-doc.campware.org/xm
l-rpc_doc/html/classXR__LocStor.html
> 
> 
> > - interrogate the LS archive (this should return a
list of items):
> >     * can be a simple list of n elements, starting
with element m
> >     * filter by author, title etc.
> >     * search by keyword
> 
> searchMetadata
> 
> 
> > - download an item from LS archive
> 
> - to get the metadata: downloadMetadataOpen +
downloadMetadataClose
> - to get a temporary URL pointing to the sound file,
for playback:
> accessRawAudioData + releaseRawAudioData
> - there is also a downloadRawAudioDataOpen/Close
> 
> 
> > - upload an iterm to the LS archive
> 
> storeAudioClipOpen + storeAudioClipClose.
> 
> Ferenc
> 


__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection
around 
http://mail.yahoo.com 

I sent the reply to a different thread by mistake, here is
the reply again:

1. in storeAudioClipOpen there is this parameter: gunid :
string - global unique id of AudioClip
How do I generate the gunid? The audio file doesn't exist
yet in the LS archive.

2. in storeAudioClipOpen there is this parameter: metadata :
string - metadata XML string
Where do I find documentation of the structure of the
metadata XML string?

3. accessRawAudioData returns:
    - url : string - local access url
    - token : string - access token
Do I use HTTP GET do download the audio file? How do I use
the token?

Thanks,
Mugur

--- Ferenc Gerlits <fgerlitsgmail.com> wrote:
> On 9/27/06, Mugur Rus <mugur1973yahoo.com> wrote:
> > LS guys, please help me find documentation about
XML RPC functions (if they existed) for the
> > following purposes:
> 
> see http://livesupport-doc.campware.org/xm
l-rpc_doc/html/classXR__LocStor.html
> 
> 
> > - interrogate the LS archive (this should return a
list of items):
> >     * can be a simple list of n elements, starting
with element m
> >     * filter by author, title etc.
> >     * search by keyword
> 
> searchMetadata
> 
> 
> > - download an item from LS archive
> 
> - to get the metadata: downloadMetadataOpen +
downloadMetadataClose
> - to get a temporary URL pointing to the sound file,
for playback:
> accessRawAudioData + releaseRawAudioData
> - there is also a downloadRawAudioDataOpen/Close
> 
> 
> > - upload an iterm to the LS archive
> 
> storeAudioClipOpen + storeAudioClipClose.
> 
> Ferenc
> 


__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection
around 
http://mail.yahoo.com 

Mugur Rus wrote:
> I sent the reply to a different thread by mistake, here
is the reply again:
> 
> 1. in storeAudioClipOpen there is this parameter: gunid
: string - global unique id of AudioClip
> How do I generate the gunid? The audio file doesn't
exist yet in the LS archive.

If the gunid parameter is missing, a new unique ID will be
generated by 
the server (which is returned by the Close method).


> 2. in storeAudioClipOpen there is this parameter:
metadata : string - metadata XML string
> Where do I find documentation of the structure of the
metadata XML string?

Yes, that *could* be a bit better documented...  It is a
string 
containing a complete XML document, starting with
"<?xml ... ?> 
<audioClip>", and ending with
"</audioClip>".  There are several 
examples in

http:
//code.campware.org/projects/livesupport/browser/trunk/lives
upport/src/modules/storageServer/var/tests

(all the files with the extension "xml").  There
is a list of possible 
metadata fields here:

http://livesupport-doc.campware.org/gui/metadataField
s.html

dc:title (Title), dc:creator (Artist) are compulsory, others
are 
optional; dcterms:extent (Length) will be filled in by the
storage 
server if it's missing.  [TOMAS: please correct me if I'm
wrong.]


> 3. accessRawAudioData returns:
>     - url : string - local access url
>     - token : string - access token
> Do I use HTTP GET do download the audio file?

Yes.

 > How do I use the token?

It is needed by the releaseRawAudioData method.

Ferenc

On Thu, 28 Sep 2006 14:30:33 +0200 (CEST) Ferenc Gerlits
wrote:
> ...
> > 2. in storeAudioClipOpen there is this parameter:
metadata : string - metadata XML string
> > Where do I find documentation of the structure of
the metadata XML string?
> 
> Yes, that *could* be a bit better documented...

*** Yes, it's true - documentation have been updated in
XR_LocStor.php now.

> ...It is a string 
> containing a complete XML document, starting with
"<?xml ... ?> 
> <audioClip>", and ending with
"</audioClip>".
>
> ...
>
> There is a list of possible 
> metadata fields here:
> 
> http://livesupport-doc.campware.org/gui/metadataField
s.html
> 
> dc:title (Title), dc:creator (Artist) are compulsory,
others are 
> optional; dcterms:extent (Length) will be filled in by
the storage 
> server if it's missing.  [TOMAS: please correct me if
I'm wrong.]

*** No, currently not - if dcterms:extent is missing in the
metadata XML
    it will cause error from validator (dcterms:extent is
required node in
    metadata format)

> ...

Tomáš Hlava
thlavaemail.cz

Thanks guys!

Mugur

--- Tomas Hlava <thlavaemail.cz> wrote:
> On Thu, 28 Sep 2006 14:30:33 +0200 (CEST) Ferenc
Gerlits wrote:
> > ...
> > > 2. in storeAudioClipOpen there is this
parameter: metadata : string - metadata XML string
> > > Where do I find documentation of the
structure of the metadata XML string?
> > 
> > Yes, that *could* be a bit better documented...
> 
> *** Yes, it's true - documentation have been updated in
XR_LocStor.php now.
> 
> > ...It is a string 
> > containing a complete XML document, starting with
"<?xml ... ?> 
> > <audioClip>", and ending with
"</audioClip>".
> >
> > ...
> >
> > There is a list of possible 
> > metadata fields here:
> > 
> > http://livesupport-doc.campware.org/gui/metadataField
s.html
> > 
> > dc:title (Title), dc:creator (Artist) are
compulsory, others are 
> > optional; dcterms:extent (Length) will be filled
in by the storage 
> > server if it's missing.  [TOMAS: please correct me
if I'm wrong.]
> 
> *** No, currently not - if dcterms:extent is missing in
the metadata XML
>     it will cause error from validator (dcterms:extent
is required node in
>     metadata format)
> 
> > ...
> 
> Tomáš Hlava
> thlavaemail.cz
> 


__________________________________________________
Do You Yahoo!?
Tired of spam?  Yahoo! Mail has the best spam protection
around 
http://mail.yahoo.com