BCOVTVSettingsView Class Reference

Inherits from UIView
Declared in BCOVTVSettingsView.h

Overview

BCOVTVSettingsView View that holds the top tab bar view, and its related top tab bar item views. This view sits inside the BCOVTVPlayerView’s controlsStaticView, a static overlay view.

  insets

Amount by which the controls will be inset from the edge of the TV Player View. Defaults values are (top, left, bottom, right) = (60, 90, 60, 90). The top tab bar is always pinned to the top edge, but its height will change based on the top inset.

@property (nonatomic) UIEdgeInsets insets

Discussion

Amount by which the controls will be inset from the edge of the TV Player View. Defaults values are (top, left, bottom, right) = (60, 90, 60, 90). The top tab bar is always pinned to the top edge, but its height will change based on the top inset.

Declared In

BCOVTVSettingsView.h

  topTabBar

This is the primary top tab bar used to select various settings panel views. The default panels (BCOVTVTabBarItemViews) are “Info”, “Subtitles”, and “Audio”. You can add or remove your own BCOVTVTabBarItemView instances in this tab bar by modifying the topTabBarItemViews array.

@property (nonatomic, weak, readonly) UITabBar *topTabBar

Discussion

This is the primary top tab bar used to select various settings panel views. The default panels (BCOVTVTabBarItemViews) are “Info”, “Subtitles”, and “Audio”. You can add or remove your own BCOVTVTabBarItemView instances in this tab bar by modifying the topTabBarItemViews array.

Declared In

BCOVTVSettingsView.h

  topTabBarBackgroundView

This view spans the width of the screen and provides the background to both the top tab bar and the top tab bar item container view. This view gives the “blur effect” background to the top tab bar and all of its related views.

@property (nonatomic, weak, readonly) UIVisualEffectView *topTabBarBackgroundView

Discussion

This view spans the width of the screen and provides the background to both the top tab bar and the top tab bar item container view. This view gives the “blur effect” background to the top tab bar and all of its related views.

Declared In

BCOVTVSettingsView.h

  topTabBarItemContainerView

This view spans the width of the screen and contains each tab bar item view. Its height automatically resizes to accommodate the height of the currently selected tab bar item view.

@property (nonatomic, weak, readonly) UIView *topTabBarItemContainerView

Discussion

This view spans the width of the screen and contains each tab bar item view. Its height automatically resizes to accommodate the height of the currently selected tab bar item view.

Declared In

BCOVTVSettingsView.h

  topTabBarIndicatorView

This view contains a subview that draws the wide down arrow that reminds the user that they can swipe down to reveal the top tab bar. The subview can be replaced with your own view.

@property (nonatomic, weak, readonly) UIView *topTabBarIndicatorView

Discussion

This view contains a subview that draws the wide down arrow that reminds the user that they can swipe down to reveal the top tab bar. The subview can be replaced with your own view.

Declared In

BCOVTVSettingsView.h

  topTabBarItemContainerViewFocusGuide

This focus guide is installed along the bottom edge of the top tab bar item container view. If a tab bar item view is not wide enough to lie directly underneath an item title in the top tab bar, this focus guide will redirect focus to the default focusable item in the currently selected tab bar item view in the top tab bar.

@property (nonatomic, weak, readonly) UIFocusGuide *topTabBarItemContainerViewFocusGuide

Discussion

This focus guide is installed along the bottom edge of the top tab bar item container view. If a tab bar item view is not wide enough to lie directly underneath an item title in the top tab bar, this focus guide will redirect focus to the default focusable item in the currently selected tab bar item view in the top tab bar.

Declared In

BCOVTVSettingsView.h

  currentTopTabBarItemView

The currently selected tab bar item view.

@property (nonatomic, weak, readonly) BCOVTVTabBarItemView *currentTopTabBarItemView

Discussion

The currently selected tab bar item view.

Declared In

BCOVTVSettingsView.h

  topTabBarItemViews

The array of tab bar item views installed in the top tab bar. This array can be read, modified, and then re-assigned as needed.

@property (nonatomic) NSArray<BCOVTVTabBarItemView*> *topTabBarItemViews

Discussion

The array of tab bar item views installed in the top tab bar. This array can be read, modified, and then re-assigned as needed.

Declared In

BCOVTVSettingsView.h

  bumperModeActive

Set to YES to change the control view’s UI to the bumper state.

@property (nonatomic, readwrite) BOOL bumperModeActive

Discussion

Set to YES to change the control view’s UI to the bumper state.

Declared In

BCOVTVSettingsView.h

  advertisingMode

Set to YES to change the control view’s UI to the advertising state.

@property (nonatomic, readwrite) BOOL advertisingMode

Discussion

Set to YES to change the control view’s UI to the advertising state.

Declared In

BCOVTVSettingsView.h

  isPlaying

Set to YES if player is actively playing

@property (nonatomic, assign) BOOL isPlaying

Discussion

Set to YES if player is actively playing

Declared In

BCOVTVSettingsView.h

  accessibilityDelegate

@property (nonatomic, weak) id<BCOVTVAccessibilityDelegate> accessibilityDelegate

– showTopTabBar:

Show or hide the top tab bar view. Do not use this method to show or hide the top tab bar view. Use [BCOVTVPlayerView showTopTabBar:] instead.

- (void)showTopTabBar:(BOOL)show

Discussion

Show or hide the top tab bar view. Do not use this method to show or hide the top tab bar view. Use [BCOVTVPlayerView showTopTabBar:] instead.

Declared In

BCOVTVSettingsView.h

– enable:tabBarItemView:

Enable or disable a tab bar item view in the top tab bar. By default all tab bar item views are enabled when they are created and installed into the top tab bar. Calling [settingsView enable:NO tabBarItemView:...] disables the tab bar item view and removes it from the top tab bar, but does not remove it from the array of installed top tab bar item views. Calling [settingsView enable:YES tabBarItemView:...] re-enables the tab bar item view and shows it in the top tab bar again This is useful when a tab bar item view has no useful information to display for the current video.

- (void)enable:(BOOL)enable tabBarItemView:(BCOVTVTabBarItemView *)tabBarItemView

Parameters

enable

Pass YES to make the tab bar item view visible. NO to hide.

tabBarItemView

The tab bar item view that you wish to show or hide.

Discussion

Enable or disable a tab bar item view in the top tab bar. By default all tab bar item views are enabled when they are created and installed into the top tab bar. Calling [settingsView enable:NO tabBarItemView:...] disables the tab bar item view and removes it from the top tab bar, but does not remove it from the array of installed top tab bar item views. Calling [settingsView enable:YES tabBarItemView:...] re-enables the tab bar item view and shows it in the top tab bar again This is useful when a tab bar item view has no useful information to display for the current video.

Declared In

BCOVTVSettingsView.h