- Raspistill
- __construct
- flip
- verticalFlip
- horizontalFlip
- sharpness
- contrast
- brightness
- saturation
- ISO
- exposureCompensation
- exposure
- whiteBalance
- effect
- metering
- dynamicRangeCompression
- rotate
- shutterSpeed
- sensorMode
- getOutput
- quality
- raw
- timeout
- encoding
- width
- height
- addExif
- setExif
- disableExif
- linkLatest
- takePicture
- startTimelapse
- Raspivid
Class that abstracts the usage of raspistill cli utility that is used to take photos with the Raspberry Pi camera module.
- Full name: \Cvuorinen\Raspicam\Raspistill
- Parent class: \Cvuorinen\Raspicam\Raspicam
See Also:
Raspistill constructor.
Raspistill::__construct( array $options = array() )
Example:
$camera = new Raspistill([
'rotate' => 90,
'width' => 640,
'height' => 480,
'exposure' => Raspistill::EXPOSURE_NIGHT,
]);
Parameters:
Parameter | Type | Description |
---|---|---|
$options |
array | Associative array where key=method name & value=parameter passed to the method |
Flips the image both vertically and horizontally
Raspistill::flip( boolean $value = true ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables flip, FALSE disables (default=TRUE) |
Flips the image vertically
Raspistill::verticalFlip( boolean $value = true ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables flip, FALSE disables (default=TRUE) |
Flips the image horizontally
Raspistill::horizontalFlip( boolean $value = true ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables flip, FALSE disables (default=TRUE) |
Set the sharpness of the image, 0 is the default (-100 to 100)
Raspistill::sharpness( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Sharpness |
Set the contrast of the image, 0 is the default (-100 to 100)
Raspistill::contrast( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Contrast |
Set the brightness of the image, 50 is the default. 0 is black, 100 is white.
Raspistill::brightness( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Brightness |
Set the colour saturation of the image. 0 is the default (-100 to 100)
Raspistill::saturation( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Saturation |
Sets the ISO to be used for captures. Range is 100 to 800.
Raspistill::ISO( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | ISO |
Set the exposure (EV) compensation of the image. Range is -10 to +10, default is 0.
Raspistill::exposureCompensation( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Exposure compensation |
Set exposure mode
Raspistill::exposure( string $mode ): $this
Possible options are:
- 'auto'
Raspicam::EXPOSURE_AUTO
Use automatic exposure mode - 'night'
Raspicam::EXPOSURE_NIGHT
Select setting for night shooting - 'nightpreview'
Raspicam::EXPOSURE_NIGHTPREVIEW
- 'backlight'
Raspicam::EXPOSURE_BACKLIGHT
Select setting for back lit subject - 'spotlight'
Raspicam::EXPOSURE_SPOTLIGHT
- 'sports'
Raspicam::EXPOSURE_SPORTS
Select setting for sports (fast shutter etc) - 'snow'
Raspicam::EXPOSURE_SNOW
Select setting optimised for snowy scenery - 'beach'
Raspicam::EXPOSURE_BEACH
Select setting optimised for beach - 'verylong'
Raspicam::EXPOSURE_VERYLONG
Select setting for long exposures - 'fixedfps'
Raspicam::EXPOSURE_FIXEDFPS
Constrain fps to a fixed value - 'antishake'
Raspicam::EXPOSURE_ANTISHAKE
Antishake mode - 'fireworks'
Raspicam::EXPOSURE_FIREWORKS
Select settings
Note that not all of these settings may be implemented, depending on camera type.
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string | Exposure mode |
Set Automatic White Balance (AWB) mode
Raspistill::whiteBalance( string $mode ): $this
Possible options are:
- 'off'
Raspicam::WHITE_BALANCE_OFF
Turn off white balance calculation - 'auto'
Raspicam::WHITE_BALANCE_AUTO
Automatic mode (default) - 'sun'
Raspicam::WHITE_BALANCE_SUN
Sunny mode - 'cloud'
Raspicam::WHITE_BALANCE_CLOUD
Cloudy mode - 'shade'
Raspicam::WHITE_BALANCE_SHADE
Shaded mode - 'tungsten'
Raspicam::WHITE_BALANCE_TUNGSTEN
Tungsten lighting mode - 'fluorescent'
Raspicam::WHITE_BALANCE_FLUORESCENT
Fluorescent lighting mode - 'incandescent'
Raspicam::WHITE_BALANCE_INCANDESCENT
Incandescent lighting mode - 'flash'
Raspicam::WHITE_BALANCE_FLASH
Flash mode - 'horizon'
Raspicam::WHITE_BALANCE_HORIZON
Horizon mode
Note that not all of these settings may be implemented, depending on camera type.
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string | AWB mode |
Set an effect to be applied to the image
Raspistill::effect( string $mode ): $this
Possible options are:
- 'none'
Raspicam::EFFECT_NONE
NO effect (default) - 'negative'
Raspicam::EFFECT_NEGATIVE
Negate the image - 'solarise'
Raspicam::EFFECT_SOLARISE
Solarise the image - 'posterise'
Raspicam::EFFECT_POSTERISE
Posterise the image - 'whiteboard'
Raspicam::EFFECT_WHITEBOARD
Whiteboard effect - 'blackboard'
Raspicam::EFFECT_BLACKBOARD
Blackboard effect - 'sketch'
Raspicam::EFFECT_SKETCH
Sketch style effect - 'denoise'
Raspicam::EFFECT_DENOISE
Denoise the image - 'emboss'
Raspicam::EFFECT_EMBOSS
Emboss the image - 'oilpaint'
Raspicam::EFFECT_OILPAINT
Apply an oil paint style effect - 'hatch'
Raspicam::EFFECT_HATCH
Hatch sketch style - 'gpen'
Raspicam::EFFECT_GPEN
- 'pastel'
Raspicam::EFFECT_PASTEL
A pastel style effect - 'watercolour'
Raspicam::EFFECT_WATERCOLOUR
A watercolour style effect - 'film'
Raspicam::EFFECT_FILM
Film grain style effect - 'blur'
Raspicam::EFFECT_BLUR
Blur the image - 'saturation'
Raspicam::EFFECT_SATURATION
Colour saturate the image - 'colourswap'
Raspicam::EFFECT_COLOURSWAP
Not fully implemented - 'washedout'
Raspicam::EFFECT_WASHEDOUT
Not fully implemented - 'colourpoint'
Raspicam::EFFECT_COLOURPOINT
Not fully implemented - 'colourbalance'
Raspicam::EFFECT_COLOURBALANCE
Not fully implemented - 'cartoon'
Raspicam::EFFECT_CARTOON
Not fully implemented
Note that not all of these settings may be available in all circumstances.
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string |
Set metering mode
Raspistill::metering( string $mode ): $this
Possible options are:
- 'average'
Raspicam::METERING_AVERAGE
Average the whole frame for metering - 'spot'
Raspicam::METERING_SPOT
Spot metering - 'backlit'
Raspicam::METERING_BACKLIT
Assume a backlit image - 'matrix'
Raspicam::METERING_MATRIX
Matrix metering
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string |
Enable/Disable Dynamic Range compression
Raspistill::dynamicRangeCompression( string $mode ): $this
DRC changes the images by increasing the range of dark areas of the image, and decreasing the brighter areas. This can improve the image in low light areas.
Possible options are:
- 'off'
Raspicam::DRC_OFF
(default) - 'low'
Raspicam::DRC_LOW
- 'medium'
Raspicam::DRC_MEDIUM
- 'high'
Raspicam::DRC_HIGH
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string |
Set image rotation
Raspistill::rotate( integer $degrees ): $this
Only 0, 90, 180 and 270 degree rotations are supported.
Parameters:
Parameter | Type | Description |
---|---|---|
$degrees |
integer | Degrees |
Set the shutter speed to the specified time.
Raspistill::shutterSpeed( integer|float $value, string $unit = self::TIMEUNIT_SECOND ): $this
There is currently an upper limit of approximately 6000000us (6000ms, 6s) past which operation is undefined.
Unit can be one of: Raspicam::TIMEUNIT_MINUTE
, Raspicam::TIMEUNIT_SECOND
,
Raspicam::TIMEUNIT_MILLISECOND
, Raspicam::TIMEUNIT_MICROSECOND
.
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer|float | Shutter speed |
$unit |
string | Optional. Time unit for $value Default: Raspicam::TIMEUNIT_SECOND |
Sets a specified sensor mode, disabling the automatic selection.
Raspistill::sensorMode( integer $mode ): $this
Possible values are:
Mode | Size | Aspect ratio | Frame rates | FOV | Binning |
---|---|---|---|---|---|
0 | automatic selection | ||||
1 | 1920x1080 | 16:9 | 1-30fps | Partial | None |
2 | 2592x1944 | 4:3 | 1-15fps | Full | None |
3 | 2592x1944 | 4:3 | 0.1666-1fps | Full | None |
4 | 1296x972 | 4:3 | 1-42fps | Full | 2x2 |
5 | 1296x730 | 16:9 | 1-49fps | Full | 2x2 |
6 | 640x480 | 4:3 | 42.1-60fps | Full | 2x2 plus skip |
7 | 640x480 | 4:3 | 60.1-90fps | Full | 2x2 plus skip |
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
integer |
Raspistill::getOutput( ): string
Return Value:
Output from the last executed CLI command
Set jpeg quality (0 to 100)
Raspistill::quality( integer $value ): $this
Quality 100 is almost completely uncompressed. 75 is a good all round value
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Quality |
Add raw bayer data to jpeg metadata
Raspistill::raw( boolean $value = true ): $this
This option inserts the raw Bayer data from the camera in to the JPEG metadata
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables raw, FALSE disables (default=TRUE) |
Time before takes picture, default is 5 seconds
Raspistill::timeout( integer|float $value, string $unit = self::TIMEUNIT_SECOND ): $this
The camera will run for this length of time, then take the picture.
Unit can be one of: Raspicam::TIMEUNIT_MINUTE
, Raspicam::TIMEUNIT_SECOND
,
Raspicam::TIMEUNIT_MILLISECOND
, Raspicam::TIMEUNIT_MICROSECOND
.
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer|float | Timeout |
$unit |
string | Optional. Time unit for $value Default: Raspicam::TIMEUNIT_SECOND |
Encoding to use for output file
Raspistill::encoding( string $mode ): $this
Note that unaccelerated image types (gif, png, bmp) will take much longer to save than JPG which is hardware accelerated. Also note that the filename suffix is completely ignored when deciding the encoding of a file.
Possible options are:
- 'jpg'
Raspicam::ENCODING_JPG
(default) - 'bmp'
Raspicam::ENCODING_BMP
- 'gif'
Raspicam::ENCODING_GIF
- 'png'
Raspicam::ENCODING_PNG
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string | Encoding mode |
Set image width in pixels
Raspistill::width( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Width |
Set image height in pixels
Raspistill::height( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Height |
Add EXIF tag to apply to pictures.
Raspistill::addExif( string $tagName, mixed $value ): $this
Allows the insertion of specific exif tags in to the JPEG image. You can have up to 32 exif tag entries. This is useful for things like adding GPS metadata. See exif documentation for more details on the range of tags available.
Note that a small subset of these tags will be set automatically by the camera system, but will be overridden by any exif options set by this method.
Parameters:
Parameter | Type | Description |
---|---|---|
$tagName |
string | EXIF tag name |
$value |
mixed | Tag value |
Add multiple EXIF tags at once
Raspistill::setExif( array $tags ): $this
Example:
$camera->setExif([
'IFD0.Artist' => 'Boris',
'GPS.GPSAltitude' => '1235/10',
'EXIF.MakerNote' => 'Testing',
]);
Parameters:
Parameter | Type | Description |
---|---|---|
$tags |
array | Associative array where key=EXIF tag name & value=tag value |
See Also:
- \Cvuorinen\Raspicam\Raspistill::addExif
Prevent any EXIF information being stored in the file.
Raspistill::disableExif( ): $this
This reduces the file size slightly.
Link latest picture to filename.
Raspistill::linkLatest( string $filename ): $this
Make a file system link under this name to the latest picture.
Parameters:
Parameter | Type | Description |
---|---|---|
$filename |
string |
Take a picture and save with the given filename
Raspistill::takePicture( string $filename )
Example:
// Take picture with default configurations
$camera->takePicture('pic1.jpg');
Parameters:
Parameter | Type | Description |
---|---|---|
$filename |
string |
Take pictures with timelapse mode.
Raspistill::startTimelapse( string $filename, integer|float $interval, integer|float $length, string $timeUnit = self::TIMEUNIT_SECOND )
Note you should specify %04d at the point in the filename where you want a frame count number to appear. e.g. 'image%04d.jpg'. Note that the %04d indicates a 4 digit number with leading zero's added to pad to the required number of digits. So, for example, %08d would result in an 8 digit number.
If a timelapse value of 0 is entered, the application will take pictures as fast as possible. Note there is an minimum enforced pause of 30ms between captures to ensure that exposure calculations can be made.
Time unit can be one of: Raspicam::TIMEUNIT_MINUTE
, Raspicam::TIMEUNIT_SECOND
,
Raspicam::TIMEUNIT_MILLISECOND
, Raspicam::TIMEUNIT_MICROSECOND
.
Example:
// take picture every ten seconds for two minutes
$camera->startTimelapse('image%04d.jpg', 10, 120);
Parameters:
Parameter | Type | Description |
---|---|---|
$filename |
string | |
$interval |
integer|float | Time between shots. |
$length |
integer|float | Time how long to keep taking pictures. |
$timeUnit |
string | Optional. Time unit for $interval and $length. Default: Raspicam::TIMEUNIT_SECOND |
Class that abstracts the usage of raspivid cli utility that is used to record videos with the Raspberry Pi camera module.
- Full name: \Cvuorinen\Raspicam\Raspivid
- Parent class: \Cvuorinen\Raspicam\Raspicam
See Also:
Raspivid constructor.
Raspivid::__construct( array $options = array() )
Example:
$camera = new Raspivid([
'width' => 640,
'height' => 480,
'framerate' => 24,
]);
Parameters:
Parameter | Type | Description |
---|---|---|
$options |
array | Associative array where key=method name & value=parameter passed to the method |
Flips the image both vertically and horizontally
Raspivid::flip( boolean $value = true ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables flip, FALSE disables (default=TRUE) |
Flips the image vertically
Raspivid::verticalFlip( boolean $value = true ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables flip, FALSE disables (default=TRUE) |
Flips the image horizontally
Raspivid::horizontalFlip( boolean $value = true ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
boolean | Optional. TRUE enables flip, FALSE disables (default=TRUE) |
Set the sharpness of the image, 0 is the default (-100 to 100)
Raspivid::sharpness( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Sharpness |
Set the contrast of the image, 0 is the default (-100 to 100)
Raspivid::contrast( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Contrast |
Set the brightness of the image, 50 is the default. 0 is black, 100 is white.
Raspivid::brightness( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Brightness |
Set the colour saturation of the image. 0 is the default (-100 to 100)
Raspivid::saturation( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Saturation |
Sets the ISO to be used for captures. Range is 100 to 800.
Raspivid::ISO( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | ISO |
Set the exposure (EV) compensation of the image. Range is -10 to +10, default is 0.
Raspivid::exposureCompensation( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Exposure compensation |
Set exposure mode
Raspivid::exposure( string $mode ): $this
Possible options are:
- 'auto'
Raspicam::EXPOSURE_AUTO
Use automatic exposure mode - 'night'
Raspicam::EXPOSURE_NIGHT
Select setting for night shooting - 'nightpreview'
Raspicam::EXPOSURE_NIGHTPREVIEW
- 'backlight'
Raspicam::EXPOSURE_BACKLIGHT
Select setting for back lit subject - 'spotlight'
Raspicam::EXPOSURE_SPOTLIGHT
- 'sports'
Raspicam::EXPOSURE_SPORTS
Select setting for sports (fast shutter etc) - 'snow'
Raspicam::EXPOSURE_SNOW
Select setting optimised for snowy scenery - 'beach'
Raspicam::EXPOSURE_BEACH
Select setting optimised for beach - 'verylong'
Raspicam::EXPOSURE_VERYLONG
Select setting for long exposures - 'fixedfps'
Raspicam::EXPOSURE_FIXEDFPS
Constrain fps to a fixed value - 'antishake'
Raspicam::EXPOSURE_ANTISHAKE
Antishake mode - 'fireworks'
Raspicam::EXPOSURE_FIREWORKS
Select settings
Note that not all of these settings may be implemented, depending on camera type.
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string | Exposure mode |
Set Automatic White Balance (AWB) mode
Raspivid::whiteBalance( string $mode ): $this
Possible options are:
- 'off'
Raspicam::WHITE_BALANCE_OFF
Turn off white balance calculation - 'auto'
Raspicam::WHITE_BALANCE_AUTO
Automatic mode (default) - 'sun'
Raspicam::WHITE_BALANCE_SUN
Sunny mode - 'cloud'
Raspicam::WHITE_BALANCE_CLOUD
Cloudy mode - 'shade'
Raspicam::WHITE_BALANCE_SHADE
Shaded mode - 'tungsten'
Raspicam::WHITE_BALANCE_TUNGSTEN
Tungsten lighting mode - 'fluorescent'
Raspicam::WHITE_BALANCE_FLUORESCENT
Fluorescent lighting mode - 'incandescent'
Raspicam::WHITE_BALANCE_INCANDESCENT
Incandescent lighting mode - 'flash'
Raspicam::WHITE_BALANCE_FLASH
Flash mode - 'horizon'
Raspicam::WHITE_BALANCE_HORIZON
Horizon mode
Note that not all of these settings may be implemented, depending on camera type.
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string | AWB mode |
Set an effect to be applied to the image
Raspivid::effect( string $mode ): $this
Possible options are:
- 'none'
Raspicam::EFFECT_NONE
NO effect (default) - 'negative'
Raspicam::EFFECT_NEGATIVE
Negate the image - 'solarise'
Raspicam::EFFECT_SOLARISE
Solarise the image - 'posterise'
Raspicam::EFFECT_POSTERISE
Posterise the image - 'whiteboard'
Raspicam::EFFECT_WHITEBOARD
Whiteboard effect - 'blackboard'
Raspicam::EFFECT_BLACKBOARD
Blackboard effect - 'sketch'
Raspicam::EFFECT_SKETCH
Sketch style effect - 'denoise'
Raspicam::EFFECT_DENOISE
Denoise the image - 'emboss'
Raspicam::EFFECT_EMBOSS
Emboss the image - 'oilpaint'
Raspicam::EFFECT_OILPAINT
Apply an oil paint style effect - 'hatch'
Raspicam::EFFECT_HATCH
Hatch sketch style - 'gpen'
Raspicam::EFFECT_GPEN
- 'pastel'
Raspicam::EFFECT_PASTEL
A pastel style effect - 'watercolour'
Raspicam::EFFECT_WATERCOLOUR
A watercolour style effect - 'film'
Raspicam::EFFECT_FILM
Film grain style effect - 'blur'
Raspicam::EFFECT_BLUR
Blur the image - 'saturation'
Raspicam::EFFECT_SATURATION
Colour saturate the image - 'colourswap'
Raspicam::EFFECT_COLOURSWAP
Not fully implemented - 'washedout'
Raspicam::EFFECT_WASHEDOUT
Not fully implemented - 'colourpoint'
Raspicam::EFFECT_COLOURPOINT
Not fully implemented - 'colourbalance'
Raspicam::EFFECT_COLOURBALANCE
Not fully implemented - 'cartoon'
Raspicam::EFFECT_CARTOON
Not fully implemented
Note that not all of these settings may be available in all circumstances.
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string |
Set metering mode
Raspivid::metering( string $mode ): $this
Possible options are:
- 'average'
Raspicam::METERING_AVERAGE
Average the whole frame for metering - 'spot'
Raspicam::METERING_SPOT
Spot metering - 'backlit'
Raspicam::METERING_BACKLIT
Assume a backlit image - 'matrix'
Raspicam::METERING_MATRIX
Matrix metering
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string |
Enable/Disable Dynamic Range compression
Raspivid::dynamicRangeCompression( string $mode ): $this
DRC changes the images by increasing the range of dark areas of the image, and decreasing the brighter areas. This can improve the image in low light areas.
Possible options are:
- 'off'
Raspicam::DRC_OFF
(default) - 'low'
Raspicam::DRC_LOW
- 'medium'
Raspicam::DRC_MEDIUM
- 'high'
Raspicam::DRC_HIGH
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
string |
Set image rotation
Raspivid::rotate( integer $degrees ): $this
Only 0, 90, 180 and 270 degree rotations are supported.
Parameters:
Parameter | Type | Description |
---|---|---|
$degrees |
integer | Degrees |
Set the shutter speed to the specified time.
Raspivid::shutterSpeed( integer|float $value, string $unit = self::TIMEUNIT_SECOND ): $this
There is currently an upper limit of approximately 6000000us (6000ms, 6s) past which operation is undefined.
Unit can be one of: Raspicam::TIMEUNIT_MINUTE
, Raspicam::TIMEUNIT_SECOND
,
Raspicam::TIMEUNIT_MILLISECOND
, Raspicam::TIMEUNIT_MICROSECOND
.
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer|float | Shutter speed |
$unit |
string | Optional. Time unit for $value Default: Raspicam::TIMEUNIT_SECOND |
Sets a specified sensor mode, disabling the automatic selection.
Raspivid::sensorMode( integer $mode ): $this
Possible values are:
Mode | Size | Aspect ratio | Frame rates | FOV | Binning |
---|---|---|---|---|---|
0 | automatic selection | ||||
1 | 1920x1080 | 16:9 | 1-30fps | Partial | None |
2 | 2592x1944 | 4:3 | 1-15fps | Full | None |
3 | 2592x1944 | 4:3 | 0.1666-1fps | Full | None |
4 | 1296x972 | 4:3 | 1-42fps | Full | 2x2 |
5 | 1296x730 | 16:9 | 1-49fps | Full | 2x2 |
6 | 640x480 | 4:3 | 42.1-60fps | Full | 2x2 plus skip |
7 | 640x480 | 4:3 | 60.1-90fps | Full | 2x2 plus skip |
Parameters:
Parameter | Type | Description |
---|---|---|
$mode |
integer |
Raspivid::getOutput( ): string
Return Value:
Output from the last executed CLI command
Set video width in pixels
Raspivid::width( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Width of resulting video. This should be between 64 and 1920. |
Set video height in pixels
Raspivid::height( integer $value ): $this
Parameters:
Parameter | Type | Description |
---|---|---|
$value |
integer | Height of resulting video. This should be between 64 and 1080. |
Record a video clip for the specified amount of time and save with the given filename
Raspivid::recordVideo( string $filename, integer|float $length, string $timeUnit = self::TIMEUNIT_SECOND )
Time unit can be one of: Raspicam::TIMEUNIT_MINUTE
, Raspicam::TIMEUNIT_SECOND
,
Raspicam::TIMEUNIT_MILLISECOND
, Raspicam::TIMEUNIT_MICROSECOND
.
Example:
// Record a 5s video clip with default settings (1080p30)
$camera->recordVideo('video.h264', 5);
Parameters:
Parameter | Type | Description |
---|---|---|
$filename |
string | |
$length |
integer|float | Time how long to keep recording. |
$timeUnit |
string | Optional. Time unit for $length. Default: Raspicam::TIMEUNIT_SECOND |
This document was automatically generated from source code comments on 2015-12-14 using phpDocumentor and cvuorinen/phpdoc-markdown-public