Documentation

Radio
in package
implements RadioInterface

FinalYes

Handle radio streams using TuneIn.

Table of Contents

Interfaces

RadioInterface

Constants

SHOWS  : int = 1
STATIONS  : int = 0

Properties

$controller  : ControllerInterface

Methods

__construct()  : mixed
Create a new instance.
getFavouriteShow()  : Stream
Get the favourite radio show with the specified name.
getFavouriteShows()  : array<string|int, Stream>
Get the favourite radio shows.
getFavouriteStation()  : Stream
Get the favourite radio station with the specified name.
getFavouriteStations()  : array<string|int, Stream>
Get the favourite radio stations.
getFavourites()  : array<string|int, Stream>
Get the favourite radio shows/stations.

Constants

SHOWS

private int SHOWS = 1

The key for show types.

STATIONS

private int STATIONS = 0

The key for station types.

Properties

Methods

getFavouriteShow()

Get the favourite radio show with the specified name.

public getFavouriteShow(string $name) : Stream

If no case-sensitive match is found it will return a case-insensitive match.

Parameters
$name : string

The name of the show

Return values
Stream

getFavouriteShows()

Get the favourite radio shows.

public getFavouriteShows() : array<string|int, Stream>
Return values
array<string|int, Stream>

getFavouriteStation()

Get the favourite radio station with the specified name.

public getFavouriteStation(string $name) : Stream

If no case-sensitive match is found it will return a case-insensitive match.

Parameters
$name : string

The name of the station

Return values
Stream

getFavouriteStations()

Get the favourite radio stations.

public getFavouriteStations() : array<string|int, Stream>
Return values
array<string|int, Stream>

getFavourites()

Get the favourite radio shows/stations.

protected getFavourites(int $type) : array<string|int, Stream>
Parameters
$type : int

One of the class constants for either shows or stations

Return values
array<string|int, Stream>
On this page

Search results