SimulcastLocalLayerConfiguration
Configuration for a local Simulcast layer. This represents a single video encoding layer to be published and sent to subscribers. All properties must be defined.
Properties
height
height:
number
The target height of the layer. Note that the aspect ratio of the largest layer will be used as a reference for all other layers. Aspect ratios cannot be mixed across layers, and if they deviate by more than X then an error will be thrown.
This is to guard against cases of mixing portrait and landscape video across layers.
- Max: STAGE_MAX_RESOLUTION
- Min: STAGE_MIN_RESOLUTION
maxBitrateKbps
maxBitrateKbps:
number
Maximum layer bitrate in Kbps. Note that if any of the layer bitrates exceed that of the root maxBitrateKbps an error will be thrown indicating layer bitrates exceed that of the overall stage bitrate maximums.
- Max: STAGE_MAX_BITRATE
- Min: STAGE_MIN_BITRATE
maxFramerate
maxFramerate:
number
Maximum layer frames per second. Note that if any of the layer fps values exceed that of the root StageVideoConfiguration.maxFramerate an error will be thrown indicating layer fps exceed that of the overall stage fps maximums.
- Max: STAGE_MAX_FRAMERATE
- Min: STAGE_MIN_FRAMERATE
width
width:
number
The target width of the layer. Note that the aspect ratio of the largest layer will be used as a reference for all other layers. Aspect ratios cannot be mixed across layers, and if they deviate by more than X then an error will be thrown.
This is to guard against cases of mixing portrait and landscape video across layers.
- Max: STAGE_MAX_RESOLUTION
- Min: STAGE_MIN_RESOLUTION