Parameter management for video channels
Description
The parameters for a video channel are used as default values unless a URL option overrides them. You can get the video channel parameters below using the list action. If you have write access, you can update the parameters using update.
URL options
The following table lists URL options in stream requests that are relevant for video and can be used from:
- JPEG image (snapshot)
/axis-cgi/jpg/image.cgi - Video streaming over HTTP
/axis-cgi/mjpg/video.cgi - Media stream over HTTP
/axis-cgi/media.cgi - Video streaming over HTTP
/axis-cgi/mjpg/video.cgi - Stream profiles
/axis-cgi/streamprofile.cgi - Parameter specification RTSP URL
If a URL option is omitted, then the Default value in the table specifies the video channel parameter that you can access by using the list in parameter management. The security privilege to read a video channel parameter is Viewer, see Authentication.
| URL option | Valid values | Default value | Description |
|---|---|---|---|
camera | 1 ... [Image.NbrOfConfigs] | 1 | Select the video channel. 1 is used for the first channel. |
color | 0 (Monochrome) 1 (Color) | Image.I#.Appearance.ColorEnabled | Specify whether the image should be in color or monochrome. |
compression | 0 ... 100 | Image.I#.Appearance.Compression | Adjusts the compression level of the image. Higher values correspond to higher compression, that is lower quality and smaller image size. |
fps | Integer or fraction | Image.I#.Stream.FPS | Select frame rate (FPS). 0 means to use the maximum available frame rate. Fractions are supported, such as 25/2. |
h264profile | baseline main high | Image.I#.MPEG.H264.Profile | The H.264 profile to use. Note: baseline is not available on all products. Check the Properties.Image.I#.H264.Profile parameter for supported profiles. |
mirror | 0 (Not mirrored) 1 (Mirrored) | Image.I#.Appearance.MirrorEnabled | Specify whether the image should be mirrored. |
overlays | off all all‑sync image text application application‑sync | Image.I#.Appearance.Overlays | Set what types of overlays to show in the requested stream. image means image overlays. text means text overlays. application means overlays with application-generated content (such as ACAP overlays). all means all of the above. off means no overlays. all-sync and application-sync are variants meaning that the video stream is synced with the overlay rendering (possibly resulting in an added delay). See Dynamic overlay API. |
palette | String | Image.I#.Appearance.Palette | The palette determines what visible colors are used for visualizing different pixel values captured by the sensor of a thermal camera. For names of available palettes, see subgroups of the parameter group Image.Palette. Note: This setting is only available on thermal cameras. |
resolution | String | Image.I#.Appearance.Resolution | Resolution of the returned image. For supported resolutions, check the parameter Properties.Image.I#.JPEG.Resolution. |
rotation | Product dependent Note: Deprecated as of AXIS OS 13, see source rotation. | Image.I#.Appearance.Rotation | Rotate the image clockwise. The rotation alternatives in an Axis product are defined by the parameter Properties.Image.Rotation or Properties.Image.I#.Rotation. Note: The URL option rotation is only valid on products without source rotation. Check if the parameter ImageSource.I#.SourceRotation is yes. In that case, set ImageSource.I#.Rotation instead. |
squarepixel | 0 (Disabled) 1 (Enabled) | Image.I#.Appearance.SquarePixelEnabled | Enable or disable square pixel (aspect ratio) correction for encoder products. If the parameter is set to 1, the Axis product adjusts the aspect ratio to make it appear as intended. Note: Square pixel correction is only available on encoder products and only for the JPEG video format. |
video | 0 (No video) 1 (Video) | 1 | Specify whether video should be included in the stream. |
videoabrmaxbitrate | Integer | Image.I#.RateControl.ABR.MaxBitrate | Maximum bitrate (kbps) when bitrate mode is ABR. See Rate Control API. |
videoabrretentiontime | Integer | Image.I#.RateControl.ABR.RetentionTime | Retention time (days) when bitrate mode is ABR. See Rate Control API. |
videoabrtargetbitrate | Integer | Image.I#.RateControl.ABR.TargetBitrate | Target bitrate (kbps) when bitrate mode is ABR. See Rate Control API. |
videobitratemode | abr mbr vbr | Image.I#.RateControl.Mode | Bitrate mode. See Rate Control API. |
videobitratepriority | none framerate quality fullframerate | Image.I#.RateControl.Priority | Bitrate priority. See Rate Control API. |
videocodec | av1 platform dependent h264 h265 product dependent jpeg | Streaming protocol dependent (h264 for RTSP). | Video format. For supported codecs, check the parameter Properties.Image.Format. |
videoframeskipmode | drop empty | Image.I#.MPEG.FrameSkipMode | Determines what to do when either the rate controller or Zipstream skips a frame. drop means that frames are dropped, empty means that empty frames are sent. |
videokeyframeinterval | Integer | Image.I#.MPEG.PCount + 1 | Key frame interval. Note: When using dynamic GOP mode, this value will correspond to the minimum GOP length, while videozmaxgoplength will be the maximum GOP length. See Zipstream GOP mode. |
videolayers | 0 (Disabled) 1 (Enabled) | Image.I#.Layers.Enabled | Determines if a stream should have layers in the video. Note: Layers are only available for the AV1 video codec. |
videomaxbitrate | Integer | Image.I#.RateControl.MaxBitrate | Maximum bitrate (kbps) when bitrate mode is MBR. See Rate Control API. |
videopsenabled | 0 (Disabled) 1 (Enabled) | Image.I#.MPEG.H264.PSEnabled Image.I#.MPEG.H265.PSEnabled | Set for preceding every key frame in H.264/H.265 with parameter set NAL units (VPS/SPS/PPS). |
videosigned | 0 (Unsigned) 1 (Signed) | Image.I#.MPEG.SignedVideo.Enabled | Specify whether the video should be signed. See Signed Video API. |
videozfpsmode | fixed dynamic | Image.I#.MPEG.ZFpsMode | Zipstream FPS mode. fixed means that the frame rate will be the default one set for the channel. dynamic means that the frame rate can vary between the minimum FPS and the default FPS. |
videozgopmode | fixed dynamic | Image.I#.MPEG.ZGopMode | Zipstream GOP mode. fixed means that the GOP length is fixed and set to the Axis product's default GOP length. dynamic means that, when possible, unnecessary key frames are removed to further reduce the bit rate. The GOP length varies between the Axis product's default GOP length and a configurable, maximum GOP length (videozmaxgoplength). The maximum GOP length is used for scenes with no or almost no motion; the default GOP length is used for busy scenes. |
videozgradualdecoderefresh | auto low balanced extreme | Image.I#.MPEG.ZGradualDecodeRefresh | Zipstream gradual decode refresh (GDR). See /axis-cgi/zipstream/setprofile.cgi. |
videozmaxgoplength | Integer | Image.I#.MPEG.ZMaxGopLength | Zipstream maximum GOP length. See Set Zipstream GOP settings. |
videozminfps | Integer or fraction | Image.I#.MPEG.ZMinFps | Minimum FPS when Zipstream dynamic FPS is enabled. Fractions are expressed as 15/2. See Set minimum FPS. |
videozprofile | classic storage networkloadbalancing | Image.I#.MPEG.ZProfile | Zipstream profile. See Set the Zipstream profile. |
videozprofilelevel | 0 ... | Image.I#.MPEG.ZProfileLevel | Zipstream profile level. See Set the Zipstream profile. |
videozstrength | off (Disabled) 10 20 30 40 50 | Image.I#.MPEG.ZStrength | Zipstream strength. Increasing the strength reduces the bit rate but also affects the visual image quality. At the default value 10, visual image quality isn't affected, but as the strength increases, visual image quality degrades in unprioritized image areas, for example the background. The product keeps image details important for forensic video analysis. See Zipstream strength and Set Zipstream strength. |
Parameters
This section describes param.cgi parameters with default settings for streams fetched from video channels (see Parameter management). Where applicable, the corresponding URL option is listed. For an explanation of the setting, see the entry for that option in URL options.
Valid values for the channel number # range from 0 to the number of video channels specified for the product - 1.
If nothing else is specified, the security level to read the following parameters is Viewer, and the security level required to update them is Operator.
Image
Use the parameters in this group to configure generic image-related settings.
They can be accessed at Image.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
MaxViewers | Integer | N/A | The maximum number of simultaneous streaming clients. |
NbrOfConfigs | Integer | N/A | The maximum number of configurable video channels. Read-only. |
Image.I#
Use the parameters in this group to configure image-related settings for video channel #.
They can be accessed at Image.I#.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
Enabled | no yes | video | Determines whether you can stream from the video channel. |
Name | String | N/A | Name of the video channel. Note: Name is read-only for products with image dewarp, but writable for other products. |
Source | 0 ... Matrix | N/A | For physical channels and view areas: a zero-based integer pointing out the video source the channel is connected to. Read-only. For multi-view channels: a matrix describing how video from different sources is arranged. Rows are separated by semicolons. Each row is a comma-separated list of zero-based source identifiers. Example: 0,1;2,3. Read-only. |
Type | Comma-separated list | N/A | Lists the capabilities for the video channel. Guaranteed to start with one of these primary types: Source is a physical channel with a full view of an ImageSource of the single Source parameter. Composite is a multi-view channel, such as a quad view, of the content in the Source parameter. Viewarea is a possibly cropped view of the single Source parameter. See View Area API. Other is any other type of channel. The list may then be followed by any of these extension types: Radar indicates that the video originates from a radar sensor. Thermal indicates that the video originates from a thermal sensor. Example: Other,Radar means that the video comes from a Radar sensor, but it is not from a real radar source on the device, that would be indicated as Source,Radar. Read-only. |
Image.I#.Appearance
Use the parameters in this group to configure image appearance-related settings for video channel #.
They can be accessed at Image.I#.Appearance.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
ColorEnabled | no (Monochrome) yes (Color) | color | Default value of the color setting. |
Compression | 0 ... 100 | compression | Default value of the compression level of the image. |
MirrorEnabled | no yes | mirror | Default value of the mirror setting. |
Overlays | off all all-sync image text application application-sync | overlays | Default for what types of overlays to show in streams from the channel. |
Palette | String | palette | Default value of the palette. See Thermometry and Thermal imaging Note: This setting is only available on thermal cameras. |
Resolution | String | resolution | Default resolution of the returned image. |
Rotation | Product dependent | rotation | Default value of the image rotation (clockwise). The rotation alternatives in an Axis product are defined by the parameter Properties.Image.Rotation or Properties.Image.I#.Rotation. Note: This parameter should only be used on products without source rotation (such as ARTPEC-6 and older platforms). Check if the parameter ImageSource.I#.SourceRotation=yes. If so, set ImageSource.I#.Rotation instead. For products with source rotation, all Image.I#.Appearance.Rotation are mapped to ImageSource.I#.Rotation. If one of the parameters is updated, all other parameters are also updated. |
SquarePixelEnabled | no yes | squarepixel | Default value of square pixel (aspect ratio) correction. Note: Square pixel correction is only available on encoder products, and only for the JPEG video format. |
Image.I#.Layers
Use the parameters in this group to configure layers on video channel #. Layers are only available for the AV1 codec.
They can be accessed at Image.I#.Layers.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
Enabled | no yes | videolayers | Default setting for AV1, controlling if the stream should have different layers. |
Image.I#.MPEG
Use the parameters in this group to configure video coding settings for video channel # using MPEG standards.
They can be accessed at Image.I#.MPEG.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
FrameSkipMode | drop empty | videoframeskipmode | Default frame skip mode. |
H264.Profile | high main baseline | h264profile | The default H.264 profile to use. Note: baseline is not available on all products. |
H264.PSEnabled | no yes | videopsenabled | Default setting for H.264, controlling if SPS/PPS should be prepended to every key frame. |
H265.PSEnabled | no yes | videopsenabled | Default setting for H.265, controlling if VPS/SPS/PPS should be prepended to every key frame. |
PCount | Integer | videokeyframeinterval | Default key frame interval, expressed as the number of delta frames between key frames. Note: When using dynamic GOP mode, this value will correspond to the minimum GOP length, while ZMaxGopLength will be the maximum GOP length. |
SignedVideo. Enabled | no yes | videosigned | Default value for whether the video should be signed. See Signed Video. |
UserDataEnabled | no yes | N/A | Enable or disable inclusion of user data in H.264 SEI messages. |
UserDataInterval | Integer | N/A | Controls how often user data is sent per frame. |
ZFpsMode | fixed dynamic | videozfpsmode | Default Zipstream FPS mode. See Zipstream FPS mode. |
ZGopMode | fixed dynamic | videozgopmode | Default Zipstream GOP mode. See Zipstream GOP mode. |
ZGradualDecodeRefresh | auto low balanced extreme | videozgradualdecoderefresh | Default Zipstream gradual decode refresh (GDR). See Zipstream API. |
ZMaxGopLength | Integer | videozmaxgoplength | Default Zipstream maximum GOP length. |
ZMinFps | Integer or fraction | videozminfps | Default Zipstream minimum FPS (used when dynamic FPS is enabled). Fractions are supported, such as 25/2. |
ZProfile | classic storage networkloadbalancing | videozprofile | Default Zipstream profile. See Zipstream API. |
ZProfileLevel | 0 ... | videozprofilelevel | Default Zipstream profile level. |
ZStrength | off 10 20 30 40 50 | videozstrength | Default Zipstream strength. See Zipstream strength. |
Image.I#.RateControl
Use the parameters in this group to configure rate control settings for video channel #.
See Rate control API specification.
They can be accessed at Image.I#.RateControl.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
ABR.MaxBitrate | Integer | videoabrmaxbitrate | Default maximum bitrate (kbps) when bitrate mode is ABR. |
ABR.RetentionTime | Integer | videoabrretentiontime | Default retention time when bitrate mode is ABR. |
ABR.TargetBitrate | Integer | videoabrtargetbitrate | Default target bitrate (kbps) when bitrate mode is ABR. |
Mode | abr mbr vbr | videobitratemode | Default bitrate mode. |
Priority | none framerate quality fullframerate | videobitratepriority | Default bitrate priority. |
MaxBitrate | Integer | videomaxbitrate | Default maximum bitrate (kbps) when bitrate mode is MBR. |
Image.I#.Stream
Use the parameters in this group to configure streaming settings for video channel #.
They can be accessed at Image.I#.Stream.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
FPS | Integer | fps | Default frame rate (FPS). Note: Fractions, as for the URL option, are not supported. |
ImageSource.I#
Use the parameters in this group to configure image source #.
They can be accessed at ImageSource.I#.<parameter>
| Parameter | Valid values | URL option | Description |
|---|---|---|---|
Rotation | Product dependent | N/A | Rotate the sensor image clockwise. The rotation alternatives in an Axis product are defined by the parameter Properties.Image.Rotation or Properties.Image.I#.Rotation. Note: This parameter is only available on products with source rotation. Check if the parameter SourceRotation=yes. If not, set Image.I#.Rotation instead. |
SourceRotation | no yes | N/A | yes if the product has source rotation. See Image source rotation. Read-only. |
Property parameters
This section describes param.cgi parameters with information about the product's streaming capabilities (see Parameter management).
Valid values for the channel number # range from 0 to the number of video channels specified for the product - 1.
If nothing else is specified, the security level to read the following parameters is Viewer, and the security level required to update them is Operator.
Properties.Image
The parameters in this group contain information about generic streaming capabilities.
They can be accessed at Properties.Image.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
CodecSpecificResolutions | no yes | If yes (as of AXIS OS 11.7), there are parameter groups with information about supported resolutions for different video formats, such as Properties.Image.I#.H264. Read-only. |
Format | Comma-separated list | List of supported video formats. Example: av1,jpeg,mjpeg,h264,h265. Read-only. |
NbrOfViews | Integer | The number of available video channels. Read-only. |
Resolution | Comma-separated list | List of resolutions supported for all video formats. Read-only. |
Rotation | Comma-separated list | List of supported rotation values. Read-only. |
ShowSuboptimalResolutions | no yes | If set to yes, the list given by Properties.Image.Resolution may also contain some resolutions that are considered suboptimal, and therefore normally hidden. It has no effect as of ARTPEC-9. |
Properties.Image.AV1
The parameters in this group contain information about AV1 specific capabilities. This group is only available if AV1 is supported.
They can be accessed at Properties.Image.AV1.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Profiles | Comma-separated list | List of supported AV1 profiles. Example: Main. Read-only. |
Properties.Image.H264
The parameters in this group contain information about H264 specific capabilities. This group is only available if H264 is supported.
They can be accessed at Properties.Image.H264.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Profiles | Comma-separated list | List of supported H264 profiles. Example: Baseline,Main,High. Read-only. |
Properties.Image.H265
The parameters in this group contain information about H265 specific capabilities. This group is only available if H265 is supported.
They can be accessed at Properties.Image.H265.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Profiles | Comma-separated list | List of supported H265 profiles. Example: Main. Read-only. |
Properties.Image.I#
The parameters in this group contain information about streaming capabilities for video channel #.
They can be accessed at Properties.Image.I#.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Resolution | Comma-separated list | List of resolutions supported for the video channel. Read-only. |
ShowSuboptimalResolutions | no yes | If set to yes, the list given by Properties.Image.I#.Resolution may also contain some resolutions that are considered suboptimal, and therefore normally hidden. It has no effect as of ARTPEC-9. |
Properties.Image.I#.AV1
The parameters in this group contain information about AV1 specific capabilities for video channel #. This group is only available if AV1 is supported.
They can be accessed at Properties.Image.I#.AV1.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Resolution | Comma-separated list | List of resolutions supported for the video channel. Read-only. |
Properties.Image.I#.H264
The parameters in this group contain information about H264 specific capabilities for video channel #. This group is only available if H264 is supported.
They can be accessed at Properties.Image.I#.H264.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Resolution | Comma-separated list | List of resolutions supported for the video channel. Read-only. |
Properties.Image.I#.H265
The parameters in this group contain information about H265 specific capabilities for video channel #. This group is only available if H265 is supported.
They can be accessed at Properties.Image.I#.H265.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Resolution | Comma-separated list | List of resolutions supported for the video channel. Read-only. |
Properties.Image.I#.JPEG
The parameters in this group contain information about JPEG specific capabilities for video channel #. This group is only available if JPEG is supported.
They can be accessed at Properties.Image.I#.JPEG.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Resolution | Comma-separated list | List of resolutions supported for the video channel. Read-only. |
Properties.Image.RateControl
The parameters in this group contain information about rate control capabilities, see Rate Control API.
They can be accessed at Properties.Image.RateControl.<parameter>
| Parameter | Valid values | Description |
|---|---|---|
Version | Major.Minor | Supported version of the Rate Control API. Read-only. |
ABR.ABR | no yes | If yes, the ABR bitrate mode (long-term average bitrate) is available. Read-only. |