Classes > VideoPlayer class > Methods > VideoPlayer.ImageAdjustPropertyGet method

Remarks

Obtains the current value of a specific property related to image adjustment The value of the property can be modified through the VideoPlayer.ImageAdjustPropertySet method.

For further details about the use of the embedded video mixer see the VideoMixer object section.

For details about video mixing/blending refer to the How to use the video mixer tutorial.

Syntax

[Visual Basic]

Public Function ImageAdjustPropertyGet (

nPlayerIndex as Int16,

nProperty as enumVideoImageAdjustProps,

ByRef nValue as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ImageAdjustPropertyGet (

Int16 nPlayerIndex,

enumVideoImageAdjustProps nProperty,

ref Int32 nValue

);

[C++]

public: enumErrorCodes ImageAdjustPropertyGet (

Int16 nPlayerIndex,

enumVideoImageAdjustProps nProperty,

Int32 __gc *nValue

);

Parameter

Description

nPlayerIndex

Number representing the zero-based index of the player that will use the video player.

nProperty

The property for which we need to retrieve the current value.

Supported values are the following:

Mnemonic value	Value	Meaning
VIDEO_IMAGE_ADJUST_BRIGHTNESS	0	Brightness
VIDEO_IMAGE_ADJUST_CONTRAST	1	Contrast
VIDEO_IMAGE_ADJUST_SATURATION	2	Saturation
VIDEO_IMAGE_ADJUST_HUE	3	Hue
VIDEO_IMAGE_ADJUST_GAMMA_CORRECTION	4	Gamma Correction

nValue

Reference that, on return from the method call, will contain the property value. The minimum, maximum, default and stepping values for the given property can be retrieved through the VideoPlayer.ImageAdjustPropertyRangeGet method.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumErrorCodes.NOERROR (0)	The method call was successful.