Skip to main content

Lookup channels

This guide shows you how to read parameter information about a video channel.

Prerequisites

You need:

  • An Axis camera: <ip> to replace in commands
  • Camera user credentials: <user> and <pass> to replace in commands
  • curl

For the how-to cases below that change values, the camera user credential needs either admin or operator privileges. For details of authentication, see Authentication. You can find definitions of acronyms used in this guide in Terminology.

How to read the number of video channels

curl -s --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Image.NbrOfConfigs"

Example output:

Image.NbrOfConfigs=8

How to read the available codecs

curl -s --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Properties.Image.Format"

Example output:

Properties.Image.Format=av1,jpeg,mjpeg,h264,h265

How to read the available resolutions for a codec

Replace:

curl -s --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Properties.Image.I0.JPEG.Resolution"

Example output:

Properties.Image.I0.JPEG.Resolution=3840x2160,3072x1728,2880x2160,2688x1512,2592x1944,2560x1920,2560x1600,2560x1440,2432x1824,2304x1728,2048x1536,2016x1512,1920x1440,1920x1200,1920x1080,1440x1080,1280x960,1280x800,1280x720,1024x768,1024x640,1024x576,800x600,640x480,640x400,640x360,480x360,320x240,320x200,160x120

How to get the default resolution

Replace:

curl -s --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Image.I0.Appearance.Resolution"

Example output:

Image.I0.Appearance.Resolution=3840x2160

How to set the default resolution

Replace:

curl -s --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=update&Image.I0.Appearance.Resolution=1920x1080"

Example output:

OK

Always verify that the new default resolution is set: How to get the default resolution.

How to read the FPS

Replace:

curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Image.I0.Stream.FPS"

Example output:

Image.I0.Stream.FPS=0

0 = Unlimited.

How to read the type of a video channel

Replace:

curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Image.I0.Type"

Example output:

Image.I0.Type=Source

How to disable a video channel

Replace:

curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=update&Image.I0.Enabled=no"

Example output:

OK

How to enable a video channel

Replace:

curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=update&Image.I0.Enabled=yes"

Example output:

OK

How to read the RTSP timeout

curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=list&group=Network.RTSP.Timeout"

Example output:

Network.RTSP.Timeout=60

How to set the RTSP timeout

Replace:

  • 120 with the desired timeout in seconds
curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=update&Network.RTSP.Timeout=120"

Example output:

OK

How to disable the RTSP timeout

curl --anyauth -u '<user>:<pass>' "http://<ip>/axis-cgi/param.cgi?action=update&Network.RTSP.Timeout=0"

Example output:

OK

How to explore an image snapshot

Browse to https://<ip>/axis-cgi/jpg/image.cgi?camera=1&resolution=328x328

The specified resolution is outside the resolution list, see How to read the available resolutions for a codec. Compare the image with the default resolution in https://<ip>/axis-cgi/jpg/image.cgi?camera=1 — cropping and scaling may be applied.

For exploring other available HTTP stream parameters, see Image request arguments.

How to explore live video

Browse to https://<ip>/axis-cgi/media.cgi?camera=1&container=mp4&resolution=328x328 and press play.

The specified resolution is outside the resolution list, see How to read the available resolutions for a codec. Compare the video with the default resolution in https://<ip>/axis-cgi/media.cgi?camera=1&container=mp4 — cropping and scaling may be applied.

For exploring other available HTTP stream parameters, see API specifications.

Use ffplay to display live video:

ffplay 'https://<ip>/axis-cgi/media.cgi'

How to download a 5–second video clip

curl --anyauth -u '<user>:<pass>' --output file.mp4 --max-time 5 "https://<ip>/axis-cgi/media.cgi?camera=1&container=mp4"

For exploring other available HTTP stream parameters, see API specifications.