Edit

Share via

ITCallMediaEvent::get_Event method (tapi3if.h)

  • Article

The get_Event method gets the call media event indicator.

Syntax

HRESULT get_Event(
  [out] CALL_MEDIA_EVENT *pCallMediaEvent
);

Parameters

[out] pCallMediaEvent

Pointer to CALL_MEDIA_EVENT indicator.

Return value

This method can return one of these values.

Return code Description
S_OK
 Method succeeded.
E_OUTOFMEMORY
 Insufficient memory exists to perform the operation.
E_POINTER
 The pCallMediaEvent parameter is not a valid pointer.

Remarks

Call media events are a crucial indicator of whether certain operations can be performed. For example, when IVideoWindow is exposed on the Terminal object, until the CME_STREAM_ACTIVE is received only the put_Visible method will succeed. For more information about IVideoWindow and put_Visible, see the DirectX documentation.

Requirements

Requirement Value
Target Platform Windows
Header tapi3if.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

CALL_MEDIA_EVENT

Call Object

ITCallMediaEvent