MediaCP Manual
Documentação da API

Last updated 6 anos atrás

É possível se conectar e executar várias funções remotamente com o painel de controle usando PHP.

Você será solicitado a baixar e incluir a biblioteca XML-RPC para PHP:
https://code.google.com/archive/p/php-ixr/

Sumário

  1. Funções de administrador
  2. Funções de serviço
  3. Funções de origem

 

Funções de administrador

admin.service_list

Listar todos os serviços MediaCP.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
nome de usuário A conta de usuário da qual listar serviços.
.plugin Não-serviço
shoutcast198
shoutcast2
icecast
wowzaMedia
Flussonic
NginxRtmp
sourceplugin sabão líquido
gelos04
gelos20
sctransv1
sctransv2
streamtranscoderv3
Especifique uma origem (autodj) a ser usada com o serviço, se houver suporte.

Exemplo de PHP

  <?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

Crie um novo serviço de streaming de mídia anexado a uma conta de cliente específica.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
nome de usuário * A conta de usuário para criar o serviço.
userid ALTERNATIVA à especificação do nome de usuário, especifique o userid do cliente.
.plugin* Não-serviço
shoutcast198
shoutcast2
icecast
windowsMediaServices
wowzaMedia
Flussonic
sourceplugin gelos04
gelos20
sctransv1
sctransv2
streamtranscoderv3
Especifique uma origem (autodj) a ser usada com o serviço, se houver suporte.
unique_id * Cadeia de caracteres alfanumérica (sem caracteres especiais permitidos) O Nome de Publicação para identificar o serviço, por exemplo, myShoutcastServer1
portbase INTEIRO Especifique uma porta para o serviço a ser executado, caso contrário, será determinado automaticamente.
rpc_extra BOOL (verdadeiro/falso) Se definido como true retornará uma matriz de toda a configuração de serviço que é criada.
maxuser INT (0-99999) Máximo de conexões com o serviço.
taxa de bits 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 Insira apenas um dos valores na coluna de opções. Isso também pode conter “kbps” no final do valor da opção.
largura de banda INT Transferência de Dados Máxima por mês em MB, especifique 0 para sem limite.
cota Alocação máxima de espaço em disco para o serviço (o padrão é 30). Definido como 0 para nenhum limite.
campos personalizados ARRAY Especifique uma matriz de opções de configuração adicionais específicas do serviço. Você pode identificar os parâmetros disponíveis consultando um serviço existente usando service.overview. Veja abaixo PHP Example para mais informações.

Exemplo de PHP

<?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

Remove permanentemente um serviço de mídia do painel de controle.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
serverid INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.

Exemplo de PHP

<?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

Suspende e interrompe imediatamente um serviço de mídia específico.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.
Razão CORDA O motivo da suspensão
Dias INT Número de dias para suspender o serviço ou especificar “indefinido” para suspensão permanente.

Exemplo de PHP

<?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

Cancela a suspensão do serviço e tenta reiniciar o serviço de mídia.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.
<?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

Atualiza a configuração de um serviço de mídia específico.

A tabela abaixo fornece uma lista mínima de configurações disponíveis, você pode especificar e atualizar qualquer parâmetro que é retornado por service.overview para o serviço específico, observando que cada serviço de mídia (Shoutcast, Icecast, Wowza etc) tem diferentes configurações disponíveis.

Aconselhamos que você não altere os seguintes valores, pois eles podem causar problemas com o seu serviço: plugin, sourceplugin, servicetype, portbase.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
serverid * INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.
nome de usuário A conta de usuário para criar o serviço.
userid ALTERNATIVA à especificação do nome de usuário, especifique o userid do cliente.
maxuser INT (0-99999) Máximo de conexões com o serviço.
taxa de bits 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 Insira apenas um dos valores na coluna de opções. Isso também pode conter “kbps” no final do valor da opção.
largura de banda INT Transferência de Dados Máxima por mês em MB, especifique 0 para sem limite.
cota Alocação máxima de espaço em disco para o serviço (o padrão é 30). Definido como 0 para nenhum limite.

Exemplo de PHP

<?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

Crie uma nova conta de cliente no painel de controle.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
nome de usuário ALFANUMÉRICO Alguns caracteres especiais também são permitidos, como um ponto, sublinhado e símbolo.
hash Uma combinação de hash SHA1 do nome de usuário e senha. Por exemplo: SHA1( ï¿1/2usernameï¿1/2 . ï¿1/2passwordï¿1/2 )
user_level 0 Cliente
2 Super Administrador
nome ALFANUMÉRICO Nome completo dos clientes
reseller_plan INTEIRO Especifique a ID do plano de revendedor se desejar atribuir a conta como revendedor
ativado 0 ou 1
tema Especifique um tema a ser usado para essa conta, caso contrário, o padrão será usado.
Idioma Especifique um idioma a ser usado para essa conta, caso contrário, o padrão será usado.

Exemplo de PHP

<?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

Atualize uma conta de cliente específica.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
nome de usuário * Especifique a conta de usuário que você deseja atualizar
userid ALTERNATIVA ao nome de usuário, especifique a ID do cliente.
hash Uma combinação de hash SHA1 do nome de usuário e senha. Por exemplo: SHA1( ï¿1/2usernameï¿1/2 . ï¿1/2passwordï¿1/2 )
user_level 0 Cliente
2 Super Administrador
nome ALFANUMÉRICO Nome completo dos clientes
ativado 0 ou 1
tema Especifique um tema a ser usado para essa conta, caso contrário, o padrão será usado.
Idioma Especifique um idioma a ser usado para essa conta, caso contrário, o padrão será usado.

Exemplo de PHP

<?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

Remove uma conta de cliente específica.

NOTA: Todos os serviços de mídia sob a conta DEVEM ser removidos antes que a conta de cliente possa ser removida.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
nome de usuário * Especifique a conta de usuário que você deseja atualizar
userid ALTERNATIVA ao nome de usuário, especifique a ID do cliente.

Exemplo de PHP

<?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 ); 
 
?>

Funções de serviço

service.visão geral

Gera uma matriz de toda a configuração do serviço.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor * INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.

Exemplo de PHP

<?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

Retorna o status do serviço com uma das seguintes respostas.

  • falha – Não é possível pesquisar o serviço
  • offline – O serviço está offline.
  • online – O serviço é online
  • suspenso – O serviço está suspenso
  • expirado – O serviço expirou
  • inconectável – O serviço está inacessível

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
serverid INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.

Exemplo de PHP

<?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

Inicia um serviço de mídia específico.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.

Exemplo de PHP

<?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

Interrompe um serviço de mídia específico.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.

Exemplo de PHP

<?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

Reinicia um serviço de mídia específico.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.

Exemplo de PHP

<?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.updatetitle

Atualiza o título Now Playing de uma transmissão ao vivo.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
unique_id INT ALTERNATIVA ao serverid, especifique o unique_id do serviço a ser removido.
NovoTítulo STRING (250 caracteres) Texto para substituir o título atual do Now Playing de uma transmissão ao vivo.

Exemplo de PHP

<?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

Chuta a fonte ativa em uma transmissão ao vivo.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.

Exemplo de PHP

<?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

Gerencie o alias de fluxo de um serviço de mecanismo de streaming Wowza.

Apenas compatível com os serviços do Wowza Streaming Engine.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.
ação criar
retirar
A ação a ser executada com o alias especificado
cognome STRING (50 caracteres) O nome do fluxo de alias que pode ser exibido. rtmp://myserver/myapplication/ myalias
nome STRING (50 caracteres) O fluxo de origem real que será visualizado. Padrão ${Stream.Name}

Exemplo de PHP

<?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

Retornar uma lista de listas de reprodução agendadas de um serviço Wowza TV Station.

Apenas compatível com os serviços do Wowza Streaming Engine.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor * INT A ID de serviço a ser interrompida e removida do painel de controle.
date_start Formato de campo de data/hora do MySQL AAAA-MM-DD HH:MM:DD
date_end Formato de campo de data/hora do MySQL AAAA-MM-DD HH:MM:DD

Exemplo de PHP

<?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

Retorna uma matriz de arquivos agendados em uma lista de reprodução específica da Estação de TV.

Apenas compatível com os serviços do Wowza Streaming Engine.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor * INT A ID de serviço a ser interrompida e removida do painel de controle.
playlist_id INT O ID da lista de reprodução que você deseja recuperar.

Exemplo de PHP

<?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 ); 
 
?>

Funções de origem

source.list_playlists

Retorna uma matriz de listas de reprodução disponíveis que foram criadas na conta do cliente.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.

Exemplo de PHP

<?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 ); 
 
?>

source.status

Retorna o status da origem (AutoDJ).

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.

Exemplo de PHP

<?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

Reinicia o plug-in de origem associado a um serviço específico usando a última lista de reprodução reproduzida.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.

Exemplo de PHP

<?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 ); 
 
?>

source.start

Inicia o plug-in de origem associado a um serviço específico usando a última lista de reprodução reproduzida.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.

Exemplo de PHP

<?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 ); 
 
?>

source.stop

Interrompe o plug-in de origem associado a um serviço específico.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INT A ID de serviço a ser interrompida e removida do painel de controle.

Exemplo de PHP

<?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 ); 
 
?>

source.schedule

Agende para alternar para uma lista de reprodução especificada no horário designado.

Apenas compatível com Shoutcast 198, Shoutcast 2, Icecast 2 e Icecast KH.

Limitado a 50 agendamentos por serviço de mídia.

Parâmetros

Parâmetro Opções Descrição
Auth* Chave de API para autenticar no painel de controle.
ID do Servidor INTEIRO A ID de serviço a ser interrompida e removida do painel de controle.
playlist TEXTO Especifique uma lista de reprodução a ser agendada.
year INTEIRO Especifique o ano inteiro, por exemplo, 2015 ou especifique 0 para o valor recorrente.
month INTEIRO Especifique o valor numérico do mês, por exemplo, 01 seria janeiro ou especifique 0 para o valor recorrente.
dia INTEIRO Especifique o valor numérico do dia, por exemplo, 01 seria o 1º do mês ou especifique 0 para o valor recorrente.
hora Especifique o valor numérico da hora no formato de 24 horas, por exemplo, 16 seria equivalente a 4PM ou especifique 0 para o valor recorrente.
minuto Especifique o valor numérico de minuto.

Exemplo de PHP

<?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