D0301
HTML Application SDK  A1.8
Public Member Functions | Public Attributes | List of all members
SoundSettings Interface Reference

import"SoundSettingsPlugin.idl";

Public Member Functions

Boolean enableAutoVolumeLevel ([in] Boolean enable_auto_volume_level)
 
Integer getBalanceLevel ()
 
Integer getBassGainLevel ()
 
enumerations getCurrentAudioOutputDevice ()
 
enumerations getDigitalOut ()
 
enumerations getEqualizerMode ()
 
Integer getEQUserFrequency ([in] enumerations band_index)
 
Boolean getHardOfHearing ()
 
enumerations getHeadphoneOutput ()
 
Integer getHeadphoneVolumeLevel ()
 
Integer getMaxVolumeLevel ()
 
Integer getMinVolumeLevel ()
 
enumerations getSoundMode ()
 
Integer getVolumeLevel ()
 
Boolean isAutoVolumeLevelEnabled ()
 
Boolean setBalanceLevel ([in] Integer balance_level)
 
Boolean setBassGainLevel ([in] Integer bass_gain_level)
 
Boolean setDigitalOut ([in] enumerations output_type)
 
Boolean setEqualizerMode ([in] enumerations equalizer_mode)
 
Boolean setEQUserFrequency ([in] enumerations band_index, [in] Integer band_value)
 
Boolean setHardOfHearing ([in] Boolean enable_hard_of_hearing)
 
Boolean setHeadphoneOutput ([in] enumerations output)
 
Boolean setHeadphoneVolumeLevel ([in] Integer headphone_volume_level)
 
Boolean setSoundMode ([in] enumerations sound_mode)
 
Boolean setVolumeLevel ([in] Integer volume_level)
 

Public Attributes

const Integer DIGITAL_OUT_COMPRESSED = 1
 
const Integer DIGITAL_OUT_PCM = 0
 
const Integer DigitalLine = 2
 
const Integer EQ_10000HZ_BAND = 4
 
const Integer EQ_120HZ_BAND = 0
 
const Integer EQ_1500HZ_BAND = 2
 
const Integer EQ_5000HZ_BAND = 3
 
const Integer EQ_500HZ_BAND = 1
 
const Integer EQ_MODE_CLASSIC = 4
 
const Integer EQ_MODE_FLAT = 3
 
const Integer EQ_MODE_MOVIE = 1
 
const Integer EQ_MODE_MUSIC = 0
 
const Integer EQ_MODE_SPEECH = 2
 
const Integer EQ_MODE_USER = 5
 
const Integer HeadPhone = 1
 
const Integer SOUND_MODE_DUAL_I = 2
 
const Integer SOUND_MODE_DUAL_II = 3
 
const Integer SOUND_MODE_MONO = 0
 
const Integer SOUND_MODE_MONO_LEFT = 4
 
const Integer SOUND_MODE_MONO_RIGHT = 5
 
const Integer SOUND_MODE_STEREO = 1
 
const Integer TVSpeaker = 0
 

Detailed Description

This is a class which implements global SoundSettings.

Member Function Documentation

Boolean SoundSettings.enableAutoVolumeLevel ( [in] Boolean  enable_auto_volume_level)

Enable or disable auto volume level property. Auto volume level property is used to equalize sound level when displayed program is changed.

var refAVLStatus = SoundSettings.isAutoVolumeLevelEnabled();
var ret = SoundSettings.enableAutoVolumeLevel(!refAVLStatus);
Parameters
enable_auto_volume_levelTrue four enabling auto volume level, false for disabling auto volume level.
Returns
true if function call is successfull, false otherwise.
Integer SoundSettings.getBalanceLevel ( )

Get balance level.

var balanceLevel = SoundSettings.getBalanceLevel();
Returns
Current balance level.
Integer SoundSettings.getBassGainLevel ( )

Get bass gain level.

var bassGainLevel = SoundSettings.getBassGainLevel();
Returns
Current bass gain level.
enumerations SoundSettings.getCurrentAudioOutputDevice ( )

Gets audio output device.

var audioOutput = SoundSettings.getCurrentAudioOutputDevice();
Returns
Current audio output device.
enumerations SoundSettings.getDigitalOut ( )

Get digital audio output type.

var digitalAudioOutput = SoundSettings.getDigitalOut();
Returns
Current digital audio output type.
enumerations SoundSettings.getEqualizerMode ( )

Get preferred equalizer mode.

var eqMode = SoundSettings.getEqualizerMode();
Returns
Equalizer mode.
Integer SoundSettings.getEQUserFrequency ( [in] enumerations  band_index)

Get user mode equalizer band value. Throws runtime error if band index is invalid or current mode is not user.

var eqUserBandValue = SoundSettings.getEQUserFrequency(SoundSettings.EQ_120HZ_BAND);
Parameters
band_indexWhich equalizer band.
Returns
Equalizer band value.
Boolean SoundSettings.getHardOfHearing ( )

Get hard of hearing status.

var hardOfHearingEnabled = SoundSettings.getHardOfHearing();
Returns
Whether hard of hearing is enabled or not.
enumerations SoundSettings.getHeadphoneOutput ( )

Get headphone output.

var output = SoundSettings.getHeadphoneOutput();
Returns
One of SoundSettings.HeadPhone or SoundSettings.DigitalLine (lineout).
Integer SoundSettings.getHeadphoneVolumeLevel ( )

Get headphone volume level.

var headphoneVolumeLevel = SoundSettings.getHeadphoneVolumeLevel();
Returns
Current headphone volume level.
Integer SoundSettings.getMaxVolumeLevel ( )

Get maximum volume level.

var maxVolumeLevel = SoundSettings.getMaxVolumeLevel();
Returns
Maximum volume level.
Integer SoundSettings.getMinVolumeLevel ( )

Get minimum volume level.

var minVolumeLevel = SoundSettings.getMinVolumeLevel();
Returns
Minimum volume level.
enumerations SoundSettings.getSoundMode ( )

Get current sound mode.

var soundMode = SoundSettings.getSoundMode();
Returns
Current sound mode.
Integer SoundSettings.getVolumeLevel ( )

Get current volume level.

var volumeLevel = SoundSettings.getVolumeLevel();
Returns
Current volume level.
Boolean SoundSettings.isAutoVolumeLevelEnabled ( )

Get auto volume level state.

var initialAVLStatus = SoundSettings.isAutoVolumeLevelEnabled();
Returns
true if auto volume level enabled, false otherwise
Boolean SoundSettings.setBalanceLevel ( [in] Integer  balance_level)

Set balance level. Invalid type of parameter throws runtime error.

var result = SoundSettings.setBalanceLevel(newBalanceLevel);
Parameters
balance_levelNew balance level. -50 <= balance_level <= 50
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setBassGainLevel ( [in] Integer  bass_gain_level)

Set bass gain level. Invalid type of parameter throws runtime error.

var result = SoundSettings.setBassGainLevel(newBassGainLevel);
Parameters
bass_gain_levelNew bass gain level. -6 <= bass_gain_level <= 6
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setDigitalOut ( [in] enumerations  output_type)

Set digital audio output type. Invalid type of parameter throws runtime error.

result = SoundSettings.setDigitalOut(SoundSettings.DIGITAL_OUT_PCM);
Parameters
output_typeDigital audio output type.
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setEqualizerMode ( [in] enumerations  equalizer_mode)

Set preferred equalizer mode. Invalid type of parameter throws runtime error.

var result = SoundSettings.setEqualizerMode(SoundSettings.EQ_MODE_MOVIE);
Parameters
equalizer_modeEqualizer mode to set.
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setEQUserFrequency ( [in] enumerations  band_index,
[in] Integer  band_value 
)

Set user mode equalizer band value. Equalizer mode should be user. Invalid type of parameter throws runtime error.

var newBandValue = -7;
var result = SoundSettings.setEQUserFrequency(SoundSettings.EQ_1500HZ_BAND, newBandValue);
Parameters
band_indexWhich equalizer band.
band_valueEqualizer band value. -12 <= band_value <= 12.
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setHardOfHearing ( [in] Boolean  enable_hard_of_hearing)

Set hard of hearing preference. Invalid type of parameter throws runtime error.

result = SoundSettings.setHardOfHearing(true);
Parameters
enable_hard_of_hearingEnable/disable hard of hearing.
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setHeadphoneOutput ( [in] enumerations  output)

Set headphone output as headphone or lineout. Invalid type of parameter throws runtime error.

result = SoundSettings.setHeadphoneOutput(SoundSettings.HeadPhone);
Parameters
outputOutput to set (HeadPhone/DigitalLine).
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setHeadphoneVolumeLevel ( [in] Integer  headphone_volume_level)

Set headphone volume level. Headphone output should be SoundSettings.HeadPhone. Invalid type of parameter throws runtime error.

var result = SoundSettings.setHeadphoneVolumeLevel(newVolumeLevel);
Parameters
headphone_volume_levelNew headphone volume level. 0 <= headphone_volume_level <= 100
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setSoundMode ( [in] enumerations  sound_mode)

Set sound mode. Invalid type of parameter throws runtime error.

var result = SoundSettings.setSoundMode(SoundSettings.SOUND_MODE_DUAL_I);
Parameters
sound_modeSound mode to set.
Returns
true if function call is successful, false otherwise
Boolean SoundSettings.setVolumeLevel ( [in] Integer  volume_level)

Set volume level. If volume level is out of minimum/maximum range, volume is set to limits. Returns false for negative volume level. Invalid type of parameter throws runtime error.

var success = SoundSettings.setVolumeLevel(newVolumeLevel);
Parameters
volume_levelNew volume level, as a percentage of the maximum volume.
Returns
true if function call is successful, false otherwise

Member Data Documentation

const Integer SoundSettings.DIGITAL_OUT_COMPRESSED = 1

Compressed audio output type

const Integer SoundSettings.DIGITAL_OUT_PCM = 0

PCM audio output type

const Integer SoundSettings.DigitalLine = 2

Digital lineout output

const Integer SoundSettings.EQ_10000HZ_BAND = 4

10KHz band

const Integer SoundSettings.EQ_120HZ_BAND = 0

120Hz band

const Integer SoundSettings.EQ_1500HZ_BAND = 2

1.5KHz band

const Integer SoundSettings.EQ_5000HZ_BAND = 3

5KHz band

const Integer SoundSettings.EQ_500HZ_BAND = 1

500Hz band

const Integer SoundSettings.EQ_MODE_CLASSIC = 4

Classic equalizer mode

const Integer SoundSettings.EQ_MODE_FLAT = 3

Flat equalizer mode

const Integer SoundSettings.EQ_MODE_MOVIE = 1

Movie equalizer mode

const Integer SoundSettings.EQ_MODE_MUSIC = 0

Music equalizer mode

const Integer SoundSettings.EQ_MODE_SPEECH = 2

Speech equalizer mode

const Integer SoundSettings.EQ_MODE_USER = 5

User equalizer mode

const Integer SoundSettings.HeadPhone = 1

Headphone output

const Integer SoundSettings.SOUND_MODE_DUAL_I = 2

Dual I sound mode

const Integer SoundSettings.SOUND_MODE_DUAL_II = 3

Dual II sound mode

const Integer SoundSettings.SOUND_MODE_MONO = 0

Mono sound mode

const Integer SoundSettings.SOUND_MODE_MONO_LEFT = 4

Mono left sound mode

const Integer SoundSettings.SOUND_MODE_MONO_RIGHT = 5

Mono right sound mode

const Integer SoundSettings.SOUND_MODE_STEREO = 1

Stereo sound mode

const Integer SoundSettings.TVSpeaker = 0

Default display Speaker

The documentation for this interface was generated from the following file:
Web: http://support.vestek.com.tr
Mail: b2bsupport@vestel.com.tr
Tel: +90 212 286 01 06

Vestek Elektronik Ar-Ge A.Ş.
İTÜ Ayazağa Kampüsü Koru Yolu
Arı 2-B Blok Maslak/İstanbul

© Vestel Elektronik Sanayi ve Ticaret AS 2016.
Confidential information of Vestel Elektronik.