KSPROPERTY_TELEPHONY_CALLHOLD

The KSPROPERTY_TELEPHONY_CALLHOLD property is used to control the hold state of a phone call.

Usage Summary Table

Get Set Target Property descriptor type Property value type

Yes

Yes

Filter

KSPROPERTY

BOOL

The property value is of type BOOL and specifies whether the phone call is on hold.

Return Value

A KSPROPERTY_TELEPHONY_CALLHOLD property request returns TRUE if the call in on hold; otherwise, it returns FALSE.

Remarks

If you set the KSPROPERTY_TELEPHONY_CALLHOLD property with a value of TRUE, the phone call will be placed on hold. The expected behavior is that both transmission and reception will be muted. No data will be sent or received in this case. The audio driver will update the call state (TELEPHONY_CALLSTATE) to TELEPHONY_CALLSTATE_HOLD. If you set the KSPROPERTY_TELEPHONY_CALLHOLD property with a value of FALSE, the phone call will be taken off of hold state, and the call state will be updated to TELEPHONY_CALLSTATE_ENABLED.

Requirements

Minimum supported client

Windows 10

Minimum supported server

None supported

Client

Windows 10 Mobile

Header

Ksmedia.h