IMediaRadioManager::OnSystemRadioStateChange method

Article
06/09/2017

TheOnSystemRadioStateChange method informs of a system radio state change. This change can affect the state of any radio instances associated with a radio manager.

Syntax

HRESULT OnSystemRadioStateChange(
  [in] SYSTEM_RADIO_STATE sysRadioState,
  [in] UINT32             uTimeoutSec
);

Parameters

sysRadioState [in]
The current on/off state of the system radio.

Value	Meaning
SRS_RADIO_ENABLED	This value indicates that each individual device radio can exist in any state defined by DEVICE_RADIO_STATE. In the event all device radios are turned off directly, the system radio will remain in the enabled state.
SRS_RADIO_DISABLED	When system in this state, any device radio state, indicated by DEVICE_RADIO_STATE, must include either DEVICE_SW_RADIO_OFF or DEVICE_RADIO_UNCONTROLLABLE.

uTimeoutSec [in]
Specifies the time-out value in seconds. The recommended value range is between 1 and 5 seconds.

Return value

Returns S_OK on success or one of the standard error HRESULT values.

Remarks

This is a synchronous call; returning S_OK if all radio instances managed by this Media Radio Manager have changed the radio state successfully.

If sysRadioState is SRS_RADIO_ENABLED, the device radio associated with the radio instance managed by this Media Radio Manager needs to transition to a previous device radio state.

If sysRadioState is SRS_RADIO_DISABLED, the Media Radio Manager needs to record the current device radio state for later use and set the radio state to either DEVICE_SW_RADIO_OFF or DEVICE_RADIO_UNCONTROLLABLE.

Requirements

Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target platform	Desktop

Share via