| 
 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||
java.lang.Objectorg.virtualbox_7_1.IUnknown
org.virtualbox_7_1.IRecordingScreenSettings
public class IRecordingScreenSettings
The IRecordingScreenSettings interface represents recording settings of a
single virtual screen. This is used only in theIRecordingSettingsinterface.
Interface ID: {C1844087-EC6B-488D-AFBB-C90F6452A04B}
| Field Summary | 
|---|
| Fields inherited from class org.virtualbox_7_1.IUnknown | 
|---|
| obj, objMgr, port | 
| Constructor Summary | |
|---|---|
| IRecordingScreenSettings(java.lang.String wrapped,
                         org.virtualbox_7_1.ObjectRefManager objMgr,
                         org.virtualbox_7_1.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. | 
|  RecordingCodecDeadline | getAudioDeadline()Determines the audio deadline to use. | 
|  java.lang.Long | getAudioHz()Determines the Hertz (Hz) rate of the recorded audio data. | 
|  RecordingRateControlMode | getAudioRateControlMode()Determines the audio rate control mode. | 
|  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.util.List<RecordingFeature> | 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, which are currently not represented via own attribtues. | 
|  RecordingVideoCodec | getVideoCodec()Determines the video codec to use for encoding the recorded video data. | 
|  RecordingCodecDeadline | getVideoDeadline()Determines the video deadline to use. | 
|  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. | 
|  RecordingRateControlMode | getVideoRateControlMode()Determines the video rate control mode. | 
|  RecordingVideoScalingMode | getVideoScalingMode()Determines the video scaling mode 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 | setAudioDeadline(RecordingCodecDeadline value)Determines the audio deadline to use. | 
|  void | setAudioHz(java.lang.Long value)Determines the Hertz (Hz) rate of the recorded audio data. | 
|  void | setAudioRateControlMode(RecordingRateControlMode value)Determines the audio rate control mode. | 
|  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.util.List<RecordingFeature> 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, which are currently not represented via own attribtues. | 
|  void | setVideoCodec(RecordingVideoCodec value)Determines the video codec to use for encoding the recorded video data. | 
|  void | setVideoDeadline(RecordingCodecDeadline value)Determines the video deadline to use. | 
|  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(RecordingRateControlMode value)Determines the video rate control mode. | 
|  void | setVideoScalingMode(RecordingVideoScalingMode value)Determines the video scaling mode to use. | 
|  void | setVideoWidth(java.lang.Long value)Determines the horizontal resolution of the recorded video data. | 
| Methods inherited from class org.virtualbox_7_1.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 | 
|---|
public IRecordingScreenSettings(java.lang.String wrapped,
                                org.virtualbox_7_1.ObjectRefManager objMgr,
                                org.virtualbox_7_1.jaxws.VboxPortType port)
| Method Detail | 
|---|
public java.lang.Long getId()
public java.lang.Boolean getEnabled()
public void setEnabled(java.lang.Boolean value)
value - Booleanpublic java.util.List<RecordingFeature> getFeatures()
public void setFeatures(java.util.List<RecordingFeature> value)
value - List<org.virtualbox_7_1.RecordingFeature>public RecordingDestination getDestination()
public void setDestination(RecordingDestination value)
value - org.virtualbox_7_1.RecordingDestinationpublic java.lang.String getFilename()
public void setFilename(java.lang.String value)
value - Stringpublic java.lang.Long getMaxTime()
public void setMaxTime(java.lang.Long value)
value - Longpublic java.lang.Long getMaxFileSize()
public void setMaxFileSize(java.lang.Long value)
value - Longpublic java.lang.String getOptions()
public void setOptions(java.lang.String value)
value - Stringpublic RecordingAudioCodec getAudioCodec()
public void setAudioCodec(RecordingAudioCodec value)
value - org.virtualbox_7_1.RecordingAudioCodecpublic RecordingRateControlMode getAudioRateControlMode()
public void setAudioRateControlMode(RecordingRateControlMode value)
value - org.virtualbox_7_1.RecordingRateControlModepublic RecordingCodecDeadline getAudioDeadline()
public void setAudioDeadline(RecordingCodecDeadline value)
value - org.virtualbox_7_1.RecordingCodecDeadlinepublic java.lang.Long getAudioHz()
public void setAudioHz(java.lang.Long value)
value - Longpublic java.lang.Long getAudioBits()
public void setAudioBits(java.lang.Long value)
value - Longpublic java.lang.Long getAudioChannels()
public void setAudioChannels(java.lang.Long value)
value - Longpublic RecordingVideoCodec getVideoCodec()
public void setVideoCodec(RecordingVideoCodec value)
value - org.virtualbox_7_1.RecordingVideoCodecpublic RecordingCodecDeadline getVideoDeadline()
public void setVideoDeadline(RecordingCodecDeadline value)
value - org.virtualbox_7_1.RecordingCodecDeadlinepublic java.lang.Long getVideoWidth()
public void setVideoWidth(java.lang.Long value)
value - Longpublic java.lang.Long getVideoHeight()
public void setVideoHeight(java.lang.Long value)
value - Longpublic java.lang.Long getVideoRate()
public void setVideoRate(java.lang.Long value)
value - Longpublic RecordingRateControlMode getVideoRateControlMode()
public void setVideoRateControlMode(RecordingRateControlMode value)
value - org.virtualbox_7_1.RecordingRateControlModepublic java.lang.Long getVideoFPS()
public void setVideoFPS(java.lang.Long value)
value - Longpublic RecordingVideoScalingMode getVideoScalingMode()
public void setVideoScalingMode(RecordingVideoScalingMode value)
value - org.virtualbox_7_1.RecordingVideoScalingModepublic static IRecordingScreenSettings queryInterface(IUnknown obj)
public java.lang.Boolean isFeatureEnabled(RecordingFeature feature)
feature - Feature to check for.
| 
 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||