IcecastOutputSettings interface

Settings for an Icecast output see: NorskOutput.icecast()

Signature:

export interface IcecastOutputSettings extends SinkNodeSettings<IcecastOutputNode>

Extends: SinkNodeSettings<IcecastOutputNode>

Properties

Property Type Description

bitrate?

number

(Optional) Bitrate in bits/s when encoding. Defaults to 128000 (MP3) / 96000 (AAC).

codec?

"mp3" | "aac"

(Optional) The codec to send. Audio in any other codec is encoded to this one on the way in. Defaults to "mp3" (audio/mpeg); "aac" is sent ADTS framed as audio/aac.

onStatus?

(status: IcecastOutputStatus) ⇒ void

(Optional) Called as the connection to the Icecast server changes state

password

string

Required: the source password (Icecast’s source-password, or the mount’s own).

retryConnectionTimeout?

number

(Optional) Seconds between connection attempts after a failure. Defaults to 5.

sslOptions?

{ verifyPeerCert?: boolean; }

(Optional)

streamInfo?

{ name?: string; description?: string; url?: string; genre?: string; public?: boolean; }

(Optional) The stream’s directory entry. Icecast uses each field only where the mount’s own configuration does not already set it.

url

string

Required: the mount to publish to, e.g. http://icecast.example.com:8000/live.mp3. Use https:// for a TLS listener. The port defaults to 8000.

user?

string

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