mardi 12 avril 2011

Karotz API - full Php Class


Karotz Php Class - Rel. 1.0b màj 24-04-2011

La version 1.0b de la "Wizz.cc Karotz Class for Php" est en ligne... On accède, au travers de cette classe, à toutes les fonctionnalités de l'Api Web du Karotz publiée par Mindscape.

Cela facilitera le développement des applis web et notamment la migration des sites Nabaztag...

Fichier Zip.

Utilisation :

1 - Inclusion : include('wizz.cc_karotz_class.php');

2 - Instanciation : $Kz = new wizz_karotz($interactiveid, true); (true or false for debug_mode)

3 - Commandes :
$result = $Kz->say('Wizz php class for karotz', 'en');
ou : echo $Kz->ears(2, 5);
ou : $Kz->led_light('FF0000');

$Kz->quit();

4 - Contrôle du résultat si nécessaire : if($Kz->get_responsecode()=='OK') echo 'Cool';

Méthodes implémentées :

$Kz->say($text, $lang)
$Kz->ears($left, $right, $relative)
$Kz->ears_reset()
$Kz->led_pulse($color, $period, $pulse)
$Kz->led_fade($color, $period)
$Kz->led_light($color)
$Kz->play($url)
$Kz->play('previous|next|pause'|'resume'|'stop')
$Kz->play('allsong::'|'title::xx'|'artist::xx'|'folder::xx'|'genre::xx')
$Kz->usb_unlock()
$Kz->usb_allsong()
$Kz->usb_folder()
$Kz->usb_artist()
$Kz->usb_genre
$Kz->usb_playlist()
$Kz->photo($url)
$Kz->video()
$Kz->chor($chor) - not yet released by the Kz DevTeam
$Kz->chor_file($url)
$Kz->chor_stop()
$Kz->config()
$Kz->quit()

Différentes informations sont accessibles : deboggage, paramètres de l'api, réponse des serveurs Karotz (VoosMsg), erreurs rencontrées... :

VoosMsg :
echo $Kz->get_voosmsgid();
echo $Kz->get_correlationid();
echo $Kz->get_interactiveid();
echo $Kz->get_responsecode();
print_r($Kz->get_api_params());
echo $Kz->get_api_response();
print_r($Kz->get_api_resp_array());
echo $Kz->get_api_error();
echo $Kz->isDebug();
echo $Kz->showDebug();

Les informations retournées peuvent changer en fonction de l'api appelée.

Un exemple complet est fourni dans le zip.

Cette classe est maintenue à jour régulièrement en fonction des publications/évolutions apportées à l'Api par Violet/Mindscape[RIP].