@norskvideo/norsk-sdk 0.0.328 → 0.0.330

package/dist/norsk-sdk.d.ts

@@ -1,10 +1,12 @@
 import { AudioCodec } from '@norskvideo/norsk-api/lib/media_pb';
+import { CmafAudioMessage } from '@norskvideo/norsk-api/lib/media_pb';
+import { CmafMasterMessage } from '@norskvideo/norsk-api/lib/media_pb';
+import { CmafVideoMessage } from '@norskvideo/norsk-api/lib/media_pb';
+import { CmafWebVttMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { Context } from '@norskvideo/norsk-api/lib/media_pb';
 import { CurrentLoad } from '@norskvideo/norsk-api/lib/shared/common_pb';
 import { ExplicitChannel } from '@norskvideo/norsk-api/lib/media_pb';
 import * as grpc from '@grpc/grpc-js';
-import { HlsAudioMessage } from '@norskvideo/norsk-api/lib/media_pb';
-import { HlsMasterMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsMasterPushMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsOutputEvent } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsTsAudioMessage } from '@norskvideo/norsk-api/lib/media_pb';
@@ -12,8 +14,6 @@ import { HlsTsAudioPushMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsTsCombinedPushMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsTsVideoMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsTsVideoPushMessage } from '@norskvideo/norsk-api/lib/media_pb';
-import { HlsVideoMessage } from '@norskvideo/norsk-api/lib/media_pb';
-import { HlsWebVttMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { HlsWebVttPushMessage } from '@norskvideo/norsk-api/lib/media_pb';
 import { MediaClient } from '@norskvideo/norsk-api/lib/media_grpc_pb';
 import { Nullable } from 'typescript-nullable';
@@ -49,6 +49,11 @@ export declare class AudioBuildMultichannelNode extends AutoProcessorMediaNode<"
 /** @public */
 export declare interface AudioBuildMultichannelSettings extends ProcessorNodeSettings<AudioBuildMultichannelNode> {
     channelLayout: ChannelLayout;
+    /**
+     * Stream keys specifying the source for each channel, where the order is
+     * significant. The streams must all have the same sample format and sample
+     * rate.
+     */
     channelList: readonly StreamKey[];
     outputStreamKey: StreamKey;
 }
@@ -158,11 +163,11 @@ export declare class AudioMixerNode<Pins extends string> extends ProcessorMediaN
 
 /** @public */
 export declare interface AudioMixerSettings<Pins extends string> extends ProcessorNodeSettings<AudioMixerNode<Pins>> {
-    /** The sources to mix */
+    /** The audio sources to mix */
     sources: readonly AudioMixerSource<Pins>[];
-    /** The name of the output source */
+    /** The source name to use for the output stream */
     outputSource: string;
-    /** The sample rate of the output */
+    /** The sample rate that the mixer runs at */
     sampleRate?: SampleRate;
 }
 
@@ -246,13 +251,22 @@ declare class AutoProcessorMediaNode<Pins extends string> {
 
 /** @public */
 export declare class AutoSinkMediaNode<Pins extends string> extends SinkMediaNode<Pins | "auto"> {
-    /** Subscribe to the given sources
+    /** Subscribe to the given sources.
+     *
      * This version of subscribe simply requires a list of stream keys to be
      * returned from each selector, and the server will automatically
-     * assign each stream to the appropriate pin on the sink node
-     * This is the appropriate method for most cases
+     * assign each stream to the appropriate pin on the sink node.
+     * This is the appropriate method for most cases.
+     *
+     * @param done - will be called with no arguments if the subscription succeeds,
+     * or an error if it failed. This error indicates the specific reason it
+     * failed, so you can take appropriate actions in response. It will be called
+     * before the `subscribedStreamsChangedFn` or `subscribeErrorFn` callbacks
+     * provided in the config for the node.
+     *
+     * Errors are also logged to the debug log.
      */
-    subscribe(sources: ReceiveFromAddressAuto[], validation?: (context: Context) => boolean): void;
+    subscribe(sources: ReceiveFromAddressAuto[], validation?: (context: Context) => boolean, done?: (error?: SubscriptionError) => void): void;
 }
 
 /** @public */
@@ -289,11 +303,13 @@ export declare class AwsTranscribeNode extends AutoProcessorMediaNode<"audio"> {
 
 /** @public */
 export declare interface AwsTranscribeSettings extends ProcessorNodeSettings<AwsTranscribeNode> {
+    /** Region for the transcribe endpoint */
     awsRegion: string;
     outputStreamId: number;
     language: string;
     sentenceBuildMode: SentenceBuildMode;
     sentenceStabilizationMode: StabilizationMode;
+    awsCredentials?: AwsCredentials;
 }
 
 /**
@@ -487,11 +503,84 @@ export declare interface ChaosMonkeySettings extends ProcessorNodeSettings<Chaos
     frameDrop?: DropRandom | DropEvery;
 }
 
+/**
+ * @public
+ * {@link NorskOutput.cmafAudio}
+ */
+export declare class CmafAudioOutputNode extends HlsNodeWithPlaylist<CmafAudioMessage, "audio", CmafAudioOutputNode> {
+    updateCredentials(settings: UpdateCredentials): void;
+}
+
+/** @public */
+export declare interface CmafAudioOutputSettings extends SinkNodeSettings<CmafAudioOutputNode> {
+    segmentDurationSeconds: number;
+    partDurationSeconds: number;
+    delayOutputMs?: number;
+    encryption?: {
+        encryptionKey: string;
+        encryptionKeyId: string;
+    };
+    destinations: CMAFDestinationSettings[];
+}
+
 /** @public */
 export declare type CMAFDestinationSettings = HlsPushDestinationSettings | AwsS3PushDestinationSettings | LocalPullDestinationSettings;
 
+/**
+ * @public
+ * {@link NorskOutput.cmafMaster}
+ */
+export declare class CmafMasterOutputNode extends CommonHlsNode<CmafMasterMessage, "video" | "audio" | "subtitle", CmafMasterOutputNode> {
+    /** @public The URL of the master playlist */
+    playlistUrl: string;
+    updateCredentials(settings: UpdateCredentials): void;
+}
+
+/** @public */
+export declare interface CmafMasterOutputSettings extends SinkNodeSettings<CmafMasterOutputNode> {
+    playlistName: string;
+    pathPrefix?: string;
+    destinations: CMAFDestinationSettings[];
+}
+
+/**
+ * @public
+ * {@link NorskOutput.cmafVideo}
+ */
+export declare class CmafVideoOutputNode extends HlsNodeWithPlaylist<CmafVideoMessage, "video", CmafVideoOutputNode> {
+    updateCredentials(settings: UpdateCredentials): void;
+}
+
+/** @public */
+export declare interface CmafVideoOutputSettings extends SinkNodeSettings<CmafVideoOutputNode> {
+    segmentDurationSeconds: number;
+    partDurationSeconds: number;
+    delayOutputMs?: number;
+    sessionId?: string;
+    id: string;
+    encryption?: {
+        encryptionKey: string;
+        encryptionKeyId: string;
+    };
+    destinations: CMAFDestinationSettings[];
+}
+
+/**
+ * @public
+ * {@link NorskOutput.cmafWebVtt}
+ */
+export declare class CmafWebVttOutputNode extends HlsNodeWithPlaylist<CmafWebVttMessage, "subtitle", CmafWebVttOutputNode> {
+}
+
+/** @public */
+export declare interface CmafWebVttOutputSettings extends SinkNodeSettings<CmafWebVttOutputNode> {
+    segmentDurationSeconds: number;
+    sessionId?: string;
+    delayOutputMs?: number;
+}
+
 declare class CommonHlsNode<ClientMessage, Pins extends string, T extends MediaNodeState> extends AutoSinkMediaNode<Pins> {
-    constructor(client: MediaClient, settings: NodeSettings<T> & StreamStatsMixin, grpcInit: () => grpc.ClientDuplexStream<ClientMessage, HlsOutputEvent>, subscribeFn: (subscription: Subscription) => void, subscribedStreamsChangedFn?: (streams: StreamMetadata[]) => void);
+    constructor(client: MediaClient, settings: SinkNodeSettings<T> & StreamStatsMixin, grpcInit: () => grpc.ClientDuplexStream<ClientMessage, HlsOutputEvent>, subscribeFn: (subscription: Subscription) => void, subscribedStreamsChangedFn?: (streams: StreamMetadata[]) => void);
     close(): void;
 }
 
@@ -509,13 +598,47 @@ export declare type ComposeMissingStreamBehaviour =
 
 /** @public */
 export declare interface ComposePart<Pins> {
+    /** Input pin for this source */
     pin: Pins;
+    /**
+     * The area within the source picture to include. This may be the full picture
+     * or cropped, and will be rescaled if necessary.
+     */
     sourceRect: OffsetRect;
+    /**
+     * The area within the destination picture to place this part of the
+     * composition.
+     */
     destRect: OffsetRect;
+    /**
+     * Z-index to determine ordering by which the sources are overlaid
+     * (higher layers appear on top)
+     */
     zIndex: number;
+    /**
+     * Opacity multiplier of this overlay (where 0.0 is fully transparent and 1.0
+     * is fully opaque)
+     */
     opacity: number;
+    /** Optionally identify the part to enable transitions */
     id?: string;
+    /**
+     * Optionally specify a transition for this part. A transition is applied only
+     * if the part is specified in both the existing and the current/new
+     * configuration, identified by having the same id specified, and a transition
+     * is specified for the new configuration.
+     */
     transition?: PartTransition;
+    /**
+     * Optionally supply a reference resolution. This allows description of the
+     * composition in a desired coordinate system, e.g. a resolution of 100x100
+     * can be specified to allow the source and destination areas to be described
+     * in percentage terms, or a notional resolution can be used that is
+     * independant of the source resolutions that may be provided.
+     *
+     * If unset, this will be overriden by a global reference resolution if present
+     *
+     */
     referenceResolution?: Resolution;
 }
 
@@ -530,20 +653,64 @@ export declare class ComposeVideoNode<Pins extends string> extends ProcessorMedi
 
 /** @public */
 export declare interface ComposeVideoSettings<Pins extends string> extends ProcessorNodeSettings<ComposeVideoNode<Pins>> {
+    /**
+     * Required. Stream key of the reference stream. This is the video stream
+     * which defines the output frame timing, which will typically be part of the
+     * composition, e.g. the main picture in the case of a simple
+     * overlay/picture-in-picture, or the top left quadrant of a 4-way split
+     * screen.
+     */
     referenceStream: Pins;
+    /** The parts (images/overlays) to include in the composition */
     parts: readonly ComposePart<Pins>[];
+    /**
+     * Optionally supply a fallback reference resolution. This allows description of the
+     * composition in a desired coordinate system, e.g. a resolution of 100x100
+     * can be specified to allow the source and destination areas to be described
+     * in percentage terms, or a notional resolution can be used that is
+     * independant of the source resolutions that may be provided.
+     *
+     * if set here, this reference resolution will be applied to
+     * any parts that do not have their own reference resolution specified
+     *
+     * If not provided the source and destination rectangles are in terms of the
+     * source and output resolutions respectively.
+     */
     referenceResolution?: Resolution;
+    /** The resolution of the output video */
     outputResolution: Resolution;
+    /**
+     * Output pixel format to use. If not specified, this will be chosen
+     * automatically based on the sources present in the initial composition
+     */
     outputPixelFormat?: PixelFormat;
+    /**
+     * Behaviour in the case of a missing stream used in an active composition
+     * part. Note that this does not apply to the reference stream, but to every
+     * part which does not use the reference stream, whether at startup or on
+     * context change.
+     *
+     * Missing means not present in the context or never having sent a frame.
+     */
     missingStreamBehaviour?: ComposeMissingStreamBehaviour;
+    /**
+     * Called when the transitions specified in the last config update have
+     * completed (in the case of multiple parts with specified transitions of
+     * different duration, this means that the last remaining transitions have
+     * completed
+     */
     onTransitionComplete?: () => void;
 }
 
 /** @public */
 export declare interface ComposeVideoSettingsUpdate<Pins extends string> {
+    /** Update the parts (images/overlays) to include in the composition */
     parts: readonly ComposePart<Pins>[];
 }
 
+/** @public */
+export declare type ContextType = "full" | "singleSource" | "singleProgram" | "singleStream" | "singleRendition";
+
 /** @public */
 export declare interface Core {
     logicalCpuIds: LogicalCpuId[];
@@ -670,43 +837,6 @@ export declare interface HardwareInfo {
     deckLinkCards: DeckLinkCard[];
 }
 
-/**
- * @public
- * {@link NorskOutput.hlsAudio}
- */
-export declare class HlsAudioOutputNode extends HlsNodeWithPlaylist<HlsAudioMessage, "audio", HlsAudioOutputNode> {
-    updateCredentials(settings: UpdateCredentials): void;
-}
-
-/** @public */
-export declare interface HlsAudioOutputSettings extends NodeSettings<HlsAudioOutputNode> {
-    segmentDurationSeconds: number;
-    partDurationSeconds: number;
-    delayOutputMs?: number;
-    encryption?: {
-        encryptionKey: string;
-        encryptionKeyId: string;
-    };
-    destinations: CMAFDestinationSettings[];
-}
-
-/**
- * @public
- * {@link NorskOutput.hlsMaster}
- */
-export declare class HlsMasterOutputNode extends CommonHlsNode<HlsMasterMessage, "video" | "audio" | "subtitle", HlsMasterOutputNode> {
-    /** @public The URL of the master playlist */
-    playlistUrl: string;
-    updateCredentials(settings: UpdateCredentials): void;
-}
-
-/** @public */
-export declare interface HlsMasterOutputSettings extends NodeSettings<HlsMasterOutputNode> {
-    playlistName: string;
-    pathPrefix?: string;
-    destinations: CMAFDestinationSettings[];
-}
-
 /**
  * @public
  * {@link NorskOutput.hlsMasterPush}
@@ -715,17 +845,17 @@ export declare class HlsMasterPushOutputNode extends CommonHlsNode<HlsMasterPush
 }
 
 /** @public */
-export declare interface HlsMasterPushOutputSettings extends NodeSettings<HlsMasterPushOutputNode> {
+export declare interface HlsMasterPushOutputSettings extends SinkNodeSettings<HlsMasterPushOutputNode> {
     playlistName: string;
     destination: CMAFDestinationSettings;
 }
 
 declare class HlsNodeWithPlaylist<ClientMessage, Pins extends string, T extends MediaNodeState> extends CommonHlsNode<ClientMessage, Pins, T> {
-    constructor(client: MediaClient, settings: NodeSettings<T> & StreamStatsMixin, grpcInit: () => grpc.ClientDuplexStream<ClientMessage, HlsOutputEvent>, subscribeFn: (subscription: Subscription) => void);
+    constructor(client: MediaClient, settings: SinkNodeSettings<T> & StreamStatsMixin, grpcInit: () => grpc.ClientDuplexStream<ClientMessage, HlsOutputEvent>, subscribeFn: (subscription: Subscription) => void);
     /** @public
      * Returns the URL to the HLS playlist entry.  Note this can only be evaluated once the stream is active as it
      * varies with the stream subscribed to.  Useful during development, but you probably want to
-     * use {@link NorskOutput.hlsMaster} for production.
+     * use {@link NorskOutput.cmafMaster} for production.
      */
     url(): Promise<string>;
 }
@@ -749,7 +879,7 @@ export declare class HlsTsAudioOutputNode extends CommonHlsNode<HlsTsAudioMessag
 }
 
 /** @public */
-export declare interface HlsTsAudioOutputSettings extends NodeSettings<HlsTsAudioOutputNode> {
+export declare interface HlsTsAudioOutputSettings extends SinkNodeSettings<HlsTsAudioOutputNode> {
     segmentDurationSeconds: number;
     delayOutputMs?: number;
 }
@@ -762,7 +892,7 @@ export declare class HlsTsAudioPushOutputNode extends CommonHlsNode<HlsTsAudioPu
 }
 
 /** @public */
-export declare interface HlsTsAudioPushOutputSettings extends NodeSettings<HlsTsAudioPushOutputNode> {
+export declare interface HlsTsAudioPushOutputSettings extends SinkNodeSettings<HlsTsAudioPushOutputNode> {
     segmentDurationSeconds: number;
     delayOutputMs?: number;
     destination: CMAFDestinationSettings;
@@ -776,7 +906,7 @@ export declare class HlsTsCombinedPushOutputNode extends CommonHlsNode<HlsTsComb
 }
 
 /** @public */
-export declare interface HlsTsCombinedPushOutputSettings extends NodeSettings<HlsTsCombinedPushOutputNode> {
+export declare interface HlsTsCombinedPushOutputSettings extends SinkNodeSettings<HlsTsCombinedPushOutputNode> {
     segmentDurationSeconds: number;
     delayOutputMs?: number;
     destination: CMAFDestinationSettings;
@@ -791,7 +921,7 @@ export declare class HlsTsVideoOutputNode extends CommonHlsNode<HlsTsVideoMessag
 }
 
 /** @public */
-export declare interface HlsTsVideoOutputSettings extends NodeSettings<HlsTsVideoOutputNode> {
+export declare interface HlsTsVideoOutputSettings extends SinkNodeSettings<HlsTsVideoOutputNode> {
     segmentDurationSeconds: number;
     delayOutputMs?: number;
 }
@@ -804,48 +934,12 @@ export declare class HlsTsVideoPushOutputNode extends CommonHlsNode<HlsTsVideoPu
 }
 
 /** @public */
-export declare interface HlsTsVideoPushOutputSettings extends NodeSettings<HlsTsVideoPushOutputNode> {
+export declare interface HlsTsVideoPushOutputSettings extends SinkNodeSettings<HlsTsVideoPushOutputNode> {
     segmentDurationSeconds: number;
     delayOutputMs?: number;
     destination: CMAFDestinationSettings;
 }
 
-/**
- * @public
- * {@link NorskOutput.hlsVideo}
- */
-export declare class HlsVideoOutputNode extends HlsNodeWithPlaylist<HlsVideoMessage, "video", HlsVideoOutputNode> {
-    updateCredentials(settings: UpdateCredentials): void;
-}
-
-/** @public */
-export declare interface HlsVideoOutputSettings extends NodeSettings<HlsVideoOutputNode> {
-    segmentDurationSeconds: number;
-    partDurationSeconds: number;
-    delayOutputMs?: number;
-    sessionId?: string;
-    id: string;
-    encryption?: {
-        encryptionKey: string;
-        encryptionKeyId: string;
-    };
-    destinations: CMAFDestinationSettings[];
-}
-
-/**
- * @public
- * {@link NorskOutput.hlsWebVtt}
- */
-export declare class HlsWebVttOutputNode extends HlsNodeWithPlaylist<HlsWebVttMessage, "subtitle", HlsWebVttOutputNode> {
-}
-
-/** @public */
-export declare interface HlsWebVttOutputSettings extends NodeSettings<HlsWebVttOutputNode> {
-    segmentDurationSeconds: number;
-    sessionId?: string;
-    delayOutputMs?: number;
-}
-
 /**
  * @public
  * {@link NorskOutput.hlsWebVttPush}
@@ -853,7 +947,8 @@ export declare interface HlsWebVttOutputSettings extends NodeSettings<HlsWebVttO
 export declare class HlsWebVttPushOutputNode extends CommonHlsNode<HlsWebVttPushMessage, "subtitle", HlsWebVttPushOutputNode> {
 }
 
-export declare interface HlsWebVttPushOutputSettings extends NodeSettings<HlsWebVttPushOutputNode> {
+/** @public */
+export declare interface HlsWebVttPushOutputSettings extends SinkNodeSettings<HlsWebVttPushOutputNode> {
     segmentDurationSeconds: number;
     delayOutputMs?: number;
     destination: CMAFDestinationSettings;
@@ -1024,7 +1119,7 @@ export declare class Mp4FileOutputNode extends AutoSinkMediaNode<"audio" | "vide
  * @public
  * Settings to control MP4 file output
  */
-export declare interface Mp4FileOutputSettings extends NodeSettings<Mp4FileOutputNode>, StreamStatsMixin {
+export declare interface Mp4FileOutputSettings extends SinkNodeSettings<Mp4FileOutputNode>, StreamStatsMixin {
     /**
      * Required: stream fragmented MP4 to this file.
      */
@@ -1202,6 +1297,8 @@ export declare interface NorskControl {
      * Record statistical information about media streams, including bitrate,
      * frame rate, and number of keyframes, measured over some configurable
      * sampling windows.
+     *
+     * Corresponding settings are found on many input and output nodes.
      * @param settings - Callback and sampling intervals
      */
     streamStats(settings: StreamStatsSettings): Promise<StreamStatsNode>;
@@ -1237,6 +1334,10 @@ export declare interface NorskInput {
      * @param settings - Configuration for the RTMP server
      */
     rtmpServer(settings: RtmpServerInputSettings): Promise<RtmpServerInputNode>;
+    /**
+     * Read from a Transport Stream file with realtime playback.
+     * @param settings - Configuration for the file input
+     */
     localTsFile(settings: LocalFileInputSettings): Promise<TsFileInputNode>;
     /**
      * Stream from a SRT source
@@ -1292,9 +1393,9 @@ export declare interface NorskInput {
  *  * Methods that allow you to egest media from your application
  */
 export declare interface NorskOutput {
-    hlsVideo(settings: HlsVideoOutputSettings): Promise<HlsVideoOutputNode>;
-    hlsAudio(settings: HlsAudioOutputSettings): Promise<HlsAudioOutputNode>;
-    hlsWebVtt(settings: HlsWebVttOutputSettings): Promise<HlsWebVttOutputNode>;
+    cmafVideo(settings: CmafVideoOutputSettings): Promise<CmafVideoOutputNode>;
+    cmafAudio(settings: CmafAudioOutputSettings): Promise<CmafAudioOutputNode>;
+    cmafWebVtt(settings: CmafWebVttOutputSettings): Promise<CmafWebVttOutputNode>;
     hlsWebVttPush(settings: HlsWebVttPushOutputSettings): Promise<HlsWebVttPushOutputNode>;
     hlsTsVideo(settings: HlsTsVideoOutputSettings): Promise<HlsTsVideoOutputNode>;
     tsUdp(settings: TsUdpOutputSettings): Promise<TsUdpOutputNode>;
@@ -1303,10 +1404,15 @@ export declare interface NorskOutput {
     hlsTsVideoPush(settings: HlsTsVideoPushOutputSettings): Promise<HlsTsVideoPushOutputNode>;
     hlsTsAudioPush(settings: HlsTsAudioPushOutputSettings): Promise<HlsTsAudioPushOutputNode>;
     hlsTsCombinedPush(settings: HlsTsCombinedPushOutputSettings): Promise<HlsTsCombinedPushOutputNode>;
-    hlsMaster(settings: HlsMasterOutputSettings): Promise<HlsMasterOutputNode>;
+    cmafMaster(settings: CmafMasterOutputSettings): Promise<CmafMasterOutputNode>;
     hlsMasterPush(settings: HlsMasterPushOutputSettings): Promise<HlsMasterPushOutputNode>;
     webRTCWhip(settings: WebRTCWhipOutputSettings): Promise<WebRTCWhipOutputNode>;
     rtmp(settings: RtmpOutputSettings): Promise<RtmpOutputNode>;
+    /**
+     * Stream to a Transport Stream file.
+     *
+     * @param settings - Configuration for the Transport Stream output
+     */
     localTsFile(settings: TsFileOutputSettings): Promise<TsFileOutputNode>;
     /**
      * Output MP4 files to disk, both fragmented and non-fragmented.
@@ -1315,13 +1421,15 @@ export declare interface NorskOutput {
      *
      * The optional non-fragmented filename will be written when calling
      * {@link Mp4FileOutputNode.close} and will be fully written by the time
-     * {@link NodeSettings.onEnd} is called. This sets up a temp file to
+     * {@link NodeSettings.onClose} is called. This sets up a temp file to
      * store the frame data by appending the extension `.tmp`.
      *
      * A non-fragmented MP4 file can be written on request with
      * {@link Mp4FileOutputNode.writeFile}, which uses the frame data store if
      * {@link Mp4FileOutputSettings.nonfragmentedFileName} was given or reads
      * back the fragmented mp4 if there is no non-fragmented file.
+     *
+     * @param settings - Configuration for the MP4 output.
      */
     localMp4File(settings: Mp4FileOutputSettings): Promise<Mp4FileOutputNode>;
 }
@@ -1398,9 +1506,14 @@ export declare interface NorskTransform {
     chaosMonkey(settings: ChaosMonkeySettings): Promise<ChaosMonkeyNode>;
     /**
      * Compose multiple video streams together into a single output
-     * @param settings - Composition setting
+     * @param settings - Composition settings
      */
     composeOverlay<Pins extends string>(settings: ComposeVideoSettings<Pins>): Promise<ComposeVideoNode<Pins>>;
+    /**
+     * Create a Media Node performing transcription into subtitles using the
+     * Amazon Transcribe AWS service.
+     * @param settings - Settings and credentials for AWS transcribe
+     */
     awsTranscribe(settings: AwsTranscribeSettings): Promise<AwsTranscribeNode>;
     /**
      * Mix multiple audio streams together into a single output,
@@ -1418,12 +1531,63 @@ export declare interface NorskTransform {
      * @param settings - Settings for the gain node
      */
     audioGain(settings: AudioGainSettings): Promise<AudioGainNode>;
+    /**
+     * Aggregate many single-channel audio streams into a stream with the
+     * specified channel layout. The streams must all have the same sample format
+     * and sample rate. The order of the streams provided for the channels is
+     * important.
+     * @param settings - Settings for the builder, including the channel layout
+     * and stream keys specifying the sources for each channel.
+     */
     audioBuildMultichannel(settings: AudioBuildMultichannelSettings): Promise<AudioBuildMultichannelNode>;
+    /**
+     * Split a multichannel audio stream into its individual channels. The first
+     * channel receives the specified stream key, and each subsequent channel
+     * increments the stream id on the stream key.
+     * @param settings - Settings for the splitter
+     */
     audioSplitMultichannel(settings: AudioSplitMultichannelSettings): Promise<AudioSplitMultichannelNode>;
+    /**
+     * Encode an audio stream.
+     * @param settings - Settings for the encoder, including channel layout and
+     * bitrate.
+     */
     audioEncoder(settings: AudioEncoderSettings): Promise<AudioEncoderNode>;
+    /**
+     * A node to nudge the timestamps on a stream, which affects how it syncs
+     * with other streams. Useful for correcting for drift between different
+     * sources.
+     *
+     * Subsequent nudges, via the `nudge` method, are applied gradually.
+     *
+     * This functionality is also provided by a `nudge` method on many sources.
+     * @param settings - Initial nudge plus general node settings.
+     */
     timestampNudge(settings: TimestampNudgerSettings): Promise<TimestampNudgerNode>;
+    /**
+     * Provide a new stream key for a single stream. Cannot be subscribed to
+     * multiple streams at once.
+     *
+     * The stream key is used for identifying streams within multiplexed sources
+     * and also is translated into URIs for HLS playlists and other resources.
+     * @param settings - New stream key plus general node settings.
+     */
     streamKeyOverride(settings: StreamKeyOverrideSettings): Promise<StreamKeyOverrideNode>;
+    /**
+     * Override bitrate and language metadata on streams.
+     *
+     * Audio and video bitrate metadata is required for playlists for both
+     * {@link NorskOutput.cmafMaster} and {@link NorskOutput.hlsMasterPush}
+     * nodes. It is automatically configured for some sources (like RTMP) and in
+     * cases where re-encoding is done, but is unset for other sources (like SRT).
+     * @param settings - Bitrate and language metadata plus general node settings.
+     */
     metadataOverride(settings: MetadataOverrideSettings): Promise<MetadataOverrideNode>;
+    /**
+     * Sync multiple streams together by timestamps, queuing frames from streams
+     * that are behind the others. This is already included in most nodes,
+     * especially outputs.
+     */
     sync(settings: SyncSettings): Promise<SyncNode>;
 }
 
@@ -1524,9 +1688,22 @@ export declare interface OpusSettings {
     kind: "opus";
 }
 
-/** @public */
+/** @public
+ * A transition for a video composition part.
+ *
+ * A transition interpolates the source_rect, dest_rect, and opacity properties
+ * over the specified duration according to the specified easing function.
+ *
+ * As a special case, if a transition is specified and the input pin of the part
+ * changes, an opacity fade from one to the other will occur.
+ */
 export declare interface PartTransition {
+    /** Duration for the transition */
     durationMs: number;
+    /**
+     * Easing function to apply to the transition. If not specified will be
+     * linear.
+     */
     easing?: SimpleEasing;
 }
 
@@ -1588,7 +1765,7 @@ export declare class RtmpOutputNode extends AutoSinkMediaNode<"audio" | "video">
 }
 
 /** @public */
-export declare interface RtmpOutputSettings extends NodeSettings<RtmpOutputNode>, StreamStatsMixin {
+export declare interface RtmpOutputSettings extends SinkNodeSettings<RtmpOutputNode>, StreamStatsMixin {
     url: string;
     numberOfStreams?: number;
 }
@@ -1608,7 +1785,7 @@ export declare class RtmpServerInputNode extends SourceMediaNode {
  */
 export declare interface RtmpServerInputSettings extends SourceNodeSettings<RtmpServerInputNode>, StreamStatsMixin {
     /** The port the RTMP server should listen on */
-    port: number;
+    port?: number;
     /**
      * On connect callback, use to accept/reject connections given app/url in use
      * @eventProperty
@@ -1720,7 +1897,15 @@ export declare interface SampleAspectRatio {
 }
 
 /** @public */
-export declare type SampleFormat = "flt" | "fltp" | "s16" | "s16p";
+export declare type SampleFormat = 
+/** Signed 16 bits, non-planar */
+"s16"
+/** Signed 16 bits, planar */
+| "s16p"
+/** 32bit floating point, non-planar */
+| "flt"
+/** 32bit floating point, planar */
+| "fltp";
 
 /** @public Audio sample rate, in Hz */
 export declare type SampleRate = 8000 | 11025 | 12000 | 16000 | 22050 | 24000 | 32000 | 44100 | 48000 | 64000 | 88200 | 96000;
@@ -1762,13 +1947,28 @@ export declare interface SingleStreamStats extends StreamStats {
 
 /** @public */
 export declare class SinkMediaNode<Pins extends string> extends MediaNodeState {
-    /** Subscribe to the given sources,
+    /** Subscribe to the given sources.
+     *
      * This version of the function call accepts the target pins of an output
      * and is suitable for advanced use where a node is capable of subscribing to
      * multiple video streams and provides a means of distinguishing them via pins
-     * discarding any existing subscriptions */
-    subscribeToPins(sources: ReceiveFromAddress<Pins>[], validation?: (context: Context) => boolean): void;
-    sourceContextChange(responseCallback: () => void): Promise<void>;
+     * discarding any existing subscriptions.
+     *
+     * @param done - will be called with no arguments if the subscription succeeds,
+     * or an error if it failed. This error indicates the specific reason it
+     * failed, so you can take appropriate actions in response. It will be called
+     * before the `subscribedStreamsChangedFn` or `subscribeErrorFn` callbacks
+     * provided in the config for the node.
+     *
+     * Errors are also logged to the debug log.
+     */
+    subscribeToPins(sources: ReceiveFromAddress<Pins>[], validation?: (context: Context) => boolean, done?: (error?: SubscriptionError) => void): void;
+    sourceContextChange(responseCallback: (error?: SubscriptionError) => void): Promise<void>;
+}
+
+/** @public */
+export declare interface SinkNodeSettings<T extends MediaNodeState> extends NodeSettings<T> {
+    onSubscriptionError?: (error: SubscriptionError) => void;
 }
 
 /**
@@ -1801,6 +2001,44 @@ export declare interface SourceNodeSettings<T extends MediaNodeState> extends No
     onOutboundContextChange?: (streams: StreamMetadata[]) => Promise<void>;
 }
 
+/**
+ * @public
+ * Errors found while subscribing to a particular source, separated out by reason:
+ *
+ * - `internal`: An opaque internal error
+ *
+ * - `unknownSourceId`: The media node does not exist (maybe it crashed)
+ *
+ * - `unknownSourceStream`: The media node exists, but does not have the stream key
+ *
+ * - `noSubscriberPin`: The media node is not set up to receive data on this pin (which may be auto-detected)
+ *
+ * - `unsupportedConversion`: Norsk does not support conversion from the media types of the source to the media types accepted by the subscriber
+ */
+export declare type SourceSubscriptionError = {
+    info: string;
+    reason: "internal";
+} | {
+    mediaNodeId: MediaNodeId;
+    reason: "unknownSourceId";
+} | {
+    mediaNodeId: MediaNodeId;
+    streamKey: StreamKey;
+    reason: "unknownSourceStream";
+} | {
+    mediaNodeId: MediaNodeId;
+    streamKey: StreamKey;
+    pin: string;
+    subscriberPins: string[];
+    reason: "noSubscriberPin";
+} | {
+    mediaNodeId: MediaNodeId;
+    streamKey: StreamKey;
+    sourceTypes: string[];
+    subscriberTypes: string[];
+    reason: "unsupportedConversion";
+};
+
 /**
  * @public
  */
@@ -1808,6 +2046,7 @@ export declare type SrtConnectionResult =
 /** Accept the stream */
     {
     accept: true;
+    /** The source name to assign to the connection */
     sourceName: string;
 }
 /** Reject the stream */
@@ -1845,9 +2084,12 @@ export declare interface SrtInputSettings extends RemoteInputSettings<SrtInputNo
     onConnection?: (
     /** The stream_id sent on the SRT socket (or empty if none was set) */
     streamId: string, 
-    /** The connection index */
+    /**
+     * Identifier indicating which connection this message refers to (for a
+     * listener which may have multiple connections)
+     */
     index: number, 
-    /** Remote host address */
+    /** The address of the remote host */
     remoteHost: string) => SrtConnectionResult;
     /**
      * Called when the connection status has changed (e.g. when the SRT socket is closed)
@@ -1875,7 +2117,7 @@ export declare class SrtOutputNode extends AutoSinkMediaNode<"audio" | "video">
 }
 
 /** @public */
-export declare interface SrtOutputSettings extends NodeSettings<SrtOutputNode>, StreamStatsMixin {
+export declare interface SrtOutputSettings extends SinkNodeSettings<SrtOutputNode>, StreamStatsMixin {
     /**
      * Passphrase for encryption
      */
@@ -2013,6 +2255,33 @@ export declare interface StreamStatsSettings extends ProcessorNodeSettings<Strea
     statsSampling?: PlainMessage<StreamStatsSampling>;
 }
 
+/**
+ * @public
+ * Errors found while setting up subscriptions, separated out by reason:
+ *
+ * - `internal`: An opaque internal error
+ *
+ * - `unknownSubscriber`: The media node requesting the subscription does not exist
+ *
+ * - `multipleStreams`: Multiple stream keys found for the context type
+ *
+ * - `sourceSubscriptionError`: Per-source errors
+ */
+export declare type SubscriptionError = {
+    info: string;
+    reason: "internal";
+} | {
+    mediaNodeId: MediaNodeId;
+    reason: "unknownSubscriber";
+} | {
+    contextType: ContextType;
+    streamKeys: StreamKey[];
+    reason: "multipleStreams";
+} | {
+    sourceErrors: SourceSubscriptionError[];
+    reason: "sourceSubscriptionError";
+};
+
 /** @public */
 export declare const subtitlesToPin: <Pins extends string>(pin: Pins) => (streams: StreamMetadata[]) => PinToKey<Pins>;
 
@@ -2084,7 +2353,7 @@ export declare class TsFileOutputNode extends AutoSinkMediaNode<"audio" | "video
 }
 
 /** @public */
-export declare interface TsFileOutputSettings extends NodeSettings<TsFileOutputNode>, StreamStatsMixin {
+export declare interface TsFileOutputSettings extends SinkNodeSettings<TsFileOutputNode>, StreamStatsMixin {
     fileName: string;
 }
 
@@ -2104,7 +2373,7 @@ export declare class TsUdpOutputNode extends AutoSinkMediaNode<"audio" | "video"
 }
 
 /** @public */
-export declare interface TsUdpOutputSettings extends NodeSettings<TsUdpOutputNode>, StreamStatsMixin {
+export declare interface TsUdpOutputSettings extends SinkNodeSettings<TsUdpOutputNode>, StreamStatsMixin {
     destinationIp: string;
     iface: string;
     port: number;
@@ -2208,7 +2477,7 @@ export declare class WebRTCWhipOutputNode extends AutoSinkMediaNode<"audio" | "v
 /**
  * @public
  */
-export declare interface WebRTCWhipOutputSettings extends NodeSettings<WebRTCWhipOutputNode>, StreamStatsMixin {
+export declare interface WebRTCWhipOutputSettings extends SinkNodeSettings<WebRTCWhipOutputNode>, StreamStatsMixin {
     uri: string;
     authHeader: string;
 }