Interface: ConsoleOptions

Configuration options set in the console generator

Hierarchy

Index

Properties

Properties

Optional adProviders

• adProviders? : AdProvider[]

Pass in one or more ad providers as an array of objects. This must follow the format described in the API documentation. Ad providers set via options will take precedence over ad providers set in Radioplayer Cloud.

fallback

• fallback: Stream[]

One or more fallback streams used if Radioplayer API is unavailable. In most cases this stream will not be used, so if you need to change your stream details then make the change in Radioplayer Cloud.

id

• id: string

Radioplayer station ID

Optional iframeSrc

• iframeSrc? : undefined | string

Widget iframe src. Ignored unless "IF" widget is specified

Optional isBBC

• isBBC? : undefined | false | true

Switches the player into a mode safe for BBC Sounds

• stationLogo? : undefined | string

Station logo URL

Optional stationUrl

• stationUrl? : undefined | string

Station URL Should be a fully qualified URL (i.e. including http:// or https://). Will be set as a link from the station logo.

Optional theme

• theme? : ThemeType

DARK or LIGHT theme for the transport controls background, text and icons. Can be combined with themeColour

Optional themeColour

• themeColour? : undefined | string

Colour used for transport controls buttons and scrub bar

Optional widgetBackground

• widgetBackground? : undefined | string

The background colour of the area upon which the widgets are placed

Optional widgetColour

• widgetColour? : undefined | string

Custom colour for the background of each widget. The widgetTheme should be set to dark if you're using a dark colour.

Optional widgetHeaderColour

• widgetHeaderColour? : undefined | string

By default the widget headers are darker than the widgetBackground, but if your widgetBackground is already too dark, you can override this color.

Optional widgetOverrides

• widgetOverrides? : WidgetOverrides

Widget contents overrides. If you specify an override for any of the NP, SC, OD widgets, the provided URL will be displayed as an iframe instead of the original widget. For example:

"widgetOverrides": {"SC":{"source":"https://www.radioplayer.co.uk"}}

Optional widgetTheme

• widgetTheme? : ThemeType

DARK or LIGHT theme for the widgets background, text and icons. Can be different from theme

Optional widgets

• widgets? : Widgets[]

Selected widgets: either:

  • "IF": iframe

or one or more of

  • NP: Now Playing
  • SC: Schedule
  • OD: On Demand

You cannot mix "IF" with the other options, as the iframe replaces all other widgets.

The widgets can be specified in any order (e.g. OD, SC, NP) although we do not recommend doing this. The content of an individual widget can be replaced with the `widgetOverride

You must set iframeSrc if you specify "IF". By default, inter-frame messaging is disabled.

See AdvancedOptions to enable iframe messaging