VideoStream Class

CameraSettingClass

Description
A class used to configure parameters for the camera sensor.

Syntax
class CameraSetting

Members

Public Constructors 
CameraSetting::CameraSettingConstructs a CameraSetting object and set the parameters needed for camera sensor.
Public Methods 
CameraSetting::setBrightnessSet the brightness value of the image.
CameraSetting::getBrightnessGet the current brightness value.
CameraSetting::setContrastSet the contrast value of the image.
CameraSetting::getContrastGet the current contrast value.
CameraSetting::setSaturationSet the saturation value of the image.
CameraSetting::getSaturationGet the current saturation value.
CameraSetting::setSharpnessSet the sharpness value of the image.
CameraSetting::getSharpnessGet the current sharpness value.
CameraSetting::setLDCEnable or Disable Lens Distortion Correction (LDC).
CameraSetting::getLDCGet the current LDC value.
CameraSetting::setWDREnable or Disable WDR mode.
CameraSetting::getWDRGet current WDR mode.
CameraSetting::setWDRLevelSet WDR level.
CameraSetting::getWDRLevelGet current WDR level.
CameraSetting::setExposureModeSet Exposure mode in Auto or Manual mode.
CameraSetting::getExposureModeGet current exposure mode.
CameraSetting::setExposureTimeSet exposure time.
CameraSetting::getExposureTimeGet current exposure time.
CameraSetting::setAEGainSet exposure gain value.
CameraSetting::getAEGainGet current exposure gain value.
CameraSetting::setPowerLineFreqEnable or Disable Power Line Frequency (Anti-flicker mode).
CameraSetting::getPowerLineFreqGet current Power Line Frequency.
CameraSetting::setAWBSet White Balance mode in Auto or Manual mode.
CameraSetting::getAWBGet current White Balance mode.
CameraSetting::getWBTempGet current White Balance Temperature.
CameraSetting::setRedBalanceSet red balance value.
CameraSetting::getRedBalanceGet red balance value.
CameraSetting::setBlueBalanceSet blue balance value.

CameraSetting::setBrightness

Description
Set the brightness value of the image.

Syntax
void setBrightness(int value);

Parameters
value: Preferred brightness value. Valid values range from -64 to 64. Default value: 0.

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getBrightness

Description
Get the current brightness value.

Syntax
void setBrightness(void);

Parameters
NA

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setContrast

Description
Set the contrast value of the image.

Syntax
void setContrast(int value);

Parameters
value: Preferred contrast value. Valid values range from 0 to 100. Default value: 50.

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getContrast

Description
Get the current contrast value.

Syntax
void getContrast(void);

Parameters
NA

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setSaturation

Description
Set the saturation value of the image.

Syntax
void setSaturation(int value);

Parameters
value: Preferred saturation value. Valid values range from 0 to 100. Default value: 50.

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getSaturation

Description
Get the current saturation value.

Syntax
void getSaturation(void);

Parameters
NA

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setSharpness

Description
Set the sharpness value of the image.

Syntax
void setSharpness(int value);

Parameters
value: Preferred sharpness value. Valid values range from 0 to 100. Default value: 50.

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getSharpness

Description
Get the current sharpness value.

Syntax
void getSharpness(void);

Parameters
NA

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setLDC

Description
Enable or Disable Lens Distortion Correction (LDC).

Syntax
void setLDC(int enable);

Parameters
enable: Enable or Disable LDC. Valid values: 0 (Disabled) and 1(Enabled). Default value: 0 (Disabled).

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getLDC

Description
Get the current LDC value.

Syntax
void getLDC(void);

Parameters
NA

Returns
NA

Example Code
ImageTuning
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/ImageTuning/ImageTuning.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setWDR

Description
Enable or Disable WDR mode.

Syntax
void setWDR(int enable);

Parameters
enable: Preferred WDR mode. If WDR mode is enabled, Manual or Auto mode can be chosen. Valid values: 0 (Disabled), 1 (Manual) and 2 (Auto). Default value: 0 (Disabled).

Returns
NA

Example Code
WideDynamicRange
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WideDynamicRange/WideDynamicRange.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getWDR

Description
Get current WDR mode.

Syntax
void getWDR(void);

Parameters
NA

Returns
NA

Example Code
WideDynamicRange
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WideDynamicRange/WideDynamicRange.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setWDRLevel

Description
Set WDR level.

Syntax
void setWDRLevel(int value);

Parameters
value: Preferred WDR level. Valid values range from 50 -100. Default value: 50.

Returns
NA

Example Code
WideDynamicRange
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WideDynamicRange/WideDynamicRange.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.
WDR level can only be modified, and changes can be seen on image if WDR mode is set to manual mode before calling setWDRLevel() function.

CameraSetting::getWDRLevel

Description
Get current WDR level.

Syntax
void getWDRLevel(void);

Parameters
NA

Returns
NA

Example Code
WideDynamicRange
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WideDynamicRange/WideDynamicRange.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setExposureMode

Description
Set Exposure mode in Auto or Manual mode.

Syntax
void setExposureMode(int enable);

Parameters
enable: Enable exposure mode in Manual or Auto mode. Valid values: 0 (Manual), 1 (Auto). Default value: 1 (Auto).

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getExposureMode

Description
Get current exposure mode.

Syntax
void getExposureMode(void);

Parameters
NA

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setExposureTime

Description
Set exposure time.

Syntax
void setExposureTime(int time);

Parameters
time: Preferred exposure time. Valid value must be less than or equal to 33333us.

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getExposureTime

Description
Get current exposure time.

Syntax
void getExposureTime(void);

Parameters
NA

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setAEGain

Description
Set exposure gain value.

Syntax
void setAEGain(int value);

Parameters
value: Preferred exposure gain. Valid values between 256 to 32768.

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.
AE gain can only be modified, and changes can be seen on image if Exposure mode is set to manual mode before calling setAEGain() function.

CameraSetting::getAEGain

Description
Get current exposure gain value.

Syntax
void getAEGain(void);

Parameters
NA

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setPowerLineFreq

Description
Enable or Disable Power Line Frequency (Anti-flicker mode).

Syntax
void setPowerLineFreq(int enable);

Parameters
enable: Enable or disable power line frequency. If power line frequency is enabled, power line frequency can be set as auto or choose from different frequencies (50Hz, 60Hz). Valid values: 0 (Disable), 1 (50Hz), 2: (60Hz), 3 (Auto). Default value: 3 (Auto).

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getPowerLineFreq

Description
Get current Power Line Frequency.

Syntax
void getPowerLineFreq(void);

Parameters
NA

Returns
NA

Example Code
Exposure
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Exposure/Exposure.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setAWB

Description
Set White Balance mode in Auto or Manual mode.

Syntax
void setAWB(int enable);

Parameters
enable: Enable white balance mode in Manual or Auto mode. Valid value: 0 (Manual Temperature), 1 (Auto). Default value: 1 (Auto).

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getAWB

Description
Get current White Balance mode.

Syntax
void getAWB(void);

Parameters
NA

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getWBTemp

Description
Get current White Balance Temperature.

Syntax
void getWBTemp(void);

Parameters
NA

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setRedBalance

Description
Set red balance value.

Syntax
void setRedBalance(int value);

Parameters
value: Preferred red balance value based on 256. Valid value ranges from 256 to 2047.

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.
Red Balance value can only be modified, and changes can be seen on image if white balance mode is set to manual mode before calling setRedBalance () function.

CameraSetting::getRedBalance

Description
Get current red balance value.

Syntax
void getRedBalance(void);

Parameters
NA

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setBlueBalance

Description
Set blue balance value.

Syntax
void setBlueBalance(int value);

Parameters
value: Preferred blue balance value based on 256. Valid value ranges from 256 to 2047.

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.
Blue Balance value can only be modified, and changes can be seen on image if white balance mode is set to manual mode before calling setBlueBalance() function. 

CameraSetting::getBlueBalance

Description
Get current blue balance value.

Syntax
void getBlueBalance(void);

Parameters
NA

Returns
NA

Example Code
WhiteBalance
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/WhiteBalance/WhiteBalance.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setGrayMode

Description
Set Gray mode.

Syntax
void setGrayMode(int enable);

Parameters
enable: Enable gray mode. Valid value: 0 (Color mode), 1 (Gray mode). Default value: 0 (Color mode).

Returns
NA

Example Code
Mode
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Mode/Mode.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getGrayMode

Description
Get current mode, gray or color.

Syntax
void getGrayMode(void);

Parameters
NA

Returns
NA

Example Code
Mode
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Mode/Mode.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::setDayNightMode

Description
Set Day or Night mode.

Syntax
void setDayNightMode(int enable);

Parameters
enable: Enable day or night mode. Valid value: 0 (Day mode), 1 (Night mode). Default value: 0 (Day mode).

Returns
NA

Example Code
Mode
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Mode/Mode.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::getDayNightMode

Description
Get current mode, day or night.

Syntax
void getDayNightMode(void);

Parameters
NA

Returns
NA

Example Code
Mode
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Mode/Mode.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

CameraSetting::reset

Description
Reset all the values to default value.

Syntax
void reset(void);

Parameters
NA

Returns
NA

Example Code
Mode
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/ISPControl/Mode/Mode.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

VideoSettingClass

Description
A class used to configure parameters for video streams.

Syntax
class VideoSetting

Members

Public Constructors 
VideoSetting::VideoSettingConstructs a VideoSetting object and set the parameters needed for video streams.
Public Methods 
VideoSetting::setBitrateConfigure bitrate for H264 and H265 video encoder.
VideoSetting::setJpegQualityConfigure quality level for JPEG snapshots.
VideoSetting::setRotationConfigure orientation for H264, H265 video and JPEG encoders.
VideoSetting::widthGet current configured video stream width.
VideoSetting::heightGet current configured video stream height.
VideoSetting::fpsGet current configured video stream fps (frame per second).

VideoSetting::VideoSetting

Description
Constructs a VideoSetting object and sets the parameters needed for video streams, such as resolution, frame rate per second (fps), bit rate per second (bps), encoder type.

Syntax
VideoSetting(uint8_t preset);
VideoSetting(uint8_t resolution, uint8_t fps, uint8_t encoder, uint8_t snapshot);
VideoSetting(uint16_t w, uint16_t h, uint8_t fps, uint8_t encoder, uint8_t snapshot);

Parameters
preset: Select one out of 3 preset video stream settings. Default preset: 0.
resolution: Video resolution (Valid value: VIDEO_HD, VIDEO_FHD)
fps: Frame rate in frames per second.
encoder: Video encoder format to use. (Valid value: VIDEO_HEVC, VIDEO_H264, VIDEO_JPEG)
snapshot: Enable or disable snapshot function.
w: Width in pixels.
h: Height in pixels.

Returns
NA

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Preset configurations:
Preset 0:
resolution: VIDEO_FHD
fps: 30
bps: 2*1024*1024
encoder: VIDEO_H264
snapshot: 0
Preset 1:
resolution: VIDEO_HD
fps: 30
bps: 2*1024*1024
encoder: VIDEO_H264
snapshot: 0

Preset 2:
resolution: VIDEO_FHD
fps: 30
bps: 2*1024*1024
encoder: VIDEO_JPEG
snapshot: 0

VideoSetting::setBitrate

Description
Configure bitrate for H264 and H265 video encoder.

Syntax
void setBitrate(uint32_t bitrate);

Parameters
bitrate: desired video encoder bitrate. Valid values range from 1Mbps (1024 * 1024) to 50Mbps (50 * 1024 * 1024). Default value of 4Mbps.

Returns
NA

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function. The default value of 4Mbps is a suitable balance of video quality and file size. For RTSP streaming, it is recommended that the bitrate is lowered to 2Mbps to account for possible network congestion.

VideoSetting::setJpegQuality

Description
Configure quality level for JPEG snapshots.

Syntax
void setJpegQuality(uint8_t quality);

Parameters
quality: desired JPEG image quality level. Valid values range from 1 (worst) to 9 (best). Default value of 5.

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function. A lower quality results in a reduced file size, while a quality level of 9 may result in large file sizes without a significant improvements in image quality.

VideoSetting::setRotation

Description
Configure orientation for H264, H265 video and JPEG encoders.

Syntax
void setRotation(int angle);

Parameters
angle: desired rotation angle represented by numerical values. Valid values: 0, 1, 2, 3. Default value of 0.
0: No rotation
1: 90 degree to right
2. 90 degree to left
3: 180 degree

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

VideoSetting::width

Description
Get current configured video stream width.

Syntax
uint16_t width(void);

Parameters
NA

Returns
This function returns the current configured video stream width.

Example Code
LoopPostProcessing
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/MotionDetection/LoopPostProcessing/LoopPostProcessing.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

VideoSetting::height

Description
Get current configured video stream height.

Syntax
uint16_t height(void);

Parameters
NA

Returns
This function returns the current configured video stream height.

Example Code
LoopPostProcessing
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/MotionDetection/LoopPostProcessing/LoopPostProcessing.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

VideoSetting::fps

Description
Get current configured video stream fps (frame per second).

Syntax
uint16_t fps(void);

Parameters
NA

Returns
This function returns the current configured video stream fps.

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

VideoClass

Description
A class used to configure and initialize the camera to generate video data streams.

Syntax
class Video

Members

Public Constructors 
Video::VideoConstruct a Video object.
Public Methods 
Video::configVideoChannelConfigure video stream channel.
Video::camInitInitialization of camera sensor using existing configurations.
Video::camDeinitDeinitialization of camera sensor.
Video::videoInitInitialization of video streams using existing configurations.
Video::videoDeinitDeinitialization of video stream module for a specific channel.
Video::channelBeginStart video streaming on a specific channel.
Video::channelEndStop video streaming on a specific channel.
Video::getStreamGet video data stream to provide as an input for other data stream consumers.
Video::getImageEnable snapshot function.
Video::setFPSSet camera video max FPS.
Video::printInfoPrint out current configuration of video channels.

Video::configVideoChannel

Description
Configure video stream channel parameters using VideoSetting class object.

Syntax
void configVideoChannel(int ch, VideoSetting& config);

Parameters
ch: Channel to configure (Valid value: 0,1,2)
config: VideoSetting object

Returns
NA

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::camInit

Description
Initialize camera sensor using configuration from CameraSetting object.

Syntax
void cameraInit(CameraSetting& config);

Parameters
config: CameraSetting object.

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::camDeinit

Description
Deinitialize camera sensor.

Syntax
void cameraDeinit(void);

Parameters
NA

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::videoInit

Description
Initialization of video streams from camera using existing configurations.

Syntax
void videoInit(void);

Parameters
NA

Returns
NA

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::videoDeinit

Description
Deinitialization of all video streams.

Syntax
void videoDeinit(void);

Parameters
NA

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::channelBegin

Description
Start video streaming on a specific channel.

Syntax
void channelBegin(int ch);

Parameters
ch: channel to start streaming. Default channel is 0.

Returns
NA

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::channelEnd

Description
Stop video streaming on a specific channel.

Syntax
void channelEnd(int ch);

Parameters
ch: channel to stop streaming. Default channel is 0.

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::getStream

Description
Get video data stream to provide as an input for other data stream consumers.

Syntax
MMFModule getStream(int ch);

Parameters
ch: channel to get data stream of. Default channel is 0.

Returns
This function returns the video data stream.

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::getImage

Description
Take a snapshot.

Syntax
void getImage(int ch, uint32_t* addr, uint32_t* len);

Parameters
ch: Video stream channel to take a snapshot from.
addr: A pointer to a 32-bit unsigned integer to store the image address.
len: A pointer to a 32-bit unsigned integer to store the image length.

Returns
NA

Example Code
HTTPDisplayJPEG
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/CaptureJPEG/HTTPDisplayJPEG/HTTPDisplayJPEG.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::setFPS

Description
Set camera video max FPS.

Syntax
void setFPS(int fps);

Parameters
fps: max frame rate in frames per second for camera.

Returns
NA

Example Code
NA

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Video::printInfo

Description
Print out current configuration of video channels.

Syntax
void printInfo(void);

Parameters
NA

Returns
NA

Example Code
VideoOnly
(https://github.com/ambiot/ambpro2_arduino/blob/dev/Arduino_package/hardware/libraries/Multimedia/examples/StreamRTSP/VideoOnly/VideoOnly.ino)

Notes and Warnings
“VideoStream.h” must be included to use the class function.

Please confirm that QQ communication software is installed
請先確認已安裝QQ通訊軟體