import"PictureSettingsPlugin.idl";

Public Member Functions
enumerations	get2DOnlyMode ()

enumerations	get3DLeftRightSwap ()

enumerations	get3DMode ()

Integer	getBacklightLevel ()

Integer	getBrightnessLevel ()

enumerations	getColorTemperature ()

Integer	getColourLevel ()

Integer	getColourShift ()

Integer	getContrastLevel ()

enumerations	getDynamicContrast ()

enumerations	getEnergySavingMode ()

enumerations	getFilmMode ()

enumerations	getPictureMode ()

Integer	getSharpnessLevel ()

Integer	getSkinToneLevel ()

enumerations	getVirtual3DMode ()

Integer	getWhiteBalance ([in] enumerations wb_type)

void	pictureReset ()

Boolean	set2DOnlyMode ([in] enumerations new_mode)

Boolean	set3DLeftRightSwap ([in] enumerations swap_mode)

Boolean	set3DMode ([in] enumerations new_mode)

Boolean	setBacklightLevel ([in] Integer backlight_level)

Boolean	setBrightnessLevel ([in] Integer brightness_level)

void	setColorTemperature ([in] enumerations color_temperature)

Boolean	setColourLevel ([in] Integer colour_level)

void	setColourShift ([in] Integer colour_shift)

Boolean	setContrastLevel ([in] Integer contrast_level)

void	setDynamicContrast ([in] enumerations dynamic_contrast)

void	setEnergySavingMode ([in] enumerations new_mode)

void	setFilmMode ([in] enumerations film_mode)

void	setPictureMode ([in] enumerations new_mode)

Boolean	setSharpnessLevel ([in] Integer sharpness_level)

Boolean	setSkinToneLevel ([in] Integer skin_tone_level)

Boolean	setVirtual3DMode ([in] enumerations new_mode)

Boolean	setWhiteBalance ([in] enumerations wb_type, [in] Integer wb_value)

Public Attributes
const Integer	COLOR_TEMP_COOL = 0

const Integer	COLOR_TEMP_COOL_3D = 4

const Integer	COLOR_TEMP_INVALID = -1

const Integer	COLOR_TEMP_NORMAL = 1

const Integer	COLOR_TEMP_NORMAL_3D = 5

const Integer	COLOR_TEMP_PIXELENCE = 3

const Integer	COLOR_TEMP_PIXELENCE_3D = 7

const Integer	COLOR_TEMP_WARM = 2

const Integer	COLOR_TEMP_WARM_3D = 6

const Integer	DYNAMIC_CONTRAST_HIGH = 2

const Integer	DYNAMIC_CONTRAST_INVALID = -1

const Integer	DYNAMIC_CONTRAST_LOW = 0

const Integer	DYNAMIC_CONTRAST_MEDIUM = 1

const Integer	DYNAMIC_CONTRAST_OFF = 3

const Integer	ENERGY_SAVING_AUTO = 4

const Integer	ENERGY_SAVING_INVALID = -1

const Integer	ENERGY_SAVING_MAXIMUM = 3

const Integer	ENERGY_SAVING_MEDIUM = 2

const Integer	ENERGY_SAVING_MINIMUM = 1

const Integer	ENERGY_SAVING_OFF = 0

const Integer	ENERGY_SAVING_SCREEN_OFF = 5

const Integer	FILM_MODE_AUTO = 0

const Integer	FILM_MODE_INVALID = -1

const Integer	FILM_MODE_OFF = 1

const Integer	MODE_2D_ONLY_INVALID = -1

const Integer	MODE_2D_ONLY_LEFT = 1

const Integer	MODE_2D_ONLY_OFF = 0

const Integer	MODE_2D_ONLY_RIGHT = 2

const Integer	MODE_3D_AUTO = 1

const Integer	MODE_3D_GAME = 4

const Integer	MODE_3D_INVALID = -1

const Integer	MODE_3D_OFF = 0

const Integer	MODE_3D_SIDE_BY_SIDE = 2

const Integer	MODE_3D_TOP_BOTTOM = 3

const Integer	MODE_VIRTUAL_3D_HIGH = 3

const Integer	MODE_VIRTUAL_3D_INVALID = -1

const Integer	MODE_VIRTUAL_3D_LOW = 1

const Integer	MODE_VIRTUAL_3D_MEDIUM = 2

const Integer	MODE_VIRTUAL_3D_OFF = 0

const Integer	PICTURE_MODE_CINEMA = 2

const Integer	PICTURE_MODE_DYNAMIC = 0

const Integer	PICTURE_MODE_GAME = 3

const Integer	PICTURE_MODE_INVALID = -1

const Integer	PICTURE_MODE_NATURAL = 1

const Integer	PICTURE_MODE_SPORT = 4

const Integer	SWAP_3D_LEFT_RIGHT = 0

const Integer	SWAP_3D_RIGHT_LEFT = 1

const Integer	WHITE_BALANCE_TYPE_GAIN_B = 2

const Integer	WHITE_BALANCE_TYPE_GAIN_G = 1

const Integer	WHITE_BALANCE_TYPE_GAIN_R = 0

const Integer	WHITE_BALANCE_TYPE_NUMBER = 6

const Integer	WHITE_BALANCE_TYPE_OFFSET_B = 5

const Integer	WHITE_BALANCE_TYPE_OFFSET_G = 4

const Integer	WHITE_BALANCE_TYPE_OFFSET_R = 3

Detailed Description

This is a class which implements global PictureSettings object.

Member Function Documentation

enumerations PictureSettings.get2DOnlyMode ( )

This function gets 2D only mode. If 3D is not enabled, it returns MODE_ONLY_2D_OFF.

                var currentMode = PictureSettings.get2DOnlyMode();
                var testResult = (currentMode == PictureSettings.MODE_2D_ONLY_OFF)
                    || (currentMode == PictureSettings.MODE_2D_ONLY_LEFT)
                    || (currentMode == PictureSettings.MODE_2D_ONLY_RIGHT);

Returns: current 2D only mode

enumerations PictureSettings.get3DLeftRightSwap ( )

Get 3D left right swap.

var swapMode = PictureSettings.get3DLeftRightSwap();

Returns: 3D left right swap mode

enumerations PictureSettings.get3DMode ( )

This function gets 3D mode. If 3D is not enabled, it returns MODE_3D_OFF.

                var currentMode = PictureSettings.get3DMode();
                var testResult = (currentMode == PictureSettings.MODE_3D_OFF)
                    || (currentMode == PictureSettings.MODE_3D_AUTO)
                    || (currentMode == PictureSettings.MODE_3D_SIDE_BY_SIDE)
                    || (currentMode == PictureSettings.MODE_3D_TOP_BOTTOM)
                    || (currentMode == PictureSettings.MODE_3D_GAME);

Returns: current 3D mode

Integer PictureSettings.getBacklightLevel ( )

Get backlight level.

var colourLevel = PictureSettings.getBacklightLevel();

Returns: current backlight level

Integer PictureSettings.getBrightnessLevel ( )

Get brightness level.

var brightnessLevel = PictureSettings.getBrightnessLevel();

Returns: current brightness level

enumerations PictureSettings.getColorTemperature ( )

Get color temperature.

                var currentColorTemperature = PictureSettings.getColorTemperature();
                var testResult = (currentColorTemperature == PictureSettings.COLOR_TEMP_COOL)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_NORMAL)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_WARM)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_PIXELENCE)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_COOL_3D)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_NORMAL_3D)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_WARM_3D)
                    || (currentColorTemperature == PictureSettings.COLOR_TEMP_PIXELENCE_3D);

Returns: New color temperature value

Integer PictureSettings.getColourLevel ( )

Get colour level.

var colourLevel = PictureSettings.getColourLevel();

Returns: current colour level

Integer PictureSettings.getColourShift ( )

This function gets colour shift.

var currentColourShift = PictureSettings.getColourShift();

Returns: current colour shift

Integer PictureSettings.getContrastLevel ( )

Get contrast level for current source.

var contrastLevel = PictureSettings.getContrastLevel();

Returns: current contrast level

enumerations PictureSettings.getDynamicContrast ( )

Get dynamic contrast.

                var currentDynamicContrast = PictureSettings.getDynamicContrast();
                var testResult = (currentDynamicContrast == PictureSettings.DYNAMIC_CONTRAST_LOW)
                    || (currentDynamicContrast == PictureSettings.DYNAMIC_CONTRAST_MEDIUM)
                    || (currentDynamicContrast == PictureSettings.DYNAMIC_CONTRAST_HIGH)
                    || (currentDynamicContrast == PictureSettings.DYNAMIC_CONTRAST_OFF);

Returns: New dynamic contrast value

enumerations PictureSettings.getEnergySavingMode ( )

This function gets energy saving mode.

            var mode = PictureSettings.getEnergySavingMode();
            if (mode != PictureSettings.ENERGY_SAVING_OFF && mode != PictureSettings.ENERGY_SAVING_MINIMUM &&
                mode != PictureSettings.ENERGY_SAVING_MEDIUM && mode != PictureSettings.ENERGY_SAVING_MAXIMUM &&
                mode != PictureSettings.ENERGY_SAVING_AUTO && mode != PictureSettings.ENERGY_SAVING_SCREEN_OFF) {
                result = false;
            }

Returns: current energy saving mode

enumerations PictureSettings.getFilmMode ( )

Get film mode.

var filmMode = PictureSettings.getFilmMode();

Returns: New film mode

enumerations PictureSettings.getPictureMode ( )

Get picture mode.

var pictureMode = PictureSettings.getPictureMode();

Returns: current picture mode

Integer PictureSettings.getSharpnessLevel ( )

Get sharpness level.

var sharpnessLevel = PictureSettings.getSharpnessLevel();

Returns: current sharpness level

Integer PictureSettings.getSkinToneLevel ( )

Get skin tone level.

var skinToneLevel = PictureSettings.getSkinToneLevel();

Returns: New skin tone level

enumerations PictureSettings.getVirtual3DMode ( )

This function gets virtual 3D mode. If 3D is not enabled, it returns MODE_VIRTUAL_3D_OFF.

                    var currentMode = PictureSettings.getVirtual3DMode();
                    var testResult = (currentMode == PictureSettings.MODE_VIRTUAL_3D_OFF)
                        || (currentMode == PictureSettings.MODE_VIRTUAL_3D_LOW)
                        || (currentMode == PictureSettings.MODE_VIRTUAL_3D_MEDIUM)
                        || (currentMode == PictureSettings.MODE_VIRTUAL_3D_HIGH);

Returns: current virtual 3D mode

Integer PictureSettings.getWhiteBalance ( [in] enumerations wb_type )

Get white balance value of a given type.

var redGain = PictureSettings.getWhiteBalance(PictureSettings.WHITE_BALANCE_TYPE_GAIN_R);

Parameters

wb_type white balance type

Returns: current white balance value

void PictureSettings.pictureReset ( )

This function applies default values for picture settings.

PictureSettings.pictureReset();

Boolean PictureSettings.set2DOnlyMode ( [in] enumerations new_mode )

This function sets 2D only mode if 3D is enabled.

var result = PictureSettings.set2DOnlyMode(PictureSettings.MODE_2D_ONLY_LEFT);

Parameters

new_mode new 2D only mode

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.set3DLeftRightSwap ( [in] enumerations swap_mode )

Set 3D left right swap. Current 3D mode should be PictureSettings.MODE_3D_SIDE_BY_SIDE or PictureSettings.MODE_3D_TOP_BOTTOM to be able to set swap mode. Invalid type of parameter throws runtime error.

var result = PictureSettings.set3DLeftRightSwap(PictureSettings.SWAP_3D_RIGHT_LEFT);

Parameters

swap_mode 3D left right swap mode

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.set3DMode ( [in] enumerations new_mode )

This function sets 3D mode if 3D is enabled.

var result = PictureSettings.set3DMode(PictureSettings.MODE_3D_SIDE_BY_SIDE);

Parameters

new_mode new 3D mode

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.setBacklightLevel ( [in] Integer backlight_level )

Set backlight level. Throws exception for invalid type of parameter.

var result = PictureSettings.setBacklightLevel(newBacklightLevel);

Parameters

backlight_level new backlight level. 0 <= backlight_level <= 100

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.setBrightnessLevel ( [in] Integer brightness_level )

Set brightness level. Throws exception for invalid type of parameter.

var result = PictureSettings.setBrightnessLevel(newBrightnessLevel);

Parameters

brightness_level new brightness level. 0 <= brightness_level <= 100

Returns: true if function call is successful, false otherwise

void PictureSettings.setColorTemperature ( [in] enumerations color_temperature )

Set color temperature. Throws exception for invalid value.

PictureSettings.setColorTemperature(PictureSettings.COLOR_TEMP_COOL);

Parameters

color_temperature New color temperature value

Boolean PictureSettings.setColourLevel ( [in] Integer colour_level )

Set colour level. Throws exception for invalid type of parameter.

var result = PictureSettings.setColourLevel(newColourLevel);

Parameters

colour_level new colour level. 0 <= colour_level <= 100

Returns: true if function call is successful, false otherwise

void PictureSettings.setColourShift ( [in] Integer colour_shift )

This function sets colour shift between the range -50 and 50.

var colourShift = 40;

var result = PictureSettings.setColourShift(colourShift);

Parameters

colour_shift new colour shift

Boolean PictureSettings.setContrastLevel ( [in] Integer contrast_level )

Set contrast level for current source. Throws exception for invalid type of parameter.

var result = PictureSettings.setContrastLevel(newContrastLevel);

Parameters

contrast_level new contrast level. 0 <= contrast_level <= 100

Returns: true if function call is successful, false otherwise

void PictureSettings.setDynamicContrast ( [in] enumerations dynamic_contrast )

Set dynamic contrast. Throws exception for invalid value.

PictureSettings.setDynamicContrast(PictureSettings.DYNAMIC_CONTRAST_LOW);

Parameters

dynamic_contrast New dynamic contrast value

void PictureSettings.setEnergySavingMode ( [in] enumerations new_mode )

This function sets energy saving mode.

            for (mode = PictureSettings.ENERGY_SAVING_OFF; mode < numberOfModes; mode++) {
                PictureSettings.setEnergySavingMode(mode);
                if (mode != PictureSettings.getEnergySavingMode()) {
                    result = false;
                    break;
                }
            }

Parameters

new_mode new energy saving mode

void PictureSettings.setFilmMode ( [in] enumerations film_mode )

Set film mode. Throws exception for invalid value.

PictureSettings.setFilmMode(PictureSettings.FILM_MODE_AUTO);

Parameters

film_mode New film mode

void PictureSettings.setPictureMode ( [in] enumerations new_mode )

Set picture mode. Throws exception for invalid value.

PictureSettings.setPictureMode(PictureSettings.PICTURE_MODE_DYNAMIC);

Parameters

new_mode new picture mode

Boolean PictureSettings.setSharpnessLevel ( [in] Integer sharpness_level )

Set sharpness level. Throws exception for invalid type of parameter.

var result = PictureSettings.setSharpnessLevel(newSharpnessLevel);

Parameters

sharpness_level new sharpness level. 0 <= sharpness_level <= 100

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.setSkinToneLevel ( [in] Integer skin_tone_level )

Set skin tone level. Throws exception for invalid type of parameter.

var result = PictureSettings.setSkinToneLevel(newSkinToneLevel);

Parameters

skin_tone_level New skin tone level. -5 <= skin_tone_level <= 5

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.setVirtual3DMode ( [in] enumerations new_mode )

This function sets virtual 3D mode if 3D is enabled.

var result = PictureSettings.setVirtual3DMode(PictureSettings.MODE_VIRTUAL_3D_LOW);

Parameters

new_mode new virtual 3D mode

Returns: true if function call is successful, false otherwise

Boolean PictureSettings.setWhiteBalance	(	[in] enumerations	wb_type,
		[in] Integer	wb_value
	)

Set white balance value of a given type. Throws exception for invalid type of parameter.

var result = PictureSettings.setWhiteBalance(PictureSettings.WHITE_BALANCE_TYPE_GAIN_R, newRedGain);

Parameters

wb_type	white balance type
wb_value	new white balance value. 0 <= wb_value <= 255

Returns: true if function call is successful, false otherwise

Member Data Documentation

const Integer PictureSettings.COLOR_TEMP_COOL = 0

cool color temperature

const Integer PictureSettings.COLOR_TEMP_COOL_3D = 4

cool 3D color temperature

const Integer PictureSettings.COLOR_TEMP_INVALID = -1

invalid color temperature

const Integer PictureSettings.COLOR_TEMP_NORMAL = 1

normal color temperature

const Integer PictureSettings.COLOR_TEMP_NORMAL_3D = 5

normal 3D color temperature

const Integer PictureSettings.COLOR_TEMP_PIXELENCE = 3

pixelence color temperature

const Integer PictureSettings.COLOR_TEMP_PIXELENCE_3D = 7

pixelence 3D color temperature

const Integer PictureSettings.COLOR_TEMP_WARM = 2

warm color temperature

const Integer PictureSettings.COLOR_TEMP_WARM_3D = 6

warm 3D color temperature

const Integer PictureSettings.DYNAMIC_CONTRAST_HIGH = 2

high dynamic contrast

const Integer PictureSettings.DYNAMIC_CONTRAST_INVALID = -1

invalid dynamic contrast

const Integer PictureSettings.DYNAMIC_CONTRAST_LOW = 0

low dynamic contrast

const Integer PictureSettings.DYNAMIC_CONTRAST_MEDIUM = 1

medium dynamic contrast

const Integer PictureSettings.DYNAMIC_CONTRAST_OFF = 3

dynamic contrast off

const Integer PictureSettings.ENERGY_SAVING_AUTO = 4

try to save energy with good user experience

const Integer PictureSettings.ENERGY_SAVING_INVALID = -1

invalid energy saving mode

const Integer PictureSettings.ENERGY_SAVING_MAXIMUM = 3

saves more energy

const Integer PictureSettings.ENERGY_SAVING_MEDIUM = 2

medium energy saving mode

const Integer PictureSettings.ENERGY_SAVING_MINIMUM = 1

saves less energy

const Integer PictureSettings.ENERGY_SAVING_OFF = 0

no energy saving

const Integer PictureSettings.ENERGY_SAVING_SCREEN_OFF = 5

screen off mode

const Integer PictureSettings.FILM_MODE_AUTO = 0

auto film mode

const Integer PictureSettings.FILM_MODE_INVALID = -1

invalid film mode

const Integer PictureSettings.FILM_MODE_OFF = 1

film mode off

const Integer PictureSettings.MODE_2D_ONLY_INVALID = -1

invalid 2D only mode

const Integer PictureSettings.MODE_2D_ONLY_LEFT = 1

2D left mode

const Integer PictureSettings.MODE_2D_ONLY_OFF = 0

no 2D only

const Integer PictureSettings.MODE_2D_ONLY_RIGHT = 2

2D right mode

const Integer PictureSettings.MODE_3D_AUTO = 1

3D auto mode

const Integer PictureSettings.MODE_3D_GAME = 4

3D game mode

const Integer PictureSettings.MODE_3D_INVALID = -1

invalid 3D mode

const Integer PictureSettings.MODE_3D_OFF = 0

no 3D

const Integer PictureSettings.MODE_3D_SIDE_BY_SIDE = 2

3D side by side mode

const Integer PictureSettings.MODE_3D_TOP_BOTTOM = 3

3D top bottom mode

const Integer PictureSettings.MODE_VIRTUAL_3D_HIGH = 3

virtual 3D high mode

const Integer PictureSettings.MODE_VIRTUAL_3D_INVALID = -1

invalid virtual 3D mode

const Integer PictureSettings.MODE_VIRTUAL_3D_LOW = 1

virtual 3D low mode

const Integer PictureSettings.MODE_VIRTUAL_3D_MEDIUM = 2

virtual 3D medium mode

const Integer PictureSettings.MODE_VIRTUAL_3D_OFF = 0

no virtual 3D

const Integer PictureSettings.PICTURE_MODE_CINEMA = 2

cinema picture mode

const Integer PictureSettings.PICTURE_MODE_DYNAMIC = 0

dynamic picture mode

const Integer PictureSettings.PICTURE_MODE_GAME = 3

game picture mode

const Integer PictureSettings.PICTURE_MODE_INVALID = -1

invalid picture mode

const Integer PictureSettings.PICTURE_MODE_NATURAL = 1

natural picture mode

const Integer PictureSettings.PICTURE_MODE_SPORT = 4

sport picture mode

const Integer PictureSettings.SWAP_3D_LEFT_RIGHT = 0

3D left/right swap mode

const Integer PictureSettings.SWAP_3D_RIGHT_LEFT = 1

3D right/left swap mode

const Integer PictureSettings.WHITE_BALANCE_TYPE_GAIN_B = 2

white balance type blue gain

const Integer PictureSettings.WHITE_BALANCE_TYPE_GAIN_G = 1

white balance type green gain

const Integer PictureSettings.WHITE_BALANCE_TYPE_GAIN_R = 0

white balance type red gain

const Integer PictureSettings.WHITE_BALANCE_TYPE_NUMBER = 6

white balance type number

const Integer PictureSettings.WHITE_BALANCE_TYPE_OFFSET_B = 5

white balance type blue offset

const Integer PictureSettings.WHITE_BALANCE_TYPE_OFFSET_G = 4

white balance type green offset

const Integer PictureSettings.WHITE_BALANCE_TYPE_OFFSET_R = 3

white balance type red offset

The documentation for this interface was generated from the following file:

PictureSettingsPlugin.idl

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation