org.virtualbox_6_0
Class IRecordingScreenSettings

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

public class IRecordingScreenSettings
extends IUnknown

The IRecordingScreenSettings interface represents recording settings of a single virtual screen. This is used only in theIRecordingSettingsinterface. Interface ID: {678FBD9A-93AF-42A7-7F13-79AD6EF1A18D}


Field Summary
 
Fields inherited from class org.virtualbox_6_0.IUnknown
obj, objMgr, port
 
Constructor Summary
IRecordingScreenSettings(java.lang.String wrapped, org.virtualbox_6_0.ObjectRefManager objMgr, org.virtualbox_6_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Long getAudioBits()
          Determines the bits per sample of the recorded audio data.
 java.lang.Long getAudioChannels()
          Determines the audio channels of the recorded audio data.
 RecordingAudioCodec getAudioCodec()
          Determines the audio codec to use for encoding the recorded audio data.
 java.lang.Long getAudioHz()
          Determines the Hertz (Hz) rate of the recorded audio data.
 RecordingDestination getDestination()
          This setting determines the recording destination for this screen.
 java.lang.Boolean getEnabled()
          This setting determines whether this screen is enabled while recording.
 java.lang.Long getFeatures()
          This setting determines all enabled recording features for this screen.
 java.lang.String getFilename()
          This setting determines the filename VirtualBox uses to save the recorded content.
 java.lang.Long getId()
          This attribute contains the screen ID bound to these settings.
 java.lang.Long getMaxFileSize()
          This setting determines the maximal number of recording file size in MB.
 java.lang.Long getMaxTime()
          This setting defines the maximum amount of time in seconds to record.
 java.lang.String getOptions()
          This setting contains any additional recording options required in comma-separated key=value format.
 RecordingVideoCodec getVideoCodec()
          Determines the video codec to use for encoding the recorded video data.
 java.lang.Long getVideoFPS()
          Determines the maximum number of frames per second (FPS).
 java.lang.Long getVideoHeight()
          Determines the vertical resolution of the recorded video data.
 java.lang.Long getVideoRate()
          Determines the bitrate in kilobits per second.
 RecordingVideoRateControlMode getVideoRateControlMode()
          Determines the rate control mode.
 RecordingVideoScalingMethod getVideoScalingMethod()
          Determines the video scaling method to use.
 java.lang.Long getVideoWidth()
          Determines the horizontal resolution of the recorded video data.
 java.lang.Boolean isFeatureEnabled(RecordingFeature feature)
          Returns whether a particular recording feature is enabled for this screen or not.
static IRecordingScreenSettings queryInterface(IUnknown obj)
           
 void setAudioBits(java.lang.Long value)
          Determines the bits per sample of the recorded audio data.
 void setAudioChannels(java.lang.Long value)
          Determines the audio channels of the recorded audio data.
 void setAudioCodec(RecordingAudioCodec value)
          Determines the audio codec to use for encoding the recorded audio data.
 void setAudioHz(java.lang.Long value)
          Determines the Hertz (Hz) rate of the recorded audio data.
 void setDestination(RecordingDestination value)
          This setting determines the recording destination for this screen.
 void setEnabled(java.lang.Boolean value)
          This setting determines whether this screen is enabled while recording.
 void setFeatures(java.lang.Long value)
          This setting determines all enabled recording features for this screen.
 void setFilename(java.lang.String value)
          This setting determines the filename VirtualBox uses to save the recorded content.
 void setMaxFileSize(java.lang.Long value)
          This setting determines the maximal number of recording file size in MB.
 void setMaxTime(java.lang.Long value)
          This setting defines the maximum amount of time in seconds to record.
 void setOptions(java.lang.String value)
          This setting contains any additional recording options required in comma-separated key=value format.
 void setVideoCodec(RecordingVideoCodec value)
          Determines the video codec to use for encoding the recorded video data.
 void setVideoFPS(java.lang.Long value)
          Determines the maximum number of frames per second (FPS).
 void setVideoHeight(java.lang.Long value)
          Determines the vertical resolution of the recorded video data.
 void setVideoRate(java.lang.Long value)
          Determines the bitrate in kilobits per second.
 void setVideoRateControlMode(RecordingVideoRateControlMode value)
          Determines the rate control mode.
 void setVideoScalingMethod(RecordingVideoScalingMethod value)
          Determines the video scaling method to use.
 void setVideoWidth(java.lang.Long value)
          Determines the horizontal resolution of the recorded video data.
 
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

IRecordingScreenSettings

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

getId

public java.lang.Long getId()
This attribute contains the screen ID bound to these settings.

Returns:
Long

getEnabled

public java.lang.Boolean getEnabled()
This setting determines whether this screen is enabled while recording.

Returns:
Boolean

setEnabled

public void setEnabled(java.lang.Boolean value)
This setting determines whether this screen is enabled while recording.

Parameters:
value - Boolean

getFeatures

public java.lang.Long getFeatures()
This setting determines all enabled recording features for this screen.

Returns:
Long

setFeatures

public void setFeatures(java.lang.Long value)
This setting determines all enabled recording features for this screen.

Parameters:
value - Long

getDestination

public RecordingDestination getDestination()
This setting determines the recording destination for this screen.

Returns:
org.virtualbox_6_0.RecordingDestination

setDestination

public void setDestination(RecordingDestination value)
This setting determines the recording destination for this screen.

Parameters:
value - org.virtualbox_6_0.RecordingDestination

getFilename

public java.lang.String getFilename()
This setting determines the filename VirtualBox uses to save the recorded content. This setting cannot be changed while video recording is enabled. NOTE: When setting this attribute, the specified path has to be absolute (full path). When reading this attribute, a full path is always returned.

Returns:
String

setFilename

public void setFilename(java.lang.String value)
This setting determines the filename VirtualBox uses to save the recorded content. This setting cannot be changed while video recording is enabled. NOTE: When setting this attribute, the specified path has to be absolute (full path). When reading this attribute, a full path is always returned.

Parameters:
value - String

getMaxTime

public java.lang.Long getMaxTime()
This setting defines the maximum amount of time in seconds to record. Recording will stop as soon as the defined time interval has elapsed. If this value is zero, recording will not be limited by time. This setting cannot be changed while recording is enabled.

Returns:
Long

setMaxTime

public void setMaxTime(java.lang.Long value)
This setting defines the maximum amount of time in seconds to record. Recording will stop as soon as the defined time interval has elapsed. If this value is zero, recording will not be limited by time. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getMaxFileSize

public java.lang.Long getMaxFileSize()
This setting determines the maximal number of recording file size in MB. Recording will stop as soon as the file size has reached the defined value. If this value is zero, recording will not be limited by the file size. This setting cannot be changed while recording is enabled.

Returns:
Long

setMaxFileSize

public void setMaxFileSize(java.lang.Long value)
This setting determines the maximal number of recording file size in MB. Recording will stop as soon as the file size has reached the defined value. If this value is zero, recording will not be limited by the file size. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getOptions

public java.lang.String getOptions()
This setting contains any additional recording options required in comma-separated key=value format. This setting cannot be changed while recording is enabled. The following keys and their corresponding values are available:
ac_enabledEnables audio recording when set to
true
, otherwise set to
false
to disable.This feature is considered being experimental.

Returns:
String

setOptions

public void setOptions(java.lang.String value)
This setting contains any additional recording options required in comma-separated key=value format. This setting cannot be changed while recording is enabled. The following keys and their corresponding values are available:
ac_enabledEnables audio recording when set to
true
, otherwise set to
false
to disable.This feature is considered being experimental.

Parameters:
value - String

getAudioCodec

public RecordingAudioCodec getAudioCodec()
Determines the audio codec to use for encoding the recorded audio data. This setting cannot be changed while recording is enabled.

Returns:
org.virtualbox_6_0.RecordingAudioCodec

setAudioCodec

public void setAudioCodec(RecordingAudioCodec value)
Determines the audio codec to use for encoding the recorded audio data. This setting cannot be changed while recording is enabled.

Parameters:
value - org.virtualbox_6_0.RecordingAudioCodec

getAudioHz

public java.lang.Long getAudioHz()
Determines the Hertz (Hz) rate of the recorded audio data. This setting cannot be changed while recording is enabled.

Returns:
Long

setAudioHz

public void setAudioHz(java.lang.Long value)
Determines the Hertz (Hz) rate of the recorded audio data. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getAudioBits

public java.lang.Long getAudioBits()
Determines the bits per sample of the recorded audio data. This setting cannot be changed while recording is enabled.

Returns:
Long

setAudioBits

public void setAudioBits(java.lang.Long value)
Determines the bits per sample of the recorded audio data. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getAudioChannels

public java.lang.Long getAudioChannels()
Determines the audio channels of the recorded audio data. Specifiy 2 for stereo or 1 for mono. More than stereo (2) channels are not supported at the moment. This setting cannot be changed while recording is enabled.

Returns:
Long

setAudioChannels

public void setAudioChannels(java.lang.Long value)
Determines the audio channels of the recorded audio data. Specifiy 2 for stereo or 1 for mono. More than stereo (2) channels are not supported at the moment. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getVideoCodec

public RecordingVideoCodec getVideoCodec()
Determines the video codec to use for encoding the recorded video data. This setting cannot be changed while recording is enabled.

Returns:
org.virtualbox_6_0.RecordingVideoCodec

setVideoCodec

public void setVideoCodec(RecordingVideoCodec value)
Determines the video codec to use for encoding the recorded video data. This setting cannot be changed while recording is enabled.

Parameters:
value - org.virtualbox_6_0.RecordingVideoCodec

getVideoWidth

public java.lang.Long getVideoWidth()
Determines the horizontal resolution of the recorded video data. This setting cannot be changed while recording is enabled.

Returns:
Long

setVideoWidth

public void setVideoWidth(java.lang.Long value)
Determines the horizontal resolution of the recorded video data. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getVideoHeight

public java.lang.Long getVideoHeight()
Determines the vertical resolution of the recorded video data. This setting cannot be changed while recording is enabled.

Returns:
Long

setVideoHeight

public void setVideoHeight(java.lang.Long value)
Determines the vertical resolution of the recorded video data. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getVideoRate

public java.lang.Long getVideoRate()
Determines the bitrate in kilobits per second. Increasing this value makes the video look better for the cost of an increased file size or transfer rate. This setting cannot be changed while recording is enabled.

Returns:
Long

setVideoRate

public void setVideoRate(java.lang.Long value)
Determines the bitrate in kilobits per second. Increasing this value makes the video look better for the cost of an increased file size or transfer rate. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getVideoRateControlMode

public RecordingVideoRateControlMode getVideoRateControlMode()
Determines the rate control mode. This setting cannot be changed while recording is enabled.

Returns:
org.virtualbox_6_0.RecordingVideoRateControlMode

setVideoRateControlMode

public void setVideoRateControlMode(RecordingVideoRateControlMode value)
Determines the rate control mode. This setting cannot be changed while recording is enabled.

Parameters:
value - org.virtualbox_6_0.RecordingVideoRateControlMode

getVideoFPS

public java.lang.Long getVideoFPS()
Determines the maximum number of frames per second (FPS). Frames with a higher frequency will be skipped. Reducing this value increases the number of skipped frames and reduces the file size or transfer rate. This setting cannot be changed while recording is enabled.

Returns:
Long

setVideoFPS

public void setVideoFPS(java.lang.Long value)
Determines the maximum number of frames per second (FPS). Frames with a higher frequency will be skipped. Reducing this value increases the number of skipped frames and reduces the file size or transfer rate. This setting cannot be changed while recording is enabled.

Parameters:
value - Long

getVideoScalingMethod

public RecordingVideoScalingMethod getVideoScalingMethod()
Determines the video scaling method to use. This setting cannot be changed while recording is enabled.

Returns:
org.virtualbox_6_0.RecordingVideoScalingMethod

setVideoScalingMethod

public void setVideoScalingMethod(RecordingVideoScalingMethod value)
Determines the video scaling method to use. This setting cannot be changed while recording is enabled.

Parameters:
value - org.virtualbox_6_0.RecordingVideoScalingMethod

queryInterface

public static IRecordingScreenSettings queryInterface(IUnknown obj)

isFeatureEnabled

public java.lang.Boolean isFeatureEnabled(RecordingFeature feature)
Returns whether a particular recording feature is enabled for this screen or not.

Parameters:
feature - Feature to check for.
Returns:
true if the feature is enabled, false if not.