ch.ecma.csta.binding
Class SetMicrophoneGain

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.SetMicrophoneGain

All Implemented Interfaces:

java.io.Serializable

public class SetMicrophoneGain
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

This request is not supported.

Sets the microphone gain setting of a specified device. This service allows the computing function to control the microphone gain setting (input level) of the microphone associated with one auditory apparatus at a specified device.

The monitoring event sequence is a MicrophoneGainEvent for both device-type and call-type monitoring.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SetMicrophoneGain()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
java.lang.String	getAuditoryApparatus() Returns the value of field 'auditoryApparatus'.
DeviceID	getDevice() Returns the value of field 'device'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
MicrophoneGain	getMicrophoneGain() Returns the value of field 'microphoneGain'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setAuditoryApparatus(java.lang.String auditoryApparatus) Sets the value of field 'auditoryApparatus'.
void	setDevice(DeviceID device) Sets the value of field 'device'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setMicrophoneGain(MicrophoneGain microphoneGain) Sets the value of field 'microphoneGain'.
static SetMicrophoneGain	unmarshalSetMicrophoneGain(java.io.Reader reader) Method unmarshalSetMicrophoneGain
void	validate() Method validate

Methods inherited from class ch.ecma.csta.CastorObject

getOldSessionID, hashCode, setOldSessionID, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetMicrophoneGain

public SetMicrophoneGain()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

Returns:

boolean

getAuditoryApparatus

public java.lang.String getAuditoryApparatus()

Returns the value of field 'auditoryApparatus'. The field 'auditoryApparatus' has the following description: Specifies the auditory apparatus at the designated device on which to set the feature. Mandatory.

Returns:

String

getDevice

public DeviceID getDevice()

Returns the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Mandatory.

Returns:

DeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getMicrophoneGain

public MicrophoneGain getMicrophoneGain()

Returns the value of field 'microphoneGain'. The field 'microphoneGain' has the following description: Specifies the gain as an absolute gain value or that the gain should be incremented or decremented by a switch specified increment. Mandatory.

It may be one of the following possible choices:

• micGainAbs (Value) - Specifies a value from 0 through 100. 0 indicates silence, and 100 indicates maximum gain. The granularity and quantization of the values 1 though 99 are device specific
• micGainInc (Enumerated) - Specifies if the gain is to be incremented or decremented by a switch specified amount. The complete set of possible values is:
  • increment - the gain value is incremented
  • decrement - the gain value is decremented.

Returns:

MicrophoneGain

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setAuditoryApparatus

public void setAuditoryApparatus(java.lang.String auditoryApparatus)

Sets the value of field 'auditoryApparatus'. The field 'auditoryApparatus' has the following description: Specifies the auditory apparatus at the designated device on which to set the feature. Mandatory.

Parameters:

auditoryApparatus - the value of field 'auditoryApparatus'.

setDevice

public void setDevice(DeviceID device)

Sets the value of field 'device'. The field 'device' has the following description: Specifies the device's physical element. Mandatory.

Parameters:

device - the value of field 'device'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setMicrophoneGain

public void setMicrophoneGain(MicrophoneGain microphoneGain)

Sets the value of field 'microphoneGain'. The field 'microphoneGain' has the following description: Specifies the gain as an absolute gain value or that the gain should be incremented or decremented by a switch specified increment. Mandatory.

It may be one of the following possible choices:

• micGainAbs (Value) - Specifies a value from 0 through 100. 0 indicates silence, and 100 indicates maximum gain. The granularity and quantization of the values 1 though 99 are device specific
• micGainInc (Enumerated) - Specifies if the gain is to be incremented or decremented by a switch specified amount. The complete set of possible values is:
  • increment - the gain value is incremented
  • decrement - the gain value is decremented.

Parameters:

microphoneGain - the value of field 'microphoneGain'.

unmarshalSetMicrophoneGain

public static SetMicrophoneGain unmarshalSetMicrophoneGain(java.io.Reader reader)
                                                    throws org.exolab.castor.xml.MarshalException,
                                                           org.exolab.castor.xml.ValidationException

Method unmarshalSetMicrophoneGain

Parameters:

reader -

Returns:

SetMicrophoneGain

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException