2.5.59 IDeckLinkIPFlow Interface

The IDeckLinkIPFlow object interface is the base object representing a SMPTE 2110 IP flow.

IDeckLinkIPFlow object interfaces can be obtained from IDeckLinkIPFlowIterator. Alternatively if the flow ID is known, then the IDeckLinkIPFlow object can be obtained by calling IDeckLinkIPExtensions::GetIPFlowByID().

IDeckLinkIPFlow may be queried to obtain the related IDeckLinkIPFlowAttributes, IDeckLinkIPFlowStatus and IDeckLinkIPFlowSetting interfaces.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkIPFlowAttributes

IID_IDeckLinkIPFlowAttributes

An IDeckLinkIPFlowAttributes object interface may be obtained from IDeckLinkIPFlow using QueryInterface

IDeckLinkIPFlowStatus

IID_IDeckLinkIPFlowStatus

An IDeckLinkIPFlowStatus object interface may be obtained from IDeckLinkIPFlow using QueryInterface

IDeckLinkIPFlowSetting

IID_IDeckLinkIPFlowSetting

An IDeckLinkIPFlowSetting object interface may be obtained from IDeckLinkIPFlow using QueryInterface

IDeckLinkIPFlowIterator

IID_IDeckLinkIPFlowIterator

IDeckLinkIPFlowIterator::Next() outputs an IDeckLinkIPFlow object interface

IDeckLinkIPExtensions

IID_IDeckLinkIPExtensions

IDeckLinkIPExtensions::GetIPFlowByID() outputs an IDeckLinkIPFlow object interface

2.5.59.1 IDeckLinkIPFlow::Enable method

HRESULT IDeckLinkIPFlow::Enable();

Enables an IP flow to start sending or receiving.

Return values:
  • E_FAIL – Failure

  • S_OK – Success

2.5.59.2 IDeckLinkIPFlow::Disable method

HRESULT IDeckLinkIPFlow::Disable();

Disables an IP flow to stop sending or receiving.

Return values:
  • E_FAIL – Failure

  • S_OK – Success