MediaCP Manual
API-documentatie

Last updated 6 jaren ago

Het is mogelijk om op afstand verbinding te maken met en verschillende functies uit te voeren met het bedieningspaneel met behulp van PHP.

U moet de XML-RPC-bibliotheek voor PHP downloaden en opnemen:
https://code.google.com/archive/p/php-ixr/

Inhoudsopgave

  1. Admin-functies
  2. Servicefuncties
  3. Bronfuncties

 

Admin-functies

admin.service_list

Maak een lijst van alle MediaCP-services.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
gebruikersnaam Het gebruikersaccount waaruit u services wilt weergeven.
.plugin Geen service
shoutcast198
shoutcast2
ijskast
WowzaMedia
Flussonic
NginxRtmp
sourceplugin liquidsoap
ices04
ices20
Sctransv1
Sctransv2
streamtranscoderv3
Geef een bron (autodj) op die met de service moet worden gebruikt als deze wordt ondersteund.

PHP Voorbeeld

  <?php
   require_once("../IXR_Library.php");

   $url = "https://demo.mediacp.net/";
   $command = "admin.service_list";
   $arguments = array(
   "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw=="
   )
   );

   $client = new IXR_ClientSSL($url. '/system/rpc.php');
   $client->debug = true; /** Set to true if you have difficulties **/

   if ( !$client->query( $command, $arguments) ) {
   die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage());
   }

   $return = $client->getResponse();

   if ( $return['status'] == 'success' ){
   echo $command. ' executed successfully.';
   }else{
   echo 'failed executing '. $command;
   }

   /** Output debugging information **/
   print_r( $return );

   ?>

admin.service_create

Maak een nieuwe mediastreamingservice die is gekoppeld aan een specifiek klantaccount.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
gebruikersnaam * Het gebruikersaccount om service op aan te maken.
Userid ALTERNATIEF voor het opgeven van gebruikersnaam, geef in plaats daarvan de gebruikersid van de klant op.
.plugin* Geen service
shoutcast198
shoutcast2
ijskast
WindowsMediaServices
WowzaMedia
Flussonic
sourceplugin ices04
ices20
Sctransv1
Sctransv2
streamtranscoderv3
Geef een bron (autodj) op die met de service moet worden gebruikt als deze wordt ondersteund.
unique_id * Alfanumerieke tekenreeks (geen speciale tekens toegestaan) De publicatienaam om de service te identificeren, bijvoorbeeld myShoutcastServer1
havenbasis GEHEEL GETAL Geef een poort op waarop de service moet worden uitgevoerd, anders wordt deze automatisch bepaald.
rpc_extra BOOL (waar/onwaar) Als deze is ingesteld op true, wordt een array geretourneerd van de volledige serviceconfiguratie die is gemaakt.
Maxuser INT (0-99999) Maximale verbindingen met de service.
bitraat 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 400, 480, 560, 640, 720, 800, 920, 1024, 1280, 1536, 1792, 2048, 2560, 3072, 3584, 4096, 99999 Voer slechts een van de waarden in de kolomopties in. Dit kan ook “kbps” aan het eind van de optiewaarde bevatten.
bandbreedte INT Maximale gegevensoverdracht per maand in MB, geef 0 op voor geen limiet.
quotum Maximale schijfruimtetoewijzing voor service (standaard ingesteld op 30). Stel in op 0 voor geen limiet.
Customfields ARRAY Geef een array met aanvullende servicespecifieke configuratieopties op. U kunt de beschikbare parameters identificeren door een query uit te voeren op een bestaande service met service.overview. Zie hieronder PHP Voorbeeld voor meer informatie.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.service_create"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "username" => "admin", 
 "plugin" => "shoutcast198", 
 "sourceplugin" => "",
 "password" => "mypassword", 
 "maxuser" => "25", 
 "bitrate" => "48", 
 "bandwidth" => "10240", 
 "quota" => "1024", 
 "customfields" => array(
 "rtmpenabled" => "yes"
 )
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

admin.service_remove

Hiermee verwijdert u een mediaservice permanent uit het configuratiescherm.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Serverid INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.service_remove"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "serverid" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

admin.service_suspend

Hiermee wordt een specifieke mediaservice opgeschort en onmiddellijk gestopt.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.
Reden SNAAR De reden voor schorsing
Dagen INT Aantal dagen om de service op te schorten voor, of “onbepaald” op te geven voor permanente opschorting.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.service_suspend"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10, 
 "Reason" => "Failed to complete payment", 
 "Days" => 30
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

admin.service_unsuspend

Hiermee wordt de service opgeheven en wordt geprobeerd de mediaservice opnieuw te starten.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.
<?php
 require_once("../IXR_Library.php");

 $url = "http://localhost/mediacp/";
 $command = "admin.service_unsuspend";
 $arguments = array(
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==",
 "ServerID" => 10,
 );

 $client = new IXR_Client($url. '/system/rpc.php');
 $client->debug = true; /** Set to true if you have difficulties **/

 if ( !$client->query( $command, $arguments) ) {
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage());
 }

 $return = $client->getResponse();

 if ( $return['status'] == 'success' ){
 echo $command. ' executed successfully.';
 }else{
 echo 'failed executing '. $command;
 }

 /** Output debugging information **/
 print_r( $return );

?>

admin.service_update

Hiermee wordt de configuratie van een specifieke mediaservice bijgewerkt.

De onderstaande tabel biedt een minimale lijst met beschikbare configuraties, u kunt elke parameter opgeven en bijwerken die wordt geretourneerd door service.overview voor de specifieke service, waarbij u opmerkt dat elke Media Service (Shoutcast, Icecast, Wowza enz.) verschillende configuraties beschikbaar heeft.

We raden u aan de volgende waarden niet te wijzigen, omdat deze problemen met uw service kunnen veroorzaken: plug-in, sourceplugin, servicetype, portbase.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Serverid * INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.
gebruikersnaam Het gebruikersaccount om service op aan te maken.
Userid ALTERNATIEF voor het opgeven van gebruikersnaam, geef in plaats daarvan de gebruikersid van de klant op.
Maxuser INT (0-99999) Maximale verbindingen met de service.
bitraat 24, 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256, 320, 400, 480, 560, 640, 720, 800, 920, 1024, 1280, 1536, 1792, 2048, 2560, 3072, 3584, 4096, 99999 Voer slechts een van de waarden in de kolomopties in. Dit kan ook “kbps” aan het eind van de optiewaarde bevatten.
bandbreedte INT Maximale gegevensoverdracht per maand in MB, geef 0 op voor geen limiet.
quotum Maximale schijfruimtetoewijzing voor service (standaard ingesteld op 30). Stel in op 0 voor geen limiet.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.service_update"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "serverid" => 10, 
 
 "password" => "mypassword", 
 "maxuser" => "25", 
 "bitrate" => "48", 
 "bandwidth" => "10240", 
 "quota" => "1024"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

admin.user_create

Maak een nieuw klantaccount in het configuratiescherm.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
gebruikersnaam ALFANUMERIEK Sommige speciale tekens zijn ook toegestaan, zoals een punt, onderstrepingsteken en bij-symbool.
hekje Een SHA1 hash combinatie van gebruikersnaam en wachtwoord. Bijvoorbeeld: SHA1( ï¿1/2usernameï¿1/2 . ï¿1/2passwordï¿1/2 )
user_level 0 Klant
2 Hoofdbeheerder
naam ALFANUMERIEK Klanten Volledige naam
reseller_plan GEHEEL GETAL Geef de resellerplan-id op als u het account als reseller wilt toewijzen
Geactiveerd 0 of 1
thema Geef een thema op dat u voor dit account wilt gebruiken, anders wordt de standaardinstelling gebruikt.
Taal Geef een taal op die voor dit account moet worden gebruikt, anders wordt de standaardinstelling gebruikt.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.user_create"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "username" => "[email protected]", 
 "hash" => SHA1("[email protected]" . "mypassword"), 
 "user_level" => 0,
 "name" => "My Customer", 
 "activated" => 1, 
 "reseller_plan" => 1,
 "theme" => "Experience", 
 "language" => "english"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

admin.user_update

Werk een specifiek klantaccount bij.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
gebruikersnaam * Geef het gebruikersaccount op dat u wilt bijwerken
Userid ALTERNATIEF voor de gebruikersnaam, geef de klant-ID op.
hekje Een SHA1 hash combinatie van gebruikersnaam en wachtwoord. Bijvoorbeeld: SHA1( ï¿1/2usernameï¿1/2 . ï¿1/2passwordï¿1/2 )
user_level 0 Klant
2 Hoofdbeheerder
naam ALFANUMERIEK Klanten Volledige naam
Geactiveerd 0 of 1
thema Geef een thema op dat u voor dit account wilt gebruiken, anders wordt de standaardinstelling gebruikt.
Taal Geef een taal op die voor dit account moet worden gebruikt, anders wordt de standaardinstelling gebruikt.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.user_update"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "username" => "[email protected]", 
 "hash" => SHA1("[email protected]" . "mynewpassword"), 
 "user_level" => 0,
 "name" => "My Customer", 
 "activated" => 1, 
 "reseller_plan" => 1,
 "theme" => "Experience", 
 "language" => "english"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

admin.user_remove

Hiermee verwijdert u een specifiek klantaccount.

OPMERKING: Alle mediaservices onder het account MOETEN worden verwijderd voordat het klantaccount kan worden verwijderd.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
gebruikersnaam * Geef het gebruikersaccount op dat u wilt bijwerken
Userid ALTERNATIEF voor de gebruikersnaam, geef de klant-ID op.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "admin.user_remove"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "username" => "[email protected]", 
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

Servicefuncties

service.overzicht

Voert een array uit van de gehele serviceconfiguratie.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
ServerID * INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.overview"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.status

Retourneert de status van de service met een van de volgende antwoorden.

  • mislukt – Kan service niet opzoeken
  • offline – Service is offline.
  • online – Service is online
  • opgeschort – Service is opgeschort
  • verlopen – Service is verlopen
  • niet-verbonden – Service is onbereikbaar

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Serverid INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.status"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "serverid" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.start

Hiermee start u een specifieke mediaservice.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.start"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

Service.stop

Stopt een specifieke mediaservice.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.stop"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.restart

Hiermee start u een specifieke mediaservice opnieuw.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.restart"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.updatetitel

Hiermee wordt de titel Nu afspelen van een livestream bijgewerkt.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
unique_id INT ALTERNATIEF voor serverid, geef de unique_id op van de service die moet worden verwijderd.
Nieuwe titel STRING (250 tekens) Tekst ter vervanging van de huidige nu afgespeelde titel van een livestream.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.updatetitle"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10,
 "NewTitle" => "This control panel is the greatest"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.kicksource

Schopt de actieve bron op een livestream.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.kicksource"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.wowza_alias

Beheer de Stream Alias’ van een Wowza Streaming Engine Service.

Alleen compatibel met Wowza Streaming Engine-services.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
actie scheppen
verwijderen
De actie die moet worden uitgevoerd met de opgegeven alias
alias STRING (50 tekens) De aliasstreamnaam die kan worden bekeken. rtmp://myserver/myapplication/ myalias
naam STRING (50 tekens) De werkelijke oorsprongsstroom die wordt bekeken. Standaard ${Stream.Name}

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.wowza_alias"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10,
 "alias" => "myalias",
 "name" => "${Stream.Name}"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.wowza_tvschedule

Retourneer een lijst met geplande afspeellijsten van een Wowza TV Station-service.

Alleen compatibel met Wowza Streaming Engine-services.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
ServerID * INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
date_start MySQL datetime veldnotatie JJJJ-MM-DD HH:MM:DD
date_end MySQL datetime veldnotatie JJJJ-MM-DD HH:MM:DD

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.wowza_alias"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10,
 "date_start" => "2015-01-01 00:00:00",
 "date_end" => "2015-01-01 23:00:00"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

service.wowza_tvschedule_playlist

Retourneert een array van geplande bestanden in een specifieke tv-station-afspeellijst.

Alleen compatibel met Wowza Streaming Engine-services.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
ServerID * INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
playlist_id INT De afspeellijst-id die u wilt ophalen.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "service.wowza_alias"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10,
 "playlist_id" => "1"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

Bronfuncties

source.list_playlists

Retourneert een array van beschikbare afspeellijsten die zijn gemaakt onder het klantaccount.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "source.list_playlists"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

bron.status

Retourneert de status van de bron (AutoDJ).

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "source.status"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10 
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

source.restart

Hiermee start u de bronplug-in opnieuw op die is gekoppeld aan een specifieke service met behulp van de laatst afgespeelde afspeellijst.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "source.restart"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10 
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

bron.start

Start de bronplug-in die is gekoppeld aan een specifieke service met behulp van de laatst afgespeelde afspeellijst.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "source.start"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10 
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

bron.stop

Hiermee stopt u de bronplug-in die aan een specifieke service is gekoppeld.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id INT De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "source.stop"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10 
 );  
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

bron.schema

Plan om over te schakelen naar een opgegeven afspeellijst op het aangegeven tijdstip.

Alleen compatibel met Shoutcast 198, Shoutcast 2, Icecast 2 & Icecast KH.

Beperkt tot 50 schema’s per mediaservice.

Parameters

Parameter Opties Beschrijving
Auth* API-sleutel om te verifiëren bij het configuratiescherm.
Server-id GEHEEL GETAL De service-id die moet worden gestopt en verwijderd uit het configuratiescherm.
afspeellijst SMS Geef een afspeellijst op die u wilt plannen.
year GEHEEL GETAL Geef het volledige jaar op, bijvoorbeeld 2015 of geef 0 op voor de terugkerende waarde.
month GEHEEL GETAL Geef de numerieke waarde van de maand op, bijvoorbeeld 01 is januari of geef 0 op voor de terugkerende waarde.
dag GEHEEL GETAL Geef de numerieke waarde van de dag op, bijvoorbeeld 01 is de 1e van de maand of geef 0 op voor de terugkerende waarde.
uur Geef de numerieke waarde van uur op in de notatie 24 uur, bijvoorbeeld 16 zou gelijk zijn aan 4PM of opgeven 0 voor terugkerende waarde.
minuut Geef de numerieke waarde van minuut op.

PHP Voorbeeld

<?php
 require_once("../IXR_Library.php"); 
 
 $url = "http://localhost/mediacp/";
 $command = "source.schedule"; 
 $arguments = array( 
 "auth" => "VJhZdqjUWpigishesXamoVSp33WZmoxWoZ-7XJysWs6coKyd0K2Glw==", 
 "ServerID" => 10,
 "playlist" => "myplaylist",
 "year" => "2015",
 "month" => "0",
 "day" => "1",
 "hour" => "09",
 "minute" => "00"
 ); 
 
 $client = new IXR_Client($url. '/system/rpc.php'); 
 $client->debug = true; /** Set to true if you have difficulties **/ 
 
 if ( !$client->query( $command, $arguments) ) { 
 die('An error occurred - '.$client->getErrorCode().":".$client->getErrorMessage()); 
 } 
 
 $return = $client->getResponse(); 
 
 if ( $return['status'] == 'success' ){ 
 echo $command. ' executed successfully.'; 
 }else{ 
 echo 'failed executing '. $command; 
 } 
 
 /** Output debugging information **/ 
 print_r( $return ); 
 
?>

Table of Contents