2.5.48 IDeckLinkProfileCallback Interface

The IDeckLinkProfileCallback interface is a callback class which is called when the profile is about to change and when a new profile has been activated.

When a DeckLink device has more than 1 profile, an object with an IDeckLinkProfileCallback interface may be registered as a callback with the IDeckLinkProfileManager interface by calling IDeckLinkProfileManager::SetCallback() method.

Related Interfaces

Interface

Interface ID

Description

IDeckLinkProfile

IID_IDeckLinkProfile

An IDeckLinkProfile object interface is passed to IDeckLinkProfileCallback::ProfileChanging()

IDeckLinkProfile

IID_IDeckLinkProfile

An IDeckLinkProfile object interface is passed to IDeckLinkProfileCallback::ProfileActivated()

IDeckLinkProfileManager

IID_IDeckLinkProfileManager

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

2.5.48.1 IDeckLinkProfileCallback::ProfileChanging method

HRESULT IDeckLinkProfileCallback::ProfileChanging(IDeckLinkProfile *profileToBeActivated, Boolean streamsWillBeForcedToStop);

The ProfileChanging method is called when the profile is about to change. This method is abstract in the base interface and must be implemented by the application developer. The result parameter (required by COM) is ignored by the caller.

Tip

The profile change will not complete until the application returns from the callback. When the streamsWillBeForcedToStop input is set to true, the new profile is incompatible with the current profile and any active streams will be forcibly stopped on return. The ProfileChanging callback provides the application the opportunity to stop the streams instead.

Parameters:

  • profileToBeActivated – The profile to be activated.

  • streamsWillBeForcedToStop – When true, the profile to be activated is incompatible with the current profile and the DeckLink hardware will forcibly stop any current streams.

2.5.48.2 IDeckLinkProfileCallback::ProfileActivated method

HRESULT IDeckLinkProfileCallback::ProfileActivated(IDeckLinkProfile *activatedProfile);

The ProfileActivated method is called when the new profile has been activated. This method is abstract in the base interface and must be implemented by the application developer. The result parameter (required by COM) is ignored by the caller.

Tip

When a profile has been activated, rescan appropriate IDeckLinkProfileAttributes and check display mode support with DoesSupportVideoMode for the new profile.

Parameters:

activatedProfile – The profile that has been activated.