org.bytedeco.depthai

Class VideoEncoder

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.Node

org.bytedeco.depthai.VideoEncoder

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai::node")
 @NoOffset
 @Properties(inherit=depthai.class)
public class VideoEncoder
extends Node

\brief VideoEncoder node. Encodes frames into MJPEG, H264 or H265.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.depthai.Node

Node.Connection, Node.DatatypeHierarchy, Node.Input, Node.Output

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
VideoEncoder(PipelineImpl par, long nodeId)
VideoEncoder(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Node.Output	bitstream() Outputs ImgFrame message that carries BITSTREAM encoded (MJPEG, H264 or H265) frame data.
int	getBitrate() Get bitrate in bps
int	getBitrateKbps() Get bitrate in kbps
float	getFrameRate() Get frame rate
int	getHeight() Get input height
int	getKeyframeFrequency() Get keyframe frequency
boolean	getLossless() Get lossless mode.
BytePointer	getName() Retrieves nodes name
int	getNumBFrames() Get number of B frames
int	getNumFramesPool() Get number of frames in pool
VideoEncoderProperties.Profile	getProfile() Get profile
int	getQuality() Get quality
VideoEncoderProperties.RateControlMode	getRateControlMode() Get rate control mode
Pointer	getSize() Get input size
int	getWidth() Get input width
Node.Input	input() Input for NV12 ImgFrame to be encoded Default queue is blocking with size set by 'setNumFramesPool' (4).
void	setBitrate(int bitrate) Set output bitrate in bps.
void	setBitrateKbps(int bitrateKbps) Set output bitrate in kbps.
void	setDefaultProfilePreset(int width, int height, float fps, VideoEncoderProperties.Profile profile) Sets a default preset based on specified input size, frame rate and profile
void	setDefaultProfilePreset(Pointer size, float fps, VideoEncoderProperties.Profile profile) Sets a default preset based on specified input size, frame rate and profile
void	setFrameRate(float frameRate) Sets expected frame rate
void	setKeyframeFrequency(int freq) Set keyframe frequency.
void	setLossless(boolean lossless) Set lossless mode.
void	setNumBFrames(int numBFrames) Set number of B frames to be inserted
void	setNumFramesPool(int frames) Set number of frames in pool
void	setProfile(int width, int height, VideoEncoderProperties.Profile profile) Set encoding profile
void	setProfile(Pointer size, VideoEncoderProperties.Profile profile) Set encoding profile
void	setQuality(int quality) Set quality
void	setRateControlMode(VideoEncoderProperties.RateControlMode mode) Set rate control mode

Methods inherited from class org.bytedeco.depthai.Node

assetManager, clone, getAssets, getInputRefs, getInputs, getOutputRefs, getOutputs, getParentPipeline, getProperties, getRequiredOpenVINOVersion, id, inputs, outputs

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VideoEncoder

public VideoEncoder(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

VideoEncoder

public VideoEncoder(@SharedPtr
                    PipelineImpl par,
                    @Cast(value="int64_t")
                    long nodeId)

Method Detail

getName

@StdString
public BytePointer getName()

Description copied from class: Node

Retrieves nodes name

Overrides:

getName in class Node

input

@MemberGetter
 @ByRef
public Node.Input input()

Input for NV12 ImgFrame to be encoded Default queue is blocking with size set by 'setNumFramesPool' (4).

bitstream

@MemberGetter
 @ByRef
public Node.Output bitstream()

Outputs ImgFrame message that carries BITSTREAM encoded (MJPEG, H264 or H265) frame data.

setDefaultProfilePreset

public void setDefaultProfilePreset(int width,
                                    int height,
                                    float fps,
                                    @ByVal
                                    VideoEncoderProperties.Profile profile)

Sets a default preset based on specified input size, frame rate and profile

Parameters:

width - Input frame width

height - Input frame height

fps - Frame rate in frames per second

profile - Encoding profile

setDefaultProfilePreset

public void setDefaultProfilePreset(@ByVal @Cast(value="std::tuple<int,int>*")
                                    Pointer size,
                                    float fps,
                                    @ByVal
                                    VideoEncoderProperties.Profile profile)

Sets a default preset based on specified input size, frame rate and profile

Parameters:

size - Input frame size

fps - Frame rate in frames per second

profile - Encoding profile

setNumFramesPool

public void setNumFramesPool(int frames)

Set number of frames in pool

Parameters:

frames - Number of pool frames

getNumFramesPool

public int getNumFramesPool()

Get number of frames in pool

Returns:

Number of pool frames

setRateControlMode

public void setRateControlMode(@ByVal
                               VideoEncoderProperties.RateControlMode mode)

Set rate control mode

setProfile

public void setProfile(@ByVal @Cast(value="std::tuple<int,int>*")
                       Pointer size,
                       @ByVal
                       VideoEncoderProperties.Profile profile)

Set encoding profile

setProfile

public void setProfile(int width,
                       int height,
                       @ByVal
                       VideoEncoderProperties.Profile profile)

Set encoding profile

setBitrate

public void setBitrate(int bitrate)

Set output bitrate in bps. Final bitrate depends on rate control mode

setBitrateKbps

public void setBitrateKbps(int bitrateKbps)

Set output bitrate in kbps. Final bitrate depends on rate control mode

setKeyframeFrequency

public void setKeyframeFrequency(int freq)

Set keyframe frequency. Every Nth frame a keyframe is inserted. Applicable only to H264 and H265 profiles Examples: - 30 FPS video, keyframe frequency: 30. Every 1s a keyframe will be inserted - 60 FPS video, keyframe frequency: 180. Every 3s a keyframe will be inserted

setNumBFrames

public void setNumBFrames(int numBFrames)

Set number of B frames to be inserted

setQuality

public void setQuality(int quality)

Set quality

Parameters:

quality - Value between 0-100%. Approximates quality

setLossless

public void setLossless(@Cast(value="bool")
                        boolean lossless)

Set lossless mode. Applies only to [M]JPEG profile

Parameters:

lossless - True to enable lossless jpeg encoding, false otherwise

setFrameRate

public void setFrameRate(float frameRate)

Sets expected frame rate

Parameters:

frameRate - Frame rate in frames per second

getRateControlMode

@ByVal
public VideoEncoderProperties.RateControlMode getRateControlMode()

Get rate control mode

getProfile

@ByVal
public VideoEncoderProperties.Profile getProfile()

Get profile

getBitrate

public int getBitrate()

Get bitrate in bps

getBitrateKbps

public int getBitrateKbps()

Get bitrate in kbps

getKeyframeFrequency

public int getKeyframeFrequency()

Get keyframe frequency

getNumBFrames

public int getNumBFrames()

Get number of B frames

getQuality

public int getQuality()

Get quality

getSize

@ByVal
 @Cast(value="std::tuple<int,int>*")
public Pointer getSize()

Get input size

getWidth

public int getWidth()

Get input width

getHeight

public int getHeight()

Get input height

getFrameRate

public float getFrameRate()

Get frame rate

getLossless

@Cast(value="bool")
public boolean getLossless()

Get lossless mode. Applies only when using [M]JPEG profile.