README

这是一个针对 RadioBoss API 的 PHP 包装器/客户端。

目录

1. 要求
2. 安装
3. 通用用法
4. 示例

要求

• PHP 7.2 或更高版本。

安装

使用 Composer 安装它

composer require djsoftnet/radioboss-php-api

通用用法

在使用 RadioBoss API 之前，您需要在 RadioBoss 设置 中启用它。激活 API 并设置密码后，您可以检索数据。

<?php

require 'vendor/autoload.php';

$client = new \RadioBoss\RadioBossAPIClient("127.0.0.1", "9000");
$api = new \RadioBoss\RadioBossAPI($client);

示例

• 曲目

  • 从曲目对象获取信息（艺术家，标题，时长等）

    $track->getArtist();
    $track->getTitle();
    $track->getDuration();

  • 获取当前曲目

    $api->getPlaybackInfo()->getCurrentTrack();

  • 获取下一曲目

    $api->getPlaybackInfo()->getNextTrack();

  • 获取上一曲目

    $api->getPlaybackInfo()->getPreviousTrack();

  • 获取最后播放的歌曲

    //all last played songs
    $api->getLastPlayed();
    //filters out songs that were not sent to the server
    $api->getLastPlayed(true);

  • 获取当前或下一曲目的艺术作品

    $api->getTrackArtwork();
    $api->getNextTrackArtwork();

  • 设置下一曲目

    $api->setNextTack(123);

  • 通过文件名读取曲目数据

    $api->readTag("C:\Music\song.mp3");

• 播放列表

  • 从播放列表对象获取数据（曲目，曲目数量）

    $playlist->getTracks();
    $playlist->getCount();

  • 获取播放列表（提供所有信息，对于一些大型播放列表可能较慢）

    //all songs
    $api->getPlaylist();
    //only songs from 5-10
    $api->getPlaylist(5, 10);

  • 获取播放列表（不提供所有信息）

    //all songs
    $api->getPlaylist2();
    //only songs the first 10 songs
    $api->getPlaylist2(10);

• 麦克风

  • 获取麦克风状态

    $api->getMicrophone();

  • 启用/禁用麦克风

    $api->setMicrophone(true);
    $api->setMicrophone(false);

• 播放

  • 从播放对象获取数据（位置，长度，状态等）

    $playback->getPosition();
    $playback->getLength();
    $playback->getState();

  • 获取播放对象

    $api->getPlaybackInfo()->getPlayback();

• 编码器

  • 从编码器对象获取数据（状态，错误等）

    $encoder->getStatus();
    $encoder->getError();

  • 获取编码器对象

    $api->getEncoderStatus();

• 播放器

  • 从播放器对象获取数据（版本，运行时间）

    $player->getVersion();
    $player->getUptime();

  • 获取播放器对象

    $api->getStatus();