org.virtualbox_6_0
Class IAudioAdapter

java.lang.Object
  extended by org.virtualbox_6_0.IUnknown
      extended by org.virtualbox_6_0.IAudioAdapter

public class IAudioAdapter
extends IUnknown

The IAudioAdapter interface represents the virtual audio adapter of the virtual machine. Used inIMachine.getAudioAdapter(). Interface ID: {5155BFD3-7BA7-45A8-B26D-C91AE3754E37}


Field Summary
 
Fields inherited from class org.virtualbox_6_0.IUnknown
obj, objMgr, port
 
Constructor Summary
IAudioAdapter(java.lang.String wrapped, org.virtualbox_6_0.ObjectRefManager objMgr, org.virtualbox_6_0.jaxws.VboxPortType port)
           
 
Method Summary
 AudioCodecType getAudioCodec()
          The exact variant of audio codec hardware presented to the guest.
 AudioControllerType getAudioController()
          The emulated audio controller.
 AudioDriverType getAudioDriver()
          Audio driver the adapter is connected to.
 java.lang.Boolean getEnabled()
          Flag whether the audio adapter is present in the guest system.
 java.lang.Boolean getEnabledIn()
          Flag whether the audio adapter is enabled for audio input.
 java.lang.Boolean getEnabledOut()
          Flag whether the audio adapter is enabled for audio output.
 java.util.List<java.lang.String> getPropertiesList()
          Array of names of tunable properties, which can be supported by audio driver.
 java.lang.String getProperty(java.lang.String key)
          Returns an audio specific property string.
static IAudioAdapter queryInterface(IUnknown obj)
           
 void setAudioCodec(AudioCodecType value)
          The exact variant of audio codec hardware presented to the guest.
 void setAudioController(AudioControllerType value)
          The emulated audio controller.
 void setAudioDriver(AudioDriverType value)
          Audio driver the adapter is connected to.
 void setEnabled(java.lang.Boolean value)
          Flag whether the audio adapter is present in the guest system.
 void setEnabledIn(java.lang.Boolean value)
          Flag whether the audio adapter is enabled for audio input.
 void setEnabledOut(java.lang.Boolean value)
          Flag whether the audio adapter is enabled for audio output.
 void setProperty(java.lang.String key, java.lang.String value)
          Sets an audio specific property string.
 
Methods inherited from class org.virtualbox_6_0.IUnknown
getObjMgr, getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IAudioAdapter

public IAudioAdapter(java.lang.String wrapped,
                     org.virtualbox_6_0.ObjectRefManager objMgr,
                     org.virtualbox_6_0.jaxws.VboxPortType port)
Method Detail

getEnabled

public java.lang.Boolean getEnabled()
Flag whether the audio adapter is present in the guest system. If disabled, the virtual guest hardware will not contain any audio adapter. Can only be changed when the VM is not running.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
Flag whether the audio adapter is present in the guest system. If disabled, the virtual guest hardware will not contain any audio adapter. Can only be changed when the VM is not running.

Parameters:
value - Boolean

getEnabledIn

public java.lang.Boolean getEnabledIn()
Flag whether the audio adapter is enabled for audio input. Only relevant if the adapter is enabled.

Returns:
Boolean

setEnabledIn

public void setEnabledIn(java.lang.Boolean value)
Flag whether the audio adapter is enabled for audio input. Only relevant if the adapter is enabled.

Parameters:
value - Boolean

getEnabledOut

public java.lang.Boolean getEnabledOut()
Flag whether the audio adapter is enabled for audio output. Only relevant if the adapter is enabled.

Returns:
Boolean

setEnabledOut

public void setEnabledOut(java.lang.Boolean value)
Flag whether the audio adapter is enabled for audio output. Only relevant if the adapter is enabled.

Parameters:
value - Boolean

getAudioController

public AudioControllerType getAudioController()
The emulated audio controller.

Returns:
org.virtualbox_6_0.AudioControllerType

setAudioController

public void setAudioController(AudioControllerType value)
The emulated audio controller.

Parameters:
value - org.virtualbox_6_0.AudioControllerType

getAudioCodec

public AudioCodecType getAudioCodec()
The exact variant of audio codec hardware presented to the guest. For HDA and SB16, only one variant is available, but for AC'97, there are several.

Returns:
org.virtualbox_6_0.AudioCodecType

setAudioCodec

public void setAudioCodec(AudioCodecType value)
The exact variant of audio codec hardware presented to the guest. For HDA and SB16, only one variant is available, but for AC'97, there are several.

Parameters:
value - org.virtualbox_6_0.AudioCodecType

getAudioDriver

public AudioDriverType getAudioDriver()
Audio driver the adapter is connected to. This setting can only be changed when the VM is not running.

Returns:
org.virtualbox_6_0.AudioDriverType

setAudioDriver

public void setAudioDriver(AudioDriverType value)
Audio driver the adapter is connected to. This setting can only be changed when the VM is not running.

Parameters:
value - org.virtualbox_6_0.AudioDriverType

getPropertiesList

public java.util.List<java.lang.String> getPropertiesList()
Array of names of tunable properties, which can be supported by audio driver.

Returns:
List<String>

queryInterface

public static IAudioAdapter queryInterface(IUnknown obj)

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)
Sets an audio specific property string. If you pass null or empty string as a key value, the given key will be deleted.

Parameters:
key - Name of the key to set.
value - Value to assign to the key.

getProperty

public java.lang.String getProperty(java.lang.String key)
Returns an audio specific property string. If the requested data key does not exist, this function will succeed and return an empty string in the value argument.

Parameters:
key - Name of the key to get.
Returns:
Value of the requested key.