radio-co-wrapper
v0.0.2
Published
This library provides an easy-to-use Angular service and component to integrate Radio.co streams into Angular applications. Utilizing the Radio.co API, this wrapper enables Angular developers to embed Radio.co radio players seamlessly in their web applica
Downloads
2
Readme
Angular Wrapper for Radio.co API
This library provides an easy-to-use Angular service and component to integrate Radio.co streams into Angular applications. Utilizing the Radio.co API, this wrapper enables Angular developers to embed Radio.co radio players seamlessly in their web applications, providing controls for play, pause, volume adjustment, and more.
Features
- Easy-to-implement Radio.co player component
- Support for play, pause, volume control, and other player functionalities
- Customizable player options to fit the look and feel of your application
- Event handling to respond to player state changes
Installation
Install the library with npm:
npm install angular-radio-co-wrapper --save
Peer Dependencies
This library depends on jQuery. Ensure jQuery is included in your project:
npm install jquery --save
Add jQuery to your angular.json file:
"scripts": [
"node_modules/jquery/dist/jquery.min.js"
]
Usage
- Import the RadioCoAngularWrapperModule in your AppModule:
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { RadioCoAngularWrapperModule } from 'angular-radio-co-wrapper';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
RadioCoAngularWrapperModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
- Use the lib-radio-co-wrapper component in your component's template:
<lib-radio-co-wrapper [stationUrl]="'https://streaming.radio.co/your_station/listen'" [autoplay]="false" [volume]="50"></lib-radio-co-wrapper>
Inputs
The lib-radio-co-wrapper component accepts the following inputs:
- stationUrl: The URL of your Radio.co station stream (required).
- autoplay: Whether the stream should start playing automatically (default: false).
- volume: Initial volume of the player (0 to 100).
Development
To run the library locally for development:
- Clone the repo
- Install dependencies with npm install
- Link the library to a local Angular project or use the Angular CLI to serve any test applications included in the workspace.
Contributing
Contributions to improve the library are welcome. Please follow the standard fork & pull request workflow.
License
This project is licensed under the MIT License - see the LICENSE file for details.