IcecastInputSettings interface

Settings for an Icecast input see: NorskInput.icecast()

Signature:

export interface IcecastInputSettings extends SourceNodeSettings<IcecastInputNode>

Extends: SourceNodeSettings<IcecastInputNode>

Properties

Property Type Description

Property	Type	Description
mounts	string[]	Required: the mount paths this input accepts sources on, e.g. `["/live.mp3"]`
onConnection?	(connection: IcecastSourceConnection) ⇒ IcecastSourceConnectionResult	(Optional) Decide whether to take a source, and name it. Defaults to accepting, named after its mount without the leading `/`.
onDisconnect?	(sourceIndex: number, sourceName?: string) ⇒ void	(Optional) A source has gone. `sourceName` is set when it had been accepted.
onTitle?	(title: string, sourceName: string, sourceIndex: number) ⇒ void	(Optional) A source set its "now playing" title (through Icecast’s `/admin/metadata`)
password?	string	(Optional) The source password. When omitted any credentials pass the listener, and `onConnection` decides (it is given the user and password sent).
port?	number	(Optional) The port to listen on. Defaults to 8000. Inputs on the same port share one listener.
startupThreshold?	InputThresholdSettings	(Optional) when specified, drop data until the input is ticking at realtime, so a startup burst does not set the media T0
timeDomain?	TimeDomain	(Optional) Optionally place this input into a named time domain
user?	string	(Optional) Source user name. Defaults to `"source"`.

mounts

string[]

Required: the mount paths this input accepts sources on, e.g. ["/live.mp3"]

onConnection?

(connection: IcecastSourceConnection) ⇒ IcecastSourceConnectionResult

(Optional) Decide whether to take a source, and name it. Defaults to accepting, named after its mount without the leading /.

onDisconnect?

(sourceIndex: number, sourceName?: string) ⇒ void

(Optional) A source has gone. sourceName is set when it had been accepted.

onTitle?

(title: string, sourceName: string, sourceIndex: number) ⇒ void

(Optional) A source set its "now playing" title (through Icecast’s /admin/metadata)

password?

string

(Optional) The source password. When omitted any credentials pass the listener, and onConnection decides (it is given the user and password sent).

port?

number

(Optional) The port to listen on. Defaults to 8000. Inputs on the same port share one listener.

startupThreshold?

InputThresholdSettings

(Optional) when specified, drop data until the input is ticking at realtime, so a startup burst does not set the media T0

timeDomain?

TimeDomain

(Optional) Optionally place this input into a named time domain

user?

string

(Optional) Source user name. Defaults to "source".