Wprowadzenie
Ten rozdział omawia parametry sieciowego interfejsu administracyjnego serwera Icecast. Poprzez interfejs użytkownik ma możliwość zarządzania działaniem serwera. Z jego poziomu można przejrzeć statystyki, przenieść słuchaczy na inny strumień, odłączać źródła/słuchaczy i nie tylko. Każda z tych funkcji została wyszczególniona w tej sekcji wraz z przykładem jej użytkowania.
Każda z funkcji administracyjnych wymaga uwierzytelnienia poprzez protokół HTTP. Przy użyciu funkcji dotyczących danego strumienia można podać zarówno hasło podane w globalnych parametrach <admin-username> i <admin-password> podanych w odpowiedniej sekcji pliku konfiguracyjnego, lub też danych przypisanych dla danego strumienia (jeśli zostały zdefiniowane). Do standardowych działań administracyjnych należy użyć standardowych danych. W poniższych przykładach przyjęto, że host posiada przypisany adres 192.168.1.10, a serwerowi został przypisany port 8000.
Funkcje administracyjne (strumienia)
Funkcje opisane w tej sekcji mają zastosowanie tylko dla określonego strumienia. Wymagają sprecyzowania nazwy strumienia jako parametru wejściowego.
Aktualizacja danych dodatkowych
opis:
Ta funkcja pozwala klientowi nadawczemu lub innemu oprogramowaniu na zmianę dodatkowych danych informacyjnych (takich jak np. tytuł utworu).
przykład:
http://192.168.1.10:8000/admin/metadata?mount=/mojeradio&mode=updinfo&song=ACDC+Back+In+BlackDefinicja strumienia zapasowego
opis:
Ta funkcja pozwala na aktualizację danych o strumieniu zapasowym danego strumienia. Strumień zapasowy (fallback mountpoint) jest używany w przypadku rozłączenia źródła głównego. Jeśli z jakichś przyczyn źródło główne rozłączy się, wszyscy odbiorcy danego strumienia zostaną przełączeni na przypisany strumień zapasowy.
przykład:
http://192.168.1.10:8000/admin/fallbacks?mount=/mojeradio.ogg&fallback=/zapas.oggLista odbiorców
opis:
Ta funkcja zwraca listę podłączonych odbiorców. Rezultat jej działania zostanie wysłany jako dane XML.
przykład:
http://192.168.1.10:8000/admin/listclients?mount=/mojeradio.oggPrzeniesienie odbiorców
opis:
Ta funkcja umożliwia przeniesienie podłączonych odbiorców na inny strumień. Wymaga ona podania dwóch parametrów: mount (strumień, z którego przenoszeni będą odbiorcy) i destination (strumień docelowy). Po wykonaniu tej funkcji wszyscy podłączeni do zdefiniowanego strumienia zostaną połączeni z docelowym. Strumień docelowy musi istnieć i generować sygnał.
przykład:
http://192.168.1.10:8000/admin/moveclients?mount=/mojeradio.ogg&destination=/zastepczy.oggOdłączanie odbiorców
opis:
Ta funkcja umożliwia odłączenie pojedynczego odbiorcy danego strumienia. Każdy odbiorca otrzymuje unikalny identyfikator, który może zostać uzyskany poprzez listę odbiorców. Identyfikator musi zostać zdefiniowany w żądaniu. Po wykonaniu tej funkcji, odbiorca z podanym identyfikatorem zostanie rozłączony od strumienia.
przykład:
http://192.168.1.10:8000/admin/killclient?mount=/mojeradio.ogg&id=21Odłączenie źródła
opis:
Ta funkcja pozwala na odłączenie wybranego źródła od serwera. Źródło do odłączenia jest definiowane w zmiennej mount.
przykład:
http://192.168.1.10:8000/admin/killsource?mount=/mojeradio.oggFunkcje administracyjne (ogólne)
Statystyki
opis:
Ta funkcja wywołuje wewnętrzne statystyki serwera Icecast. Prawie wszystkie informacje nt. wewnętrznych procesów (takich jak liczba podłączonych źródeł, liczba odebranych zapytań, liczba słuchaczy, etc.) są udostępniane jako wynik działania tej funkcji.
Statystyki mogą być również wyświetlone przez wywołanie zasobu http://serwer:port/admin/stats.xml – tym niemniej to wywołanie nei powinno być używane i być może zostanie usunięte ze specyfikacji serwera.
przykład:
http://192.168.1.10:8000/admin/statsLista strumieni
opis:
Ta funkcja umożliwia podgląd podłączonych źródeł.
przykład:
http://192.168.1.10:8000/admin/listmountsSieciowy interfejs administracyjny
Aby wyeliminować konieczność ręcznego wywoływania wyżej opisanych zapytań, został stworzony sieciowy interfejs administracyjny. Posiada taką samą funkcjonalność jak opisane wyżej komendy, ale jest wygodniejszy dla użytkownika końcowego. Interfejs jest dostarczony wraz z oprogramowaniem w dołączonym folderze admin i jest od razu gotowy do użycia. Wszystko co należy zrobić, to ustawić prawidłową ścieżkę w pliku konfiguracyjnym za pomocą parametru <adminroot>.
Sieciowy interfejs administracyjny stanowi zestaw plików XSLT używanych do przetworzenia i wyświetlenia wartości podanych w zasobach XML. Interfejs może być zmieniany w zależności od potrzeb. Dla potrzeb modyfikacji interfejsu wymagana jest wiedza na temat zmiennych XSLT jak też przetwarzania wartości XML do postaci pliku (X)HTML.
Główny adres interfejsu:
http://192.168.1.10:8000/admin/stats.xslZ niego będą wykonywane inne zadania administracyjne.
Dozwolone jest modyfikowanie zmiennych XSLT, ale nie należy tworzyć nowych plików w folderze z plikami XSLT (/admin). Tworzenie nowych zmiennych XSLT jak też modyfikacja istniejących jest możliwa w folderze interfejsu statystyk (/web). Wartości zwracane są na podstawie zasobu wywołanego przez adres /admin/stats.xml. W celu wywołania dokumentu XML używanego przez określony zbiór XSLT, należy zmienić rozszerzenie .xsl na .xml w zapytaniu (np. /admin/listclients.xml). Można wtedy dokonywać zmian w odpowiednich żądaniach XSLT.