IRDPSRAPISharingSession: setting FrameCaptureIntervalInMs property has no effect

Question

IRDPSRAPISharingSession: setting FrameCaptureIntervalInMs property has no effect

BenoitV-GE 31

In order to reduce CPU usage on the sharer side of an RDP session, I try to increase the frame capture interval.
Right after creating the RDPSession I set the "FrameCaptureIntervalInMs" property to a high number but it has no effect: on the viewer side the FPS is still as high as before, and on sharer side the CPU usage is still similar.

Is there anything I am missing to be ableto use this property?

    CHECK(CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED));  
    CHECK(m_rdpSession.CoCreateInstance(__uuidof(RDPSession), nullptr, CLSCTX_INPROC));  
  
    // the following lines are intended to set a capture cadence of 1FPS  
    CComPtr<IRDPSRAPISessionProperties> props;  
    CHECK(m_rdpSession->get_Properties(&props));  
    const CComBSTR propName = "FrameCaptureIntervalInMs";  
    const CComVariant propValue{ 1000, VT_I4 };  
    CHECK(props->put_Property(propName, propValue));

EDIT: m_rdpSession is declared as:
CComPtr<IRDPSRAPISharingSession> m_rdpSession;

Junjie Zhu - MSFT 21,746

Hello @BenoitVertutGE ,
Welcome to Microsoft Q&A!

Try it with the following code first, if there is still a problem, it may be an API problem.

const GUID CLSID_RDPSession = { 0x9B78F0E6, 0x3E05, 0x4A5B, 0xB2, 0xE8, 0xE7, 0x43, 0xA8, 0x95, 0x6B, 0x65 };  
const GUID IID_IRDPSRAPISharingSession = { 0xeeb20886, 0xe470, 0x4cf6, 0x84, 0x2b, 0x27, 0x39, 0xc0, 0xec, 0x5c, 0xfb };  

IRDPSRAPISharingSession* m_rdpSession;  
    IUnknown* iUnknow;  
  
   int res = CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED);  
    res = CoCreateInstance(CLSID_RDPSession, NULL, CLSCTX_ALL, IID_IUnknown, (void**)&iUnknow);  
    res = iUnknow->QueryInterface(IID_IRDPSRAPISharingSession, (void**)&m_rdpSession);  
  
   // the following lines are intended to set a capture cadence of 1FPS  
    CComPtr<IRDPSRAPISessionProperties> props;  
    m_rdpSession->get_Properties(&props);  
  
   const CComBSTR propName = "FrameCaptureIntervalInMs";  
    const CComVariant propValue{ 1000, VT_I4 };  
  
   HRESULT hr = props->put_Property(propName, propValue);

BenoitV-GE 31 Reputation points

2022-10-11T08:47:39.777+00:00

Thank you @Junjie Zhu - MSFT for your quick answer.

Unfortunately using your code snippet with the hard-coded GUID does not help. I manage to set the "FrameCaptureIntervalInMs" property, and to get it back later with get_Property to check that the value is correctly set, but when a client is connected to the session I can observe that the framerate is way higher than 1FPS.
Junjie Zhu - MSFT 21,746 Reputation points

2022-10-11T08:57:16.98+00:00

You can submit this issue in the Feedback Hub first.
I will discuss this issue with the team, if there is a result, I will notify you as soon as possible.
BenoitV-GE 31 Reputation points

2022-10-11T09:20:24.82+00:00

Issue is submitted to Feedback Hub:
https://aka.ms/AAic3vs
Junjie Zhu - MSFT 21,746 Reputation points

2022-11-16T10:06:50.34+00:00

Hi @BenoitV-GE ,

Could you please provide more information to help us further check the problem for you? like the code snippet about view side and some test pictures.

Thank you,
Junjie
BenoitV-GE 31 Reputation points

2022-12-12T12:49:03.98+00:00

Hello @Junjie Zhu - MSFT ,
Please find attached an animated gif capturing sample server & client applications, and showing the frames being updated several dozens of time per second, despite the FrameCaptureIntervalInMs set to 1000 in the server.

The viewer sample is written in C# and use AxRDPCOMAPILib.AxRDPViewer component. But my concern is more on the server side, since my point is to reduce the CPU usage on sharer machine.

I would happily share the source code from these samples but this forum does not allow me to attach a zip file. What would be the most convenient way to share it with you?

Best regards,
Benoît
Junjie Zhu - MSFT 21,746 Reputation points

2022-12-13T02:48:06.443+00:00

You can share it via GitHub or OneDrive, please do not include any personal privacy. By the way, does the viewer on the right use an MFC control?
BenoitV-GE 31 Reputation points

2022-12-13T13:08:09.857+00:00

I uploaded the sample in a specific GitHub repository:
https://github.com/212668253/WDSRemoteControl

The viewer on the right is implemented in C# using .Net controls, in particular AxRDPCOMAPILib.AxRDPViewer
Junjie Zhu - MSFT 21,746 Reputation points

2022-12-15T07:09:06.02+00:00

Hi @BenoitV-GE ,
Thank you for sharing the code, I will reproduce your problem as soon as possible.
BenoitV-GE 31 Reputation points

2023-04-03T11:42:27.0233333+00:00

Hello @Junjie Zhu - MSFT ,

Do you have any update on this issue? Did you manage to reproduce it?
Alex I 90 Reputation points

2023-04-06T13:51:55.5966667+00:00

Try to set value as UInt32. It helped me, and hopefully it will help you. _rdpSession.Properties["FrameCaptureIntervalInMs"] = (uint)100;
BenoitV-GE 31 Reputation points

2023-04-11T11:35:04.1833333+00:00

Indeed this helped! Changing my C++ code to:
const CComVariant propValue{ 1000u, VT_UI4 };
fixed the issue.
Thanks for the suggestion!

Answer accepted by question author

Alex I 90

Try to set value as UInt32. It helped me, and hopefully it will help you. _rdpSession.Properties["FrameCaptureIntervalInMs"] = (uint)100;

0 comments

1 additional answer

Your answer

Junjie Zhu - MSFT 21,746 Reputation points

2022-10-11T06:59:12.687+00:00

Hello @BenoitVertutGE ,
Welcome to Microsoft Q&A!

Try it with the following code first, if there is still a problem, it may be an API problem.

const GUID CLSID_RDPSession = { 0x9B78F0E6, 0x3E05, 0x4A5B, 0xB2, 0xE8, 0xE7, 0x43, 0xA8, 0x95, 0x6B, 0x65 }; const GUID IID_IRDPSRAPISharingSession = { 0xeeb20886, 0xe470, 0x4cf6, 0x84, 0x2b, 0x27, 0x39, 0xc0, 0xec, 0x5c, 0xfb }; IRDPSRAPISharingSession* m_rdpSession; IUnknown* iUnknow; int res = CoInitializeEx(nullptr, COINIT_APARTMENTTHREADED); res = CoCreateInstance(CLSID_RDPSession, NULL, CLSCTX_ALL, IID_IUnknown, (void**)&iUnknow); res = iUnknow->QueryInterface(IID_IRDPSRAPISharingSession, (void**)&m_rdpSession); // the following lines are intended to set a capture cadence of 1FPS CComPtr<IRDPSRAPISessionProperties> props; m_rdpSession->get_Properties(&props); const CComBSTR propName = "FrameCaptureIntervalInMs"; const CComVariant propValue{ 1000, VT_I4 }; HRESULT hr = props->put_Property(propName, propValue);
BenoitV-GE 31 Reputation points

2022-10-11T08:47:39.777+00:00

Thank you @Junjie Zhu - MSFT for your quick answer.

Unfortunately using your code snippet with the hard-coded GUID does not help. I manage to set the "FrameCaptureIntervalInMs" property, and to get it back later with get_Property to check that the value is correctly set, but when a client is connected to the session I can observe that the framerate is way higher than 1FPS.
Junjie Zhu - MSFT 21,746 Reputation points

2022-10-11T08:57:16.98+00:00

You can submit this issue in the Feedback Hub first.
I will discuss this issue with the team, if there is a result, I will notify you as soon as possible.
BenoitV-GE 31 Reputation points

2022-10-11T09:20:24.82+00:00

Issue is submitted to Feedback Hub:
https://aka.ms/AAic3vs
Junjie Zhu - MSFT 21,746 Reputation points

2022-11-16T10:06:50.34+00:00

Hi @BenoitV-GE ,

Could you please provide more information to help us further check the problem for you? like the code snippet about view side and some test pictures.

Thank you,
Junjie
BenoitV-GE 31 Reputation points

2022-12-12T12:49:03.98+00:00

Hello @Junjie Zhu - MSFT ,
Please find attached an animated gif capturing sample server & client applications, and showing the frames being updated several dozens of time per second, despite the FrameCaptureIntervalInMs set to 1000 in the server.

The viewer sample is written in C# and use AxRDPCOMAPILib.AxRDPViewer component. But my concern is more on the server side, since my point is to reduce the CPU usage on sharer machine.

I would happily share the source code from these samples but this forum does not allow me to attach a zip file. What would be the most convenient way to share it with you?

Best regards,
Benoît
Junjie Zhu - MSFT 21,746 Reputation points

2022-12-13T02:48:06.443+00:00

You can share it via GitHub or OneDrive, please do not include any personal privacy. By the way, does the viewer on the right use an MFC control?
BenoitV-GE 31 Reputation points

2022-12-13T13:08:09.857+00:00

I uploaded the sample in a specific GitHub repository:
https://github.com/212668253/WDSRemoteControl

The viewer on the right is implemented in C# using .Net controls, in particular AxRDPCOMAPILib.AxRDPViewer
Junjie Zhu - MSFT 21,746 Reputation points

2022-12-15T07:09:06.02+00:00

Hi @BenoitV-GE ,
Thank you for sharing the code, I will reproduce your problem as soon as possible.
BenoitV-GE 31 Reputation points

2023-04-03T11:42:27.0233333+00:00

Hello @Junjie Zhu - MSFT ,

Do you have any update on this issue? Did you manage to reproduce it?
Alex I 90 Reputation points

2023-04-06T13:51:55.5966667+00:00

Try to set value as UInt32. It helped me, and hopefully it will help you. _rdpSession.Properties["FrameCaptureIntervalInMs"] = (uint)100;
BenoitV-GE 31 Reputation points

2023-04-11T11:35:04.1833333+00:00

Indeed this helped! Changing my C++ code to:
const CComVariant propValue{ 1000u, VT_UI4 };
fixed the issue.
Thanks for the suggestion!

Answer 1

I can also confirm this issue although I am using RDPCOMAPILib as I'm having a .Net-Framework application. Setting a value for "FrameCaptureIntervalInMs" to values like 500 should have a reasonably strong effect but it doesn't change anything.

Code in .Net is quite simple:

var _rdpSession = new RDPCOMAPILib.RDPSession();

_rdpSession.Properties["FrameCaptureIntervalInMs"] = 500; // tried to set the value before starting the host

_rdpSession.Open();

_rdpSession.Properties["FrameCaptureIntervalInMs"] = 500; // and also after starting the host

Did you manage to get this to work?

Regards,

Bruno

Share via

IRDPSRAPISharingSession: setting FrameCaptureIntervalInMs property has no effect

1 additional answer

Your answer