Package org.freedesktop.gstreamer.video

Class VideoCodecState

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.video.VideoCodecState

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class VideoCodecState
extends ProxyInstance

Structure representing the state of an incoming or outgoing video stream for encoders and decoders.

Decoders and encoders will receive such a state through their respective setFormat vmethods.

Decoders and encoders can set the downstream state, by using the gst_video_decoder_set_output_state() or gst_video_encoder_set_output_state() methods.

Constructor Summary

Constructors

Constructor	Description
VideoCodecState()	Allocate a new VideoCodecState.
VideoCodecState(int refCount, VideoInfo info, Caps caps, Buffer codecData, Caps allocationCaps, VideoMasteringDisplayInfo masteringDisplayInfo, VideoContentLightLevel contentLightLevel)	Allocate a new VideoCodecState with the fields set to the provided values.
VideoCodecState(int refCount, VideoInfo info, Caps caps, Buffer codecData, Caps allocationCaps, VideoMasteringDisplayInfo masteringDisplayInfo, VideoContentLightLevel contentLightLevel, Arena arena)	Allocate a new VideoCodecState with the fields set to the provided values.
VideoCodecState(Arena arena)	Allocate a new VideoCodecState.
VideoCodecState(MemorySegment address)	Create a VideoCodecState proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the VideoCodecState class
Caps	readAllocationCaps()	Read the value of the field allocation_caps.
Caps	readCaps()	Read the value of the field caps.
Buffer	readCodecData()	Read the value of the field codec_data.
VideoContentLightLevel	readContentLightLevel()	Read the value of the field content_light_level.
@Nullable VideoInfo	readInfo()	Read the value of the field info.
VideoMasteringDisplayInfo	readMasteringDisplayInfo()	Read the value of the field mastering_display_info.
int	readRefCount()	Read the value of the field ref_count.
VideoCodecState	ref()	Increases the refcount of the given state by one.
void	unref()	Decreases the refcount of the state.
void	writeAllocationCaps(Caps allocationCaps)	Write a value in the field allocation_caps.
void	writeCaps(Caps caps)	Write a value in the field caps.
void	writeCodecData(Buffer codecData)	Write a value in the field codec_data.
void	writeContentLightLevel(VideoContentLightLevel contentLightLevel)	Write a value in the field content_light_level.
void	writeInfo(@Nullable VideoInfo info)	Write a value in the field info.
void	writeMasteringDisplayInfo(VideoMasteringDisplayInfo masteringDisplayInfo)	Write a value in the field mastering_display_info.
void	writeRefCount(int refCount)	Write a value in the field ref_count.

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VideoCodecState

public VideoCodecState(MemorySegment address)

Create a VideoCodecState proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

VideoCodecState

public VideoCodecState(Arena arena)

Allocate a new VideoCodecState.

Parameters:

arena - to control the memory allocation scope

VideoCodecState

public VideoCodecState()

Allocate a new VideoCodecState. The memory is allocated with Arena.ofAuto().

VideoCodecState

public VideoCodecState(int refCount,
 VideoInfo info,
 Caps caps,
 Buffer codecData,
 Caps allocationCaps,
 VideoMasteringDisplayInfo masteringDisplayInfo,
 VideoContentLightLevel contentLightLevel,
 Arena arena)

Allocate a new VideoCodecState with the fields set to the provided values.

Parameters:

refCount - value for the field refCount

info - value for the field info

caps - value for the field caps

codecData - value for the field codecData

allocationCaps - value for the field allocationCaps

masteringDisplayInfo - value for the field masteringDisplayInfo

contentLightLevel - value for the field contentLightLevel

arena - to control the memory allocation scope

VideoCodecState

public VideoCodecState(int refCount,
 VideoInfo info,
 Caps caps,
 Buffer codecData,
 Caps allocationCaps,
 VideoMasteringDisplayInfo masteringDisplayInfo,
 VideoContentLightLevel contentLightLevel)

Allocate a new VideoCodecState with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

refCount - value for the field refCount

info - value for the field info

caps - value for the field caps

codecData - value for the field codecData

allocationCaps - value for the field allocationCaps

masteringDisplayInfo - value for the field masteringDisplayInfo

contentLightLevel - value for the field contentLightLevel

Method Details

getType

public static @Nullable Type getType()

Get the GType of the VideoCodecState class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readRefCount

public int readRefCount()

Read the value of the field ref_count.

Returns:

The value of the field ref_count

writeRefCount

public void writeRefCount(int refCount)

Write a value in the field ref_count.

Parameters:

refCount - The new value for the field ref_count

readInfo

public @Nullable VideoInfo readInfo()

Read the value of the field info.

Returns:

The value of the field info

writeInfo

public void writeInfo(@Nullable VideoInfo info)

Write a value in the field info.

Parameters:

info - The new value for the field info

readCaps

public Caps readCaps()

Read the value of the field caps.

Returns:

The value of the field caps

writeCaps

public void writeCaps(Caps caps)

Write a value in the field caps.

Parameters:

caps - The new value for the field caps

readCodecData

public Buffer readCodecData()

Read the value of the field codec_data.

Returns:

The value of the field codec_data

writeCodecData

public void writeCodecData(Buffer codecData)

Write a value in the field codec_data.

Parameters:

codecData - The new value for the field codec_data

readAllocationCaps

public Caps readAllocationCaps()

Read the value of the field allocation_caps.

Returns:

The value of the field allocation_caps

writeAllocationCaps

public void writeAllocationCaps(Caps allocationCaps)

Write a value in the field allocation_caps.

Parameters:

allocationCaps - The new value for the field allocation_caps

readMasteringDisplayInfo

public VideoMasteringDisplayInfo readMasteringDisplayInfo()

Read the value of the field mastering_display_info.

Returns:

The value of the field mastering_display_info

writeMasteringDisplayInfo

public void writeMasteringDisplayInfo(VideoMasteringDisplayInfo masteringDisplayInfo)

Write a value in the field mastering_display_info.

Parameters:

masteringDisplayInfo - The new value for the field mastering_display_info

readContentLightLevel

public VideoContentLightLevel readContentLightLevel()

Read the value of the field content_light_level.

Returns:

The value of the field content_light_level

writeContentLightLevel

public void writeContentLightLevel(VideoContentLightLevel contentLightLevel)

Write a value in the field content_light_level.

Parameters:

contentLightLevel - The new value for the field content_light_level

ref

public VideoCodecState ref()

Increases the refcount of the given state by one.

Returns:

buf

unref

public void unref()

Decreases the refcount of the state. If the refcount reaches 0, the state will be freed.