VirtualBox

source: vbox/trunk/src/VBox/Main/include/CaptureScreenSettingsImpl.h@ 75326

Last change on this file since 75326 was 75326, checked in by vboxsync, 6 years ago

Recording: Added a read-only ID attribute to ICaptureScreenSettings.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.8 KB
Line 
1/* $Id: CaptureScreenSettingsImpl.h 75326 2018-11-08 15:50:17Z vboxsync $ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation - Capture settings of one virtual screen.
6 */
7
8/*
9 * Copyright (C) 2018 Oracle Corporation
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 */
19
20#ifndef ____H_CAPTURESCREENSETTINGS
21#define ____H_CAPTURESCREENSETTINGS
22
23#include "CaptureScreenSettingsWrap.h"
24
25class CaptureSettings;
26
27namespace settings
28{
29 struct CaptureScreenSettings;
30}
31
32class ATL_NO_VTABLE CaptureScreenSettings :
33 public CaptureScreenSettingsWrap
34{
35public:
36
37 DECLARE_EMPTY_CTOR_DTOR(CaptureScreenSettings)
38
39 HRESULT FinalConstruct();
40 void FinalRelease();
41
42 // public initializer/uninitializer for internal purposes only
43 HRESULT init(CaptureSettings *aParent, uint32_t uScreenId, const settings::CaptureScreenSettings& data);
44 HRESULT init(CaptureSettings *aParent, CaptureScreenSettings *that);
45 HRESULT initCopy(CaptureSettings *aParent, CaptureScreenSettings *that);
46 void uninit();
47
48 // public methods only for internal purposes
49 HRESULT i_loadSettings(const settings::CaptureScreenSettings &data);
50 HRESULT i_saveSettings(settings::CaptureScreenSettings &data);
51
52 void i_rollback();
53 void i_commit();
54 void i_copyFrom(CaptureScreenSettings *aThat);
55 void i_applyDefaults();
56
57private:
58
59 // wrapped ICaptureScreenSettings methods
60 HRESULT isFeatureEnabled(CaptureFeature_T aFeature, BOOL *aEnabled);
61
62 // wrapped ICaptureScreenSettings properties
63 HRESULT getId(ULONG *id);
64 HRESULT getEnabled(BOOL *enabled);
65 HRESULT setEnabled(BOOL enabled);
66 HRESULT getFeatures(ULONG *aFeatures);
67 HRESULT setFeatures(ULONG aFeatures);
68 HRESULT getDestination(CaptureDestination_T *aDestination);
69 HRESULT setDestination(CaptureDestination_T aDestination);
70
71 HRESULT getFileName(com::Utf8Str &aFileName);
72 HRESULT setFileName(const com::Utf8Str &aFileName);
73 HRESULT getMaxTime(ULONG *aMaxTimeS);
74 HRESULT setMaxTime(ULONG aMaxTimeS);
75 HRESULT getMaxFileSize(ULONG *aMaxFileSizeMB);
76 HRESULT setMaxFileSize(ULONG aMaxFileSizeMB);
77 HRESULT getOptions(com::Utf8Str &aOptions);
78 HRESULT setOptions(const com::Utf8Str &aOptions);
79
80 HRESULT getAudioCodec(CaptureAudioCodec_T *aCodec);
81 HRESULT setAudioCodec(CaptureAudioCodec_T aCodec);
82 HRESULT getAudioHz(ULONG *aHz);
83 HRESULT setAudioHz(ULONG aHz);
84 HRESULT getAudioBits(ULONG *aBits);
85 HRESULT setAudioBits(ULONG aBits);
86 HRESULT getAudioChannels(ULONG *aChannels);
87 HRESULT setAudioChannels(ULONG aChannels);
88
89 HRESULT getVideoCodec(CaptureVideoCodec_T *aCodec);
90 HRESULT setVideoCodec(CaptureVideoCodec_T aCodec);
91 HRESULT getVideoWidth(ULONG *aVideoWidth);
92 HRESULT setVideoWidth(ULONG aVideoWidth);
93 HRESULT getVideoHeight(ULONG *aVideoHeight);
94 HRESULT setVideoHeight(ULONG aVideoHeight);
95 HRESULT getVideoRate(ULONG *aVideoRate);
96 HRESULT setVideoRate(ULONG aVideoRate);
97 HRESULT getVideoRateControlMode(CaptureVideoRateControlMode_T *aMode);
98 HRESULT setVideoRateControlMode(CaptureVideoRateControlMode_T aMode);
99 HRESULT getVideoFPS(ULONG *aVideoFPS);
100 HRESULT setVideoFPS(ULONG aVideoFPS);
101 HRESULT getVideoScalingMethod(CaptureVideoScalingMethod_T *aMode);
102 HRESULT setVideoScalingMethod(CaptureVideoScalingMethod_T aMode);
103
104private:
105
106 // internal methods
107 int i_initInternal();
108
109private:
110
111 struct Data;
112 Data *m;
113};
114
115#endif // ____H_CAPTURESCREENSETTINGS
116
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette