BCOVTVPlayerView Class Reference

Inherits from UIView
Declared in BCOVTVPlayerView.h

Overview

Primary view for displaying video and controls.

  playbackController

The playback controller associated with this player view.

@property (nonatomic, weak) id<BCOVPlaybackController> playbackController

Discussion

The playback controller associated with this player view.

Declared In

BCOVTVPlayerView.h

  delegate

A delegate that conforms to BCOVTVPlayerViewDelegate.

@property (nonatomic, weak) id<BCOVTVPlayerViewDelegate> delegate

Discussion

A delegate that conforms to BCOVTVPlayerViewDelegate.

Declared In

BCOVTVPlayerView.h

  options

The options that were used when creating this BCOVTVPlayerView.

@property (nonatomic, copy, readonly) BCOVTVPlayerViewOptions *options

Discussion

The options that were used when creating this BCOVTVPlayerView.

Declared In

BCOVTVPlayerView.h

  playerType

The video playback configuration: VOD, live, or live DVR. Default value is BCOVTVPlayerTypeVOD.

@property (nonatomic) BCOVTVPlayerType playerType

Discussion

The video playback configuration: VOD, live, or live DVR. Default value is BCOVTVPlayerTypeVOD.

Declared In

BCOVTVPlayerView.h

  contentContainerView

View that holds the video content.

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

Discussion

View that holds the video content.

Declared In

BCOVTVPlayerView.h

  contentOverlayView

View intended to contain views that overlay the video content.

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

Discussion

View intended to contain views that overlay the video content.

Declared In

BCOVTVPlayerView.h

  controlsContainerView

View that contains all controls, static or fading. Set this view’s alpha to zero to hide all controls.

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

Discussion

View that contains all controls, static or fading. Set this view’s alpha to zero to hide all controls.

Declared In

BCOVTVPlayerView.h

  controlsStaticView

View intended to contain UI elements that should not be faded out/in.

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

Discussion

View intended to contain UI elements that should not be faded out/in.

Declared In

BCOVTVPlayerView.h

  controlsFadingView

View intended to contain UI elements that should be faded out/in.

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

Discussion

View intended to contain UI elements that should be faded out/in.

Declared In

BCOVTVPlayerView.h

  controlsFadingViewVisible

The visible state of the controlsFadingView. Can be set manually to temporarily show or hide the controls.

@property (nonatomic) BOOL controlsFadingViewVisible

Discussion

The visible state of the controlsFadingView. Can be set manually to temporarily show or hide the controls.

Declared In

BCOVTVPlayerView.h

  overlayView

View intended to contain views that should overlay all other views.

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

Discussion

View intended to contain views that should overlay all other views.

Declared In

BCOVTVPlayerView.h

  settingsView

settingsView holds the Info, Audio, and Subtitles settings views in the top tab bar, and is a subview of the controlsStaticView view.

@property (nonatomic, readonly) BCOVTVSettingsView *settingsView

Discussion

settingsView holds the Info, Audio, and Subtitles settings views in the top tab bar, and is a subview of the controlsStaticView view.

Declared In

BCOVTVPlayerView.h

  controlsView

controlsView holds the playback progress controls, and is a subview of the controlsFadingView view.

@property (nonatomic, readonly) BCOVTVControlsView *controlsView

Discussion

controlsView holds the playback progress controls, and is a subview of the controlsFadingView view.

Declared In

BCOVTVPlayerView.h

  settingsControlFocusGuide

settingsControlFocusGuide a UIFocusGuide that allows VoiceOver users to navigate between the settings view to the controls view

@property (nonatomic, strong) UIFocusGuide *settingsControlFocusGuide

Discussion

settingsControlFocusGuide a UIFocusGuide that allows VoiceOver users to navigate between the settings view to the controls view

Declared In

BCOVTVPlayerView.h

– initWithOptions:

Initialize a new BCOVTVPlayerView object

- (instancetype)initWithOptions:(BCOVTVPlayerViewOptions *)options

Parameters

options

Options passed to create the TV Player View. Can be nil.

Discussion

Initialize a new BCOVTVPlayerView object

Declared In

BCOVTVPlayerView.h

– dimVideoView:

Manually dim the video view. This method is called automatically whenever the video is paused to make the UI controls more visible.

- (void)dimVideoView:(BOOL)dim

Parameters

dim

Pass YES to dim the video view and make controls more visible.

Discussion

Manually dim the video view. This method is called automatically whenever the video is paused to make the UI controls more visible.

Declared In

BCOVTVPlayerView.h

– showView:

Display a specific set of views in the TV Player UI.

- (void)showView:(BCOVTVShowViewType)viewType

Parameters

viewType

Pass BCOVTVShowViewTypeNone to hide all control views. Pass BCOVTVShowViewTypeControls to display the progress view and its related controls. Pass BCOVTVShowViewTypeSettings to display the top tab bar and its related views.

Discussion

Display a specific set of views in the TV Player UI.

Declared In

BCOVTVPlayerView.h

– showControlsFadingView:completion:

Manually show or hide the controls fading view. If the view is made visible, it will be hidden automatically after a certain amount of playback time.

- (void)showControlsFadingView:(BOOL)show completion:(void ( ^ ) ( void ))completion

Parameters

show

Pass YES to make the controls fading view visible.
completion

Completion routine called when the fading animation has completed.

Discussion

Manually show or hide the controls fading view. If the view is made visible, it will be hidden automatically after a certain amount of playback time.

Declared In

BCOVTVPlayerView.h

– showTopTabBar:

Set the visibility of the top tab bar.

- (void)showTopTabBar:(BOOL)showTopTabBar

Parameters

showTopTabBar

Set to YES to make the top tab bar visible.

Discussion

Set the visibility of the top tab bar.

Declared In

BCOVTVPlayerView.h

– resetHideControlsIntervalTimer

Resets the timer used to keep track of when to hide the controls. If you implement your own controls, you can call this after the user taps on them to prevent the controls from hiding too soon.

- (void)resetHideControlsIntervalTimer

Discussion

Resets the timer used to keep track of when to hide the controls. If you implement your own controls, you can call this after the user taps on them to prevent the controls from hiding too soon.

Declared In

BCOVTVPlayerView.h