2.5.45 IDeckLinkProfileManager Interface

The IDeckLinkProfileManager interface allows an application to control the profiles for a DeckLink device that has multiple profiles.

An IDeckLinkProfileManager interface can be obtained from an IDeckLink interface using QueryInterface.

Note

If a DeckLink device only has a single profile, then QueryInterface will fail and return E_NOINTERFACE.

Related Interfaces

Interface

Interface ID

Description

IDeckLink

IID_IDeckLink

An IDeckLinkProfileManager object interface may be obtained from IDeckLink using QueryInterface

IDeckLinkProfileIterator

IID_IDeckLinkProfileIterator

IDeckLinkProfileManager::GetProfiles() outputs an IDeckLinkProfileIterator object interface

IDeckLinkProfile

IID_IDeckLinkProfile

IDeckLinkProfileManager::GetProfile() outputs an IDeckLinkProfile object interface

IDeckLinkProfileCallback

IID_IDeckLinkProfileCallback

An IDeckLinkProfileCallback object interface is registered with IDeckLinkProfileManager::SetCallback()

2.5.45.1 IDeckLinkProfileManager::GetProfiles method

HRESULT IDeckLinkProfileManager::GetProfiles(IDeckLinkProfileIterator **profileIterator);

The GetProfiles method returns an iterator which enumerates the available profiles in the profile group represented by the IDeckLinkProfileManager object.

Parameters:

profileIterator – Profile iterator. This object must be released by the caller when no longer required.

Return values:

  • E_INVALIDARG – Parameter profileIterator variable is NULL

  • E_OUTOFMEMORY – Insufficient memory to create iterator

  • S_OK – Success

2.5.45.2 IDeckLinkProfileManager::GetProfile method

HRESULT IDeckLinkProfileManager::GetProfile(BMDProfileID profileID, IDeckLinkProfile **profile);

The GetProfile method gets the IDeckLinkProfile interface object for a profile with the given BMDProfileID.

Parameters:

  • profileID – The ID of the requested profile (see BMDProfileID).

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

Return values:

  • E_INVALIDARG – Either the parameter profile variable is NULL or there is no profile for this DeckLink device with the given BMDProfileID.

  • S_OK – Success

2.5.45.3 IDeckLinkProfileManager::SetCallback method

HRESULT IDeckLinkProfileManager::SetCallback(IDeckLinkProfileCallback *callback);

The SetCallback method is called to register an instance of an IDeckLinkProfileCallback object. The registered object facilitates the notification of change in active profile.

Parameters:

callback – The IDeckLinkProfileCallback object to be registered.

Return values:

S_OK – Success