BCOVPUIBasicControlView Class Reference

Inherits from UIView
Declared in BCOVPUIBasicControlView.h

Overview

Basic controls view.

  backgroundView

The background view for the controls. This view has a subview of class UIVisualEffectView with a dark blur effect.

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

Discussion

The background view for the controls. This view has a subview of class UIVisualEffectView with a dark blur effect.

Declared In

BCOVPUIBasicControlView.h

  layout

The layout used organize the controls.

@property (nonatomic, copy) BCOVPUIControlLayout *layout

Discussion

The layout used organize the controls.

Declared In

BCOVPUIBasicControlView.h

  playbackButton

The playback button

@property (nonatomic, weak, readonly) BCOVPUIButton *playbackButton

Discussion

The playback button

Declared In

BCOVPUIBasicControlView.h

  jumpBackButton

The jump back button

@property (nonatomic, weak, readonly) BCOVPUIButton *jumpBackButton

Discussion

The jump back button

Declared In

BCOVPUIBasicControlView.h

  currentTimeLabel

The current time (elapsed) label

@property (nonatomic, weak, readonly) BCOVUILabel *currentTimeLabel

Discussion

The current time (elapsed) label

Declared In

BCOVPUIBasicControlView.h

  timeSeparatorLabel

The time separator label

@property (nonatomic, weak, readonly) UILabel *timeSeparatorLabel

Discussion

The time separator label

Declared In

BCOVPUIBasicControlView.h

  durationLabel

The duration label

@property (nonatomic, weak, readonly) BCOVUILabel *durationLabel

Discussion

The duration label

Declared In

BCOVPUIBasicControlView.h

  progressSlider

The progress slider

@property (nonatomic, weak, readonly) BCOVPUISlider *progressSlider

Discussion

The progress slider

Declared In

BCOVPUIBasicControlView.h

  routeDetector

The AVRouteDetector used when allowsExternalPlayback is enabled.

@property (nonatomic, readonly) AVRouteDetector *routeDetector

Discussion

The AVRouteDetector used when allowsExternalPlayback is enabled.

Declared In

BCOVPUIBasicControlView.h

  closedCaptionButton

The closed caption button

@property (nonatomic, weak, readonly) BCOVPUIButton *closedCaptionButton

Discussion

The closed caption button

Declared In

BCOVPUIBasicControlView.h

  screenModeButton

The screen mode (fullscreen) button

@property (nonatomic, weak, readonly) BCOVPUIButton *screenModeButton

Discussion

The screen mode (fullscreen) button

Declared In

BCOVPUIBasicControlView.h

  video360Button

Only appears on iPhone devices

@property (nonatomic, weak, readonly) BCOVPUIButton *video360Button

Discussion

Only appears on iPhone devices

Declared In

BCOVPUIBasicControlView.h

  externalRouteViewButton

The external route (airplay) button

@property (nonatomic, weak, readonly) BCOVPUIButton *externalRouteViewButton

Discussion

The external route (airplay) button

Declared In

BCOVPUIBasicControlView.h

  liveButton

The “go to live” button

@property (nonatomic, weak, readonly) BCOVPUIButton *liveButton

Discussion

The “go to live” button

Declared In

BCOVPUIBasicControlView.h

  preferredBitrateButton

Only appears when videoQualityOptions is set on BCOVPUIPlayerViewOptions

@property (nonatomic, weak, readonly) BCOVPUIButton *preferredBitrateButton

Discussion

Only appears when videoQualityOptions is set on BCOVPUIPlayerViewOptions

Declared In

BCOVPUIBasicControlView.h

  pictureInPictureButton

The Picture-In-Picture Button

@property (nonatomic, weak, readonly) BCOVPUIButton *pictureInPictureButton

Discussion

The Picture-In-Picture Button

Declared In

BCOVPUIBasicControlView.h

  closedCaptionEnabled

Yes if the closedCaptionButton is visible. No if invisible.

@property (nonatomic, readonly, getter=isClosedCaptionEnabled) BOOL closedCaptionEnabled

Discussion

Yes if the closedCaptionButton is visible. No if invisible.

Declared In

BCOVPUIBasicControlView.h

  externalRouteEnabled

Yes if the externalRouteViewButton is visible. No if invisible.

@property (nonatomic, assign, readonly, getter=isExternalRouteEnabled) BOOL externalRouteEnabled

Discussion

Yes if the externalRouteViewButton is visible. No if invisible.

Declared In

BCOVPUIBasicControlView.h

  preferredBitrateEnabled

Yes if the preferredBitrateButton is visible. No if invisible

@property (nonatomic, assign) BOOL preferredBitrateEnabled

Discussion

Yes if the preferredBitrateButton is visible. No if invisible

Declared In

BCOVPUIBasicControlView.h

  pictureInPictureEnabled

@property (nonatomic, assign) BOOL pictureInPictureEnabled

  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

BCOVPUIBasicControlView.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

BCOVPUIBasicControlView.h

+ layoutViewWithControlFromTag:width:elasticity:

Convenience factory method for creating a layout view with a subview determined by the specified tag. Layout views are bundled into arrays and used to create a BCOVPUIControlLayout instance.

+ (BCOVPUILayoutView *)layoutViewWithControlFromTag:(BCOVPUIViewTag)tag width:(CGFloat)width elasticity:(CGFloat)elasticity

Parameters

tag

A tag value indicating the desired control or empty layout view.
width

The minimum width of the new layout view. Pass kBCOVPUILayoutUseDefaultValue to use the default width for the specific control.
elasticity

The relative amount that a layout view can expand to fill space. Elasticity is relative to other layout views.

Return Value

A BCOVPUILayoutView instance initialized with a subview specified by the tag, width, and elasticity.

Discussion

Convenience factory method for creating a layout view with a subview determined by the specified tag. Layout views are bundled into arrays and used to create a BCOVPUIControlLayout instance.

Declared In

BCOVPUIBasicControlView.h

+ basicControlViewWithVODLayout

Convenience factory method to create a control view with a control layout for Video On Demand streams.

+ (instancetype)basicControlViewWithVODLayout

Return Value

A BCOVPUIBasicControlView instance initialzed with a control layout for Video On Demand streams.

Discussion

Convenience factory method to create a control view with a control layout for Video On Demand streams.

Declared In

BCOVPUIBasicControlView.h

+ basicControlViewWithLiveLayout

Convenience factory method to create a control view with a control layout for live video streams.

+ (instancetype)basicControlViewWithLiveLayout

Return Value

A BCOVPUIBasicControlView instance initialzed with a control layout for live video streams.

Discussion

Convenience factory method to create a control view with a control layout for live video streams.

Declared In

BCOVPUIBasicControlView.h

+ basicControlViewWithLiveDVRLayout

Convenience factory method to create a control view with a control layout for live DVR video streams.

+ (instancetype)basicControlViewWithLiveDVRLayout

Return Value

A BCOVPUIBasicControlView instance initialzed with a control layout for live DVR video streams.

Discussion

Convenience factory method to create a control view with a control layout for live DVR video streams.

Declared In

BCOVPUIBasicControlView.h

+ basicControlViewWithAODLayout

Convenience factory method to create a control view with a control layout for audio-only Video On Demand streams.

+ (instancetype)basicControlViewWithAODLayout

Return Value

A BCOVPUIBasicControlView instance initialzed with a control layout for audio-only Video On Demand streams.

Discussion

Convenience factory method to create a control view with a control layout for audio-only Video On Demand streams.

Declared In

BCOVPUIBasicControlView.h

+ basicControlViewWithLiveAudioLayout

Convenience factory method to create a control view with a control layout for audio-only live video streams.

+ (instancetype)basicControlViewWithLiveAudioLayout

Return Value

A BCOVPUIBasicControlView instance initialzed with a control layout for live audio-only streams.

Discussion

Convenience factory method to create a control view with a control layout for audio-only live video streams.

Declared In

BCOVPUIBasicControlView.h

+ basicControlViewWithLiveDVRAudioLayout

Convenience factory method to create a control view with a control layout for live DVR video streams.

+ (instancetype)basicControlViewWithLiveDVRAudioLayout

Return Value

A BCOVPUIBasicControlView instance initialzed with a control layout for live DVR audi-only video streams.

Discussion

Convenience factory method to create a control view with a control layout for live DVR video streams.

Declared In

BCOVPUIBasicControlView.h

– enableControls:

Enable or disable all the standard controls

- (void)enableControls:(BOOL)enabled

Parameters

enabled

YES to enable; NO to disable.

Discussion

Enable or disable all the standard controls

Declared In

BCOVPUIBasicControlView.h

– setFontSizeForLabels:

Updates all label components with the specified font size.

- (void)setFontSizeForLabels:(CGFloat)fontSize

Parameters

fontSize

The font size to update components with.

Discussion

Updates all label components with the specified font size.

Declared In

BCOVPUIBasicControlView.h

– setFontSizeForButtons:

Updates all button components with the specified font size.

- (void)setFontSizeForButtons:(CGFloat)fontSize

Parameters

fontSize

The font size to update components with.

Discussion

Updates all button components with the specified font size.

Declared In

BCOVPUIBasicControlView.h

– setTextColorForLabels:

Updates all label components with the specified font color.

- (void)setTextColorForLabels:(UIColor *)textColor

Parameters

textColor

The font size to update components with.

Discussion

Updates all label components with the specified font color.

Declared In

BCOVPUIBasicControlView.h

– setTitleColorForButtons:forState:

Updates all button components with the specified color for state.

- (void)setTitleColorForButtons:(UIColor *)titleColor forState:(UIControlState)state

Parameters

titleColor

The color of the title to set.
state

Controls state to set.

Discussion

Updates all button components with the specified color for state.

Declared In

BCOVPUIBasicControlView.h

– video360OptionSelected:

Shows or hides the screen mode button based on Video360 Mode

- (void)video360OptionSelected:(BOOL)isGogglesMode

Parameters

isGogglesMode

Boolean determining if device is in VR Goggles Mode

Discussion

Shows or hides the screen mode button based on Video360 Mode

Declared In

BCOVPUIBasicControlView.h

+ createPUIControlItemWithViewTag:

Constructs the UI control item with the specified tag. Returned object may be a BCOVPUIButton, BCOVPUISlider, UILabel, or MPVolumeView depending on the specified tag. This method is typically only used by layoutViewWithControlFromTag:width:elasticity: to create the control placed inside a BCOVPUILayoutView. Default styles will be applied.

+ (UIView *)createPUIControlItemWithViewTag:(BCOVPUIViewTag)tag

Parameters

tag

The tag to construct.

Return Value

Initialized UI component.

Discussion

Constructs the UI control item with the specified tag. Returned object may be a BCOVPUIButton, BCOVPUISlider, UILabel, or MPVolumeView depending on the specified tag. This method is typically only used by layoutViewWithControlFromTag:width:elasticity: to create the control placed inside a BCOVPUILayoutView. Default styles will be applied.

Declared In

BCOVPUIBasicControlView.h

– setButtonsAccessibilityDelegate:

Sets the accessibility delegate on control view buttons

- (void)setButtonsAccessibilityDelegate:(id<BCOVPUIButtonAccessibilityDelegate>)delegate

Parameters

delegate

The object which conforms to the BCOVPUIButtonAccessibilityDelegate protocol

Discussion

Sets the accessibility delegate on control view buttons

Declared In

BCOVPUIBasicControlView.h