2.5.21 IDeckLinkAncillaryPacketIterator Interface

The IDeckLinkAncillaryPacketIterator interface is used to enumerate the available ancillary packets in a video frame.

A reference to an IDeckLinkAncillaryPacketIterator interface for an input video frame may be obtained by calling GetPacketIterator on a IDeckLinkVideoFrameAncillaryPackets interface.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkAncillaryPacket

IID_IDeckLinkAncillaryPacket

IDeckLinkAncillaryPacketIterator::Next() outputs an IDeckLinkAncillaryPacket object interface

IDeckLinkVideoFrameAncillaryPackets

IID_IDeckLinkVideoFrameAncillaryPackets

IDeckLinkVideoFrameAncillaryPackets::GetPacketIterator() outputs an IDeckLinkAncillaryPacketIterator object interface

2.5.21.1 IDeckLinkAncillaryPacketIterator::Next method

HRESULT IDeckLinkAncillaryPacketIterator::Next(IDeckLinkAncillaryPacket **packet);

The Next method creates an object representing an ancillary data packet and assigns the address of the IDeckLinkAncillaryPacket interface of the newly created object to the packet parameter.

Parameters:

packet – Pointer to IDeckLinkAncillaryPacket interface object or NULL when no more ancillary packets are available. This object must be released by the caller when no longer required.

Return values:

  • E_INVALIDARG – Parameter packet variable is NULL

  • S_FALSE – No (more) packets found

  • S_OK – Success