NetworkFeedConfig

A feed configuration used for IP streams.

See also: Feed Guide

Base class (inherits properties and methods): FeedHeadConfig

Properties

codec : NetworkVideo_CompressionCodec

The video codec to use for compressed streams.

Options: {0: ‘H265’, 1: ‘AV1’}

colourProfile : ColourConversionProfile

The stream’s colour profile.

Options: {0: ‘BT601’, 1: ‘BT709’, 2: ‘BT2020’, 3: ‘AUTO’}

compressedBitrate : int

The average bitrate codec to target for compressed streams.

feedNetworkOutputState : FeedNetworkOutputState

The output state of the stream

isInitialized : bool

Indicate if the configuration has been initialized.

multicastConfig : MulticastConfig

The multicast destinations this head streams to, taken from the project’s pool of multicast configs. A head with none does not stream.

networkTransportType : TransportType

The network transport type of the stream.

Options: {0: ‘Interlaced’, 1: ‘Progressive’}

transferCharacteristics : TransferCharacteristics

The transfer characteristic of the stream.

Options: {0: ‘SDR’, 1: ‘HLG’, 2: ‘PQ’}

transportBitDepth : NetworkVideo_TransportBitDepth

The transport bit depth of the stream.

transportFormat : NetworkVideo_TransportFormat

The transport format of the stream.

transportType : NetworkVideo_TransportType

The transport type of the stream.

Variables

COMPRESSION_CODEC_AV1 : Final[NetworkVideo_CompressionCodec] = NetworkVideo_CompressionCodec.AV1

Transport type sending compressed video compressed with the AV1 codec

COMPRESSION_CODEC_H265 : Final[NetworkVideo_CompressionCodec] = NetworkVideo_CompressionCodec.H265

Transport type sending compressed video compressed with the H.265 codec

IP_OUTPUT_STATE_RUNNING : Final[FeedNetworkOutputState] = FeedNetworkOutputState.Running

Output state for a network feed that is transmitting

IP_OUTPUT_STATE_STOPPED : Final[FeedNetworkOutputState] = FeedNetworkOutputState.Stopped

Output state for a network feed that is not transmitting

TRANSPORT_BIT_DEPTH_10 : Final[NetworkVideo_TransportBitDepth] = NetworkVideo_TransportBitDepth._10Bit

Transport bit depth of 10 bits per colour component

TRANSPORT_BIT_DEPTH_12 : Final[NetworkVideo_TransportBitDepth] = NetworkVideo_TransportBitDepth._12Bit

Transport bit depth of 12 bits per colour component

TRANSPORT_BIT_DEPTH_8 : Final[NetworkVideo_TransportBitDepth] = NetworkVideo_TransportBitDepth._8Bit

Transport bit depth of 8 bits per colour component

TRANSPORT_FORMAT_RGB444 : Final[NetworkVideo_TransportFormat] = NetworkVideo_TransportFormat.RGB444

Transport format carrying full RGB 4:4

TRANSPORT_FORMAT_YUV420 : Final[NetworkVideo_TransportFormat] = NetworkVideo_TransportFormat.YUV420

Transport format carrying YCbCr colour sampling with horizontally and vertically subsampled chroma

TRANSPORT_FORMAT_YUV422 : Final[NetworkVideo_TransportFormat] = NetworkVideo_TransportFormat.YUV422

Transport format carrying YCbCr colour sampling with horizontally subsampled chroma

TRANSPORT_FORMAT_YUV444 : Final[NetworkVideo_TransportFormat] = NetworkVideo_TransportFormat.YUV444

Transport format carrying YCbCr colour sampling with full resolution chroma

TRANSPORT_TYPE_COMPRESSED : Final[NetworkVideo_TransportType] = NetworkVideo_TransportType.Compressed

Transport type sending compressed video over ST.2110-22

TRANSPORT_TYPE_COMPRESSED_NDI : Final[NetworkVideo_TransportType] = NetworkVideo_TransportType.CompressedNDI

Transport type sending compressed video as an NDI stream

TRANSPORT_TYPE_UNCOMPRESSED : Final[NetworkVideo_TransportType] = NetworkVideo_TransportType.Uncompressed

Transport type sending uncompressed video as an ST 2110 stream

Static Methods

isValidTransportCombination(type: NetworkVideo_TransportType, format: NetworkVideo_TransportFormat, bitDepth: NetworkVideo_TransportBitDepth, codec: NetworkVideo_CompressionCodec) -> bool

Validates if the specified transport type and parameters combination is supported.