Share via

INmChannelAudio::GetState

  • Article

Use the GetState method to retrieve the current state of an Audio Channel object.

HRESULT GetState(
NM_AUDIO_STATE *puState);

Parameters

  • puState
    [out] Pointer to a value from the NM_AUDIO_* state enumeration representing the current state of an audio channel object.

Return Values

NetMeeting client applications can use the SUCCEEDED and FAILED macros in winerror.h to check return values.

Return values can include RPC layer errors or any of the following values.

  • S_OK
    The audio channel state was set successfully.
  • E_POINTER
    puState is not a valid pointer.

Remarks

If the puState of an incoming channel is set to NM_AUDIO_LOCAL_PAUSED, the speaker is muted. If the puState of an outgoing channel is set to NM_AUDIO_LOCAL_PAUSED, the microphone is muted.

Requirements

**  Windows NT/2000:** Requires Windows NT 4.0 SP3 or later.
**  Windows 95/98:** Requires Windows 95 or later. Available as a redistributable for Windows 95.
**  Header:** Imsconf2.idl.

See Also

INmChannelAudio, Audio Channel Object, Audio Channel Object Details