2.5.57 IDeckLinkIPExtensions Interface

The IDeckLinkIPExtensions interface represents the collection of flows associated with a SMPTE 2110 device.

Related Interfaces

Interface

Interface ID

Description

IDeckLink

IID_IDeckLink

An IDeckLinkIPExtensions object interface may be obtained from IDeckLink using QueryInterface

IDeckLinkIPFlowIterator

IID_IDeckLinkIPFlowIterator

IDeckLinkIPExtensions::GetDeckLinkIPFlowIterator() outputs an IDeckLinkIPFlowIterator object interface

IDeckLinkIPFlow

IID_IDeckLinkIPFlow

IDeckLinkIPExtensions::GetIPFlowByID() outputs an IDeckLinkIPFlow object interface

2.5.57.1 IDeckLinkIPExtensions::GetDeckLinkIPFlowIterator method

HRESULT IDeckLinkIPExtensions::GetDeckLinkIPFlowIterator(IDeckLinkIPFlowIterator **iterator);

The GetDeckLinkIPFlowIterator method returns an iterator that enumerates the available IP flows associated with the SMPTE 2110 device.

Parameters:

iterator – IP flow iterator. This object must be released by the caller when no longer required.

Return values:

  • E_INVALIDARG – The iterator output pointer is invalid.

  • E_OUTOFMEMORY – Insufficient memory to create the output IP flow iterator object.

  • S_OK – Success

2.5.57.2 IDeckLinkIPExtensions::GetIPFlowByID method

HRESULT IDeckLinkIPExtensions::GetIPFlowByID(BMDIPFlowID id, IDeckLinkIPFlow **flow);

The GetIPFlowByID method returns the IP flow with the matching flow ID.

Parameters:

  • id – The flow ID (See BMDIPFlowID).

  • flow – Pointer to the flow with the matching ID. This object must be released by the called when no longer required.

Return values:

  • E_POINTER – The flow output pointer is invalid.

  • E_INVALIDARG – There is no IP flow associated with the given id.

  • S_OK – Success