Download the PHP package dweb-x/volumio without Composer

On this page you can find all versions of the php package dweb-x/volumio. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package volumio

Volumio API wrapper for Laravel

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Introduction

This package provides a simple and elegant way to interact with the Volumio audio player API from your Laravel application. Volumio is a free and open source Linux distribution designed for music playback with a focus on sound quality.

With this package, you can:

This package is compatible with Laravel 12 and connects to the Volumio REST API.

Official Docs

Installation

You can install the package via composer:

You can publish the config file with:

This is the contents of the published config file:

Configuration

The package comes with a configuration file that allows you to customize how the Volumio API client behaves. Here's a detailed explanation of each configuration option:

Base URL

This is the URL of your Volumio instance. By default, it points to http://localhost:3000, which is the standard address for a Volumio instance running on the same machine. If your Volumio instance is running on a different machine or port, you should set the VOLUMIO_API_URL environment variable in your .env file:

Timeout

This setting controls how long (in seconds) the client will wait for a response from the Volumio API before timing out. The default is 10 seconds, which should be sufficient for most use cases. If you're experiencing timeout issues, you can increase this value in your .env file:

Retries

If an API request fails, the client will automatically retry the request. This setting controls how many retry attempts will be made before giving up. The default is 3 retries. You can adjust this in your .env file:

The client uses an exponential backoff strategy for retries, meaning each subsequent retry will wait longer before attempting again.

HTTP Options

These are the default HTTP headers that will be sent with every request to the Volumio API. The default headers are set to work with the Volumio API's JSON responses. You typically won't need to modify these.

Usage

You can use the facade to interact with the Volumio API:

Or you can inject the Volumio service:

Response Format

All methods return an array containing the response from the Volumio API. The exact structure of the response depends on the method called. For example:

Error Handling

The package will automatically retry failed requests based on your configuration. If all retry attempts fail, an exception will be thrown. You should wrap your API calls in a try-catch block to handle potential errors:

Testing

Credits

License

The MIT License (MIT). Please see License File for more information.


All versions of volumio with dependencies

PHP Build Version
Package Version
Requires php Version ^8.4
guzzlehttp/guzzle Version ^7.9
spatie/laravel-package-tools Version ^1.16
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package dweb-x/volumio contains the following files

Loading the files please wait ...