BCOVInteractivityHandlerDelegate Protocol Reference

Conforms to NSObject
Declared in BCOVInteractivityHandler.h

– projectWasCreated:

This delegate method is called if the GET request for fetching the Interactivity project is successful.

- (void)projectWasCreated:(BCOVInteractivityProject *)project

Parameters

project

The BCOVInteractivityProject that was created.

Discussion

This delegate method is called if the GET request for fetching the Interactivity project is successful.

Declared In

BCOVInteractivityHandler.h

– projectRequestFailed:

This delegate method is called if the GET request for fetching the Interactivity project fails.

- (void)projectRequestFailed:(NSError *)error

Parameters

error

The error that was returned.

Discussion

This delegate method is called if the GET request for fetching the Interactivity project fails.

Declared In

BCOVInteractivityHandler.h

– animationTimeForTransition:

The animation timing for a given transition class. Currently only the “Fade” transition is supported. The default value is 0.35

- (CGFloat)animationTimeForTransition:(BCOVInteractivityAnnotationTransition)transition

Parameters

transition

The transition type for the annotation.

Discussion

The animation timing for a given transition class. Currently only the “Fade” transition is supported. The default value is 0.35

Declared In

BCOVInteractivityHandler.h

– fontForTextAnnotation:

The desired font for a text annotation. Unlike a web browser a UIFont size isn’t uniform across iPhone, iPad and tvOS. We use systemFontOfSize:weight: with the font size being 0.018% of AVPlayerLayer’s videoRect width and a weight of UIFontWeightMedium

- (UIFont *)fontForTextAnnotation:(BCOVInteractivityAnnotation *)annotation

Parameters

annotation

The Annotation to be styled.

Discussion

The desired font for a text annotation. Unlike a web browser a UIFont size isn’t uniform across iPhone, iPad and tvOS. We use systemFontOfSize:weight: with the font size being 0.018% of AVPlayerLayer’s videoRect width and a weight of UIFontWeightMedium

You can use this delegate method to ovewrite the default UIFont.

If using a custom font make sure to follow Apple’s guidelines on embedding fonts. https://developer.apple.com/documentation/uikit/text_display_and_fonts/adding_a_custom_font_to_your_app

Declared In

BCOVInteractivityHandler.h

– backgroundColorForTextAnnotation:

The desired background color for a text annotation. Currently we only support the “MULLINS SPECIAL” (black) and “White” themes. If any other theme is selected the styling for “White” will be used.

- (UIColor *)backgroundColorForTextAnnotation:(BCOVInteractivityAnnotation *)annotation

Parameters

annotation

The Annotation to be styled.

Discussion

The desired background color for a text annotation. Currently we only support the “MULLINS SPECIAL” (black) and “White” themes. If any other theme is selected the styling for “White” will be used.

For “MULLINS SPECIAL” we use RBG(68, 68, 68) with an 0.4 alpha component. For “White” we use UIColor.white with an 0.5 alpha component.

You can use this delegate method to set a custom background color for the text annotation.

Declared In

BCOVInteractivityHandler.h

– textColorForTextAnnotation:

The desired text color for a text annotation. Currently we only support the “MULLINS SPECIAL” (black) and “White” themes. If any other theme is selected the styling for “White” will be used.

- (UIColor *)textColorForTextAnnotation:(BCOVInteractivityAnnotation *)annotation

Parameters

annotation

The Annotation to be styled.

Discussion

The desired text color for a text annotation. Currently we only support the “MULLINS SPECIAL” (black) and “White” themes. If any other theme is selected the styling for “White” will be used.

For “MULLINS SPECIAL” we use UIColor.whiteColor. For “White” we use UIColor.black.

You can use this delegate method to set a custom text color for the text annotation.

Declared In

BCOVInteractivityHandler.h

– annotationWasTapped:

This delegate method is called when a user taps the view of an BCOVInteractivityAnnotation which has been configured with a command.

- (void)annotationWasTapped:(BCOVInteractivityAnnotation *)annotation

Parameters

annotation

The Annotation that was tapped.

Discussion

This delegate method is called when a user taps the view of an BCOVInteractivityAnnotation which has been configured with a command.

You can access the command and command data with the annotation’s command and commandData properties.

You can then use those values to add additional behavior.

Declared In

BCOVInteractivityHandler.h

– annotationWasTriggered:

This delegate method is called when a Time Triggered annotation becomes active

- (void)annotationWasTriggered:(BCOVInteractivityAnnotation *)annotation

Parameters

annotation

The Annotation that was triggered.

Discussion

This delegate method is called when a Time Triggered annotation becomes active

You can access the command and command data with the annotation’s command and commandData properties.

You can then use those values to add additional behavior.

Declared In

BCOVInteractivityHandler.h